remark-lint rule to warn when lists violate a given style.
Contents
What is this?
This package checks blank lines between list items.
When should I use this?
You can use this package to check the style of lists.
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-spacing
In Deno with esm.sh:
import remarkLintListItemSpacing from 'https://esm.sh/remark-lint-list-item-spacing@5'
In browsers with esm.sh:
<script type="module">
import remarkLintListItemSpacing from 'https://esm.sh/remark-lint-list-item-spacing@5?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintListItemSpacing from 'remark-lint-list-item-spacing'
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(remarkLintListItemSpacing)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-list-item-spacing .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-list-item-spacing",
…
]
}
…
API
This package exports no identifiers. It exports the TypeScript type Options. The default export is remarkLintListItemSpacing.
Warn when lists violate a given style.
Parameters
options (Options, optional) — configuration
Returns
Transform (Transformer from unified).
Options
Configuration (TypeScript type).
Fields
checkBlanks (boolean, default: false) — expect blank lines between items based on whether an item has blank lines in them; the default is to expect blank lines based on whether items span multiple lines
Recommendation
First some background. Regardless of ordered and unordered, there are two kinds of lists in markdown, tight and loose. Lists are tight by default but if there is a blank line between two list items or between two blocks inside an item, that turns the whole list into a loose list. When turning markdown into HTML, paragraphs in tight lists are not wrapped in <p> tags.
This rule defaults to the markdown-style-guide preference for which lists should be loose or not: loose when at least one item spans more than one line and tight otherwise. With {checkBlanks: true}, this rule follows whether a list is loose or not according to Commonmark, and when one item is loose, all items must be loose.
Examples
ok.md
In
* Mercury.
* Venus.
+ Mercury and
Venus.
+ Earth.
Out
No messages.
ok-check-blanks.md
When configured with { checkBlanks: true }.
In
* Mercury.
* Venus.
+ Mercury
Mercury is the first planet from the Sun and the smallest in the Solar
System.
+ Earth.
Out
No messages.
not-ok.md
In
* Mercury.
* Venus.
+ Mercury and
Venus.
+ Earth.
* Mercury.
Mercury is the first planet from the Sun and the smallest in the Solar
System.
* Earth.
Out
1:11-3:1: Unexpected `1` blank line between list items, expected `0` blank lines, remove `1` blank line
6:11-7:1: Unexpected `0` blank lines between list items, expected `1` blank line, add `1` blank line
12:12-13:1: Unexpected `0` blank lines between list items, expected `1` blank line, add `1` blank line
not-ok-blank.md
When configured with { checkBlanks: true }.
In
* Mercury.
* Venus.
+ Mercury and
Venus.
+ Earth.
* Mercury.
Mercury is the first planet from the Sun and the smallest in the Solar
System.
* Earth.
Out
1:11-3:1: Unexpected `1` blank line between list items, expected `0` blank lines, remove `1` blank line
6:11-8:1: Unexpected `1` blank line between list items, expected `0` blank lines, remove `1` blank line
13:12-14:1: Unexpected `0` blank lines between list items, expected `1` blank line, add `1` blank line
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-spacing@5, 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