remark-lint-ordered-list-marker-value
!Buildbadge-build-imagebadge-build-url
!Coveragebadge-coverage-imagebadge-coverage-url
!Downloadsbadge-downloads-imagebadge-downloads-url
!Sizebadge-size-imagebadge-size-url
!Sponsorsbadge-funding-sponsors-imagebadge-funding-url
!Backersbadge-funding-backers-imagebadge-funding-url
!Chatbadge-chat-imagebadge-chat-urlremark-lintgithub-remark-lint rule to warn when ordered list values are inconsistent.Contents
unified().use(remarkLintOrderedListMarkerValue[, options])
Options
StyleWhat is this?
This package checks ordered list values.When should I use this?
You can use this package to check ordered lists.Presets
This plugin is included in the following presets:| Preset | Options | | - | - | |
remark-preset-lint-consistent | 'consistent' |
| remark-preset-lint-markdown-style-guide | 'one' |Install
This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint-ordered-list-marker-valueIn Deno with
esm.shesm-sh:import remarkLintOrderedListMarkerValue from 'https://esm.sh/remark-lint-ordered-list-marker-value@4'In browsers with
esm.shesm-sh:<script type="module">
import remarkLintOrderedListMarkerValue from 'https://esm.sh/remark-lint-ordered-list-marker-value@4?bundle'
</script>Use
On the API:import remarkLint from 'remark-lint'
import remarkLintOrderedListMarkerValue from 'remark-lint-ordered-list-marker-value'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintOrderedListMarkerValue)
.use(remarkStringify)
.process(file)
console.error(reporter(file))On the CLI:
remark --frail --use remark-lint --use remark-lint-ordered-list-marker-value .On the CLI in a config file (here a
package.json):…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-ordered-list-marker-value",
…
]
}
…API
This package exports no identifiers. It exports the TypeScripttypescript typesOptionsapi-options and
Styleapi-style.
The default export is
remarkLintOrderedListMarkerValueapi-remark-lint-ordered-list-marker-value.unified().use(remarkLintOrderedListMarkerValue[, options])
Warn when ordered list values are inconsistent.Parameters
options(Optionsapi-options, default:'consistent')
Returns
Transform (Transformer from unifiedgithub-unified-transformer).Options
Configuration (TypeScript type).consistent looks at the first list with two or more items, and
infer 'single' if both are the same, and 'ordered' otherwise.Type
type Options = Style | 'consistent'Style
Counter style (TypeScript type).'one'
1'ordered'
'single'
Type
type Style = 'one' | 'ordered' | 'single'Recommendation
While'single' might be the smartest style,
as it makes it easier to move items around without having to renumber
everything and doesn’t have problems with aligning content of the 9th and
the 10th item,
it’s not used a lot and arguably looks unnatural.
'one' is like 'single' but forces every list to start at 1.
While not often needed,
starting lists at other values is sometimes useful.
So 'ordered' is recommended,
although 'single' is also a viable choice.Fix
remark-stringifygithub-remark-stringify retains the value of the first
item and increments further items by default.
Pass incrementListMarker: false to not increment further items.Examples
ok.md
In
1. Mercury
2. Venus
***
3. Earth
4. Mars
***
* JupiterOut
No messages.ok-infer-single.md
In
2. Mercury
2. Venus
***
3. Earth
3. MarsOut
No messages.nok-chaotic.md
In
2. Mercury
1. Venus
***
1. Earth
1. MarsOut
2:2: Unexpected ordered list item value `1`, expected `3`
7:2: Unexpected ordered list item value `1`, expected `2`ok.md
When configured with 'one'.In
1. Mercury
1. VenusOut
No messages.ok.md
When configured with 'ordered'.In
1. Mercury
2. Venus
***
3. Earth
4. Mars
***
0. Jupiter
1. SaturnOut
No messages.ok.md
When configured with 'single'.In
1. Mercury
1. Venus
***
3. Earth
3. Mars
***
0. Jupiter
0. SaturnOut
No messages.not-ok.md
When configured with 'one'.In
1. Mercury
2. Venus
***
3. Earth
***
2. Mars
1. JupiterOut
2:2: Unexpected ordered list item value `2`, expected `1`
6:2: Unexpected ordered list item value `3`, expected `1`
10:2: Unexpected ordered list item value `2`, expected `1`not-ok.md
When configured with 'ordered'.In
1. Mercury
1. Venus
***
2. Mars
1. JupiterOut
2:2: Unexpected ordered list item value `1`, expected `2`
7:2: Unexpected ordered list item value `1`, expected `3`not-ok.md
When configured with 'single'.In
1. Mercury
2. Venus
***
2. Mars
1. JupiterOut
2:2: Unexpected ordered list item value `2`, expected `1`
7:2: Unexpected ordered list item value `1`, expected `2`not-ok.md
When configured with '🌍'.Out
1:1: Unexpected value `🌍` for `options`, expected `'one'`, `'ordered'`, `'single'`, or `'consistent'`Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,
remark-lint-ordered-list-marker-value@4,
compatible with Node.js 16.Contribute
Seecontributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways
to get started.
See support.mdgithub-dotfiles-support for ways to get help.This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.
