remark-lint/packages/remark-lint-list-item-bullet-indent/readme.md

remark-lint-list-item-bullet-indent

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

valid.md

In

Paragraph.

* List item
* List item

Out

No messages.

invalid.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 install remark-lint-list-item-bullet-indent

Usage

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));
   });

License

MIT © Titus Wormer