remark-lint-checkbox-content-indent

remark-lint-checkbox-content-indent

Warn when list item checkboxes are followed by too much whitespace.

Presets

This rule is not included in any default preset

Example

ok.md

In

Note: this example uses GFM.

- [ ] List item
+  [x] List Item
*   [X] List item
-    [ ] List item

Out

No messages.

not-ok.md

In

Note: this example uses GFM.

- [ ] List item
+ [x]  List item
* [X]   List item
- [ ]    List item

Out

2:7-2:8: Checkboxes should be followed by a single character
3:7-3:9: Checkboxes should be followed by a single character
4:7-4:10: Checkboxes should be followed by a single character

Install

npm:

npm install remark-lint-checkbox-content-indent

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-checkbox-content-indent",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-checkbox-content-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-checkbox-content-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