.. | ||
.npmrc | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-list-item-spacing
remark-lint
rule to warn when lists violate a given style.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Examples
- Compatibility
- Contribute
- License
What is this?
This package checks the style of lists.
When should I use this?
You can use this package to check that lists are loose or tight when they should be is.
Presets
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
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@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintListItemSpacing from 'https://esm.sh/remark-lint-list-item-spacing@4?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
.
unified().use(remarkLintListItemSpacing[, options])
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
) — whether to follow CommonMark looseness instead ofmarkdown-style-guide
preference
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
A tight list:
- item 1
- item 2
- item 3
A loose list:
- Wrapped
item
- item 2
- item 3
Out
No messages.
not-ok.md
In
A tight list:
- Wrapped
item
- item 2
- item 3
A loose list:
- item 1
- item 2
- item 3
Out
4:9-5:1: Missing new line after list item
5:11-6:1: Missing new line after list item
10:11-12:1: Extraneous new line after list item
12:11-14:1: Extraneous new line after list item
ok.md
When configured with { checkBlanks: true }
.
In
A tight list:
- item 1
- item 1.A
- item 2
> Block quote
A loose list:
- item 1
- item 1.A
- item 2
> Block quote
Out
No messages.
not-ok.md
When configured with { checkBlanks: true }
.
In
A tight list:
- item 1
- item 1.A
- item 2
> Block quote
- item 3
A loose list:
- item 1
- item 1.A
- item 2
> Block quote
Out
5:15-6:1: Missing new line after list item
8:18-9:1: Missing new line after list item
14:15-16:1: Extraneous new line after list item
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@4
,
compatible with Node.js 12.
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.