unified

Project: remarkjs/remark-lint

Package: remark-lint-list-item-bullet-indent@2.0.1

  1. Dependencies: 5·Dependents: 17
  2. remark-lint rule to warn when list item bullets are indented
  1. remark 162
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. list 9
  6. indent 8
  7. item 4

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:

PresetSetting
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:3: Incorrect indentation before bullet: remove 1 space
4:3: Incorrect indentation before bullet: remove 1 space

Install

npm:

npm install remark-lint-list-item-bullet-indent

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:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-list-item-bullet-indent'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || 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