4.9 KiB
remark-lint-unordered-list-marker-style
Warn when the list item marker style of unordered lists violate a given style.
Options: 'consistent', '-', '*', or '+', default: 'consistent'.
'consistent' detects the first used list style and warns when subsequent
lists use different styles.
Fix
remark-stringify
formats unordered lists using - (hyphen-minus) by default.
Pass
bullet: '*' or bullet: '+'
to use * (asterisk) or + (plus sign) instead.
See Using remark to fix your Markdown on how to automatically fix warnings for this rule.
Presets
This rule is included in the following presets:
| Preset | Setting |
|---|---|
remark-preset-lint-markdown-style-guide |
'-' |
Example
ok.md
In
By default (`'consistent'`), if the file uses only one marker,
that’s OK.
* Foo
* Bar
* Baz
Ordered lists are not affected.
1. Foo
2. Bar
3. Baz
Out
No messages.
not-ok.md
In
* Foo
- Bar
+ Baz
Out
2:1-2:6: Marker style should be `*`
3:1-3:6: Marker style should be `*`
ok.md
When configured with '*'.
In
* Foo
Out
No messages.
ok.md
When configured with '-'.
In
- Foo
Out
No messages.
ok.md
When configured with '+'.
In
+ Foo
Out
No messages.
not-ok.md
When configured with '💩'.
Out
1:1: Incorrect unordered list item marker style `💩`: use either `'-'`, `'*'`, or `'+'`
Install
This package is ESM only:
Node 12+ is needed to use it and it must be importeded instead of requiredd.
npm:
npm install remark-lint-unordered-list-marker-style
This package exports no identifiers.
The default export is remarkLintUnorderedListMarkerStyle.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-unordered-list-marker-style",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-unordered-list-marker-style readme.md
Or use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintUnorderedListMarkerStyle from 'remark-lint-unordered-list-marker-style'
remark()
.use(remarkLint)
+ .use(remarkLintUnorderedListMarkerStyle)
.process('_Emphasis_ and **importance**')
.then((file) => {
console.error(reporter(file))
})
Contribute
See contributing.md in remarkjs/.github for ways
to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.