remark-lint-checkbox-content-indent

remark-lint-checkbox-content-indent

remark-lint rule to warn when GFM tasklist checkboxes are followed by more than one space.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintCheckboxContentIndent[, config])
• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

What is this?

This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.

When should I use this?

You can use this package to check that the “indent” after a GFM tasklist checkbox is a single space.

Presets

This rule is not included in a preset maintained here.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-lint-checkbox-content-indent

In Deno with esm.sh:

import remarkLintCheckboxContentIndent from 'https://esm.sh/remark-lint-checkbox-content-indent@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintCheckboxContentIndent from 'https://esm.sh/remark-lint-checkbox-content-indent@4?bundle'
</script>

Use

On the API:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintCheckboxContentIndent from 'remark-lint-checkbox-content-indent'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .use(remarkLintCheckboxContentIndent)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:

remark --use remark-lint --use remark-lint-checkbox-content-indent example.md

On the CLI in a config file (here a package.json):

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

API

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

unified().use(remarkLintCheckboxContentIndent[, config])

This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).

There are no accepted options.

Recommendation

GFM allows zero or more spaces and tabs after checkboxes. No space at all arguably looks rather ugly:

* [x]Pluto

More that one space is superfluous:

* [x]   Jupiter

Due to this, it’s recommended to turn this rule on.

Fix

remark-stringify formats checkboxes and the content after them with a single space between.

Examples

ok.md

In

👉 Note: this example uses GFM (remark-gfm).

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

Out

No messages.

not-ok.md

In

👉 Note: this example uses GFM (remark-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

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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