remark-lint rule to warn when the indent of list item content is not consistent.
Contents
What is this?
This package checks the indent of list item content. It checks the first thing in a list item and makes sure that all other children have the same indent.
When should I use this?
You can use this package to check that list item content is indented consistent.
Presets
This plugin is included in the following presets:
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-list-item-content-indent
In Deno with esm.sh:
import remarkLintListItemContentIndent from 'https://esm.sh/remark-lint-list-item-content-indent@4'
In browsers with esm.sh:
<script type="module">
import remarkLintListItemContentIndent from 'https://esm.sh/remark-lint-list-item-content-indent@4?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintListItemContentIndent from 'remark-lint-list-item-content-indent'
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(remarkLintListItemContentIndent)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-list-item-content-indent .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-list-item-content-indent",
…
]
}
…
API
This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintListItemContentIndent.
Warn when the indent of list item content is not consistent.
Parameters
There are no options.
Returns
Transform (Transformer from unified).
Recommendation
The position of the first child in a list item matters. Further children should align with it.
Fix
remark-stringify aligns the content of items.
Examples
ok.md
In
1.␠Mercury.
␠␠␠***
␠␠␠* Venus.
Out
No messages.
not-ok.md
In
1.␠Mercury.
␠␠␠␠␠***
␠␠␠␠* Venus.
Out
2:6: Unexpected unaligned list item child, expected to align with first child, remove `2` spaces
3:5: Unexpected unaligned list item child, expected to align with first child, remove `1` space
ok-more.md
In
*␠␠␠Mercury.
␠␠␠␠***
Out
No messages.
not-ok-more.md
In
*␠␠␠Mercury.
␠␠␠␠␠␠***
Out
2:7: Unexpected unaligned list item child, expected to align with first child, remove `2` spaces
gfm-nok.md
In
👉 Note: this example uses GFM (remark-gfm).
1.␠[x] Mercury
␠␠␠␠␠***
␠␠␠␠* Venus
Out
2:6: Unexpected unaligned list item child, expected to align with first child, remove `2` spaces
3:5: Unexpected unaligned list item child, expected to align with first child, remove `1` space
initial-blank.md
In
*
␠␠␠␠␠asd
␠␠***
Out
4:3: Unexpected unaligned list item child, expected to align with first child, add `3` spaces
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-list-item-content-indent@4, compatible with Node.js 16.
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.
License
MIT © Titus Wormer