unified

Project: remarkjs/remark-lint

Package: remark-lint-checkbox-content-indent@2.0.1

  1. Dependencies: 5·Dependents: 18
  2. remark-lint rule to warn when list item checkboxes are followed by too much whitespace
  1. remark 169
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. content 16
  6. list 9
  7. checkbox 2
  8. task 2

remark-lint-checkbox-content-indent

Build Coverage Downloads Size Sponsors Backers Chat

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
- [ ] List item
+  [x] List Item
*   [X] List item
-    [ ] List item
Out

No messages.

not-ok.md
In
- [ ] 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