unified

Project: remarkjs/remark-lint

Package: remark-lint-list-item-indent@3.1.0

  1. Dependents: 22
  2. remark-lint rule to warn when the spacing between a list item’s bullet and its content violates a given style
  1. remark 196
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. list 11
  6. indent 8
  7. item 6

remark-lint-list-item-indent

Build Coverage Downloads Size Sponsors Backers Chat

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:

PresetSetting
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

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-list-item-indent

This package exports no identifiers. The default export is remarkLintListItemIndent.

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:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintListItemIndent from 'remark-lint-list-item-indent'

 remark()
   .use(remarkLint)
+  .use(remarkLintListItemIndent)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(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.

License

MIT © Titus Wormer