mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 19:58:38 +03:00
| .. | ||
| index.js | ||
| package.json | ||
| readme.md | ||
remark-lint-ordered-list-marker-style
Warn when the list-item marker style of ordered 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.
Note: ) is only supported in CommonMark.
Presets
This rule is included in the following presets:
| Preset | Setting |
|---|---|
remark-preset-lint-consistent |
'consistent' |
remark-preset-lint-markdown-style-guide |
'.' |
remark-preset-lint-recommended |
'.' |
Example
valid.md
In
1. Foo
1. Bar
Unordered lists are not affected by this rule.
* Foo
Out
No messages.
invalid.md
In
1. Foo
2) Bar
Out
3:1-3:8: Marker style should be `.`
valid.md
When configured with '.'.
In
1. Foo
2. Bar
Out
No messages.
valid.md
When configured with ')'.
In
<!-- This requires commonmark. -->
1) Foo
2) Bar
Out
No messages.
invalid.md
When configured with '!'.
Out
1:1: Invalid ordered list-item marker style `!`: use either `'.'` or `')'`
Install
npm install remark-lint-ordered-list-marker-style
Usage
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
"plugins": [
...
"lint",
+ "lint-ordered-list-marker-style",
...
]
}
...
Or use it on the CLI directly
remark -u lint -u lint-ordered-list-marker-style readme.md
Or use this on the API:
var remark = require('remark');
var report = require('vfile-reporter');
remark()
.use(require('remark-lint'))
+ .use(require('remark-lint-ordered-list-marker-style'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});