remark-lint-list-item-bullet-indent

remark-lint rule to warn when list item bullets are indented

Usage no npm install needed!

<script type="module">
  import remarkLintListItemBulletIndent from 'https://cdn.skypack.dev/remark-lint-list-item-bullet-indent';
</script>

README

remark-lint-list-item-bullet-indent

Build Coverage Downloads Size Sponsors Backers Chat

Warn when list item bullets are indented.

Fix

remark-stringify removes all indentation before bullets.

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-recommended | |

Example

ok.md
In
Paragraph.

* List item
* List item
Out

No messages.

not-ok.md
In

Note: · represents a space.

Paragraph.

·* List item
·* List item
Out
3:2: Incorrect indentation before bullet: remove 1 space
4:2: Incorrect indentation before bullet: remove 1 space

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-bullet-indent

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

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-list-item-bullet-indent",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-list-item-bullet-indent readme.md

Or use this on the API:

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

 remark()
   .use(remarkLint)
+  .use(remarkLintListItemBulletIndent)
   .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