.. | ||
index.js | ||
package.json | ||
readme.md |
remark-lint-list-item-indent
Warn when the spacing between a list item’s bullet and its content violates a given style.
Options: 'tab-size'
, 'mixed'
, or 'space'
, default: 'tab-size'
.
Fix
remark-stringify
uses 'tab-size'
(named 'tab'
there) by default to ensure Markdown is
seen the same way across vendors.
This can be configured with the
listItemIndent
option.
This rule’s 'space'
option is named '1'
there.
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 |
'mixed' |
remark-preset-lint-recommended |
'tab-size' |
Example
ok.md
In
Note: ·
represents a space.
*···List
····item.
Paragraph.
11.·List
····item.
Paragraph.
*···List
····item.
*···List
····item.
Out
No messages.
ok.md
When configured with 'mixed'
.
In
Note: ·
represents a space.
*·List item.
Paragraph.
11.·List item
Paragraph.
*···List
····item.
*···List
····item.
Out
No messages.
not-ok.md
When configured with 'mixed'
.
In
Note: ·
represents a space.
*···List item.
Out
1:5: Incorrect list-item indent: remove 2 spaces
ok.md
When configured with 'space'
.
In
Note: ·
represents a space.
*·List item.
Paragraph.
11.·List item
Paragraph.
*·List
··item.
*·List
··item.
Out
No messages.
not-ok.md
When configured with 'space'
.
In
Note: ·
represents a space.
*···List
····item.
Out
1:5: Incorrect list-item indent: remove 2 spaces
not-ok.md
When configured with 'tab-size'
.
In
Note: ·
represents a space.
*·List
··item.
Out
1:3: Incorrect list-item indent: add 2 spaces
not-ok.md
When configured with '💩'
.
Out
1:1: Incorrect list-item indent style `💩`: use either `'tab-size'`, `'space'`, or `'mixed'`
Install
npm:
npm install remark-lint-list-item-indent
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-list-item-indent",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-list-item-indent 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-list-item-indent'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || 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.