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)
• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks the space after checkboxes.

When should I use this?

You can use this package to check that the style of GFM tasklists is a single space.

Presets

This plugin is not included in presets maintained here.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

1npm install remark-lint-checkbox-content-indent

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

On the API:

1import remarkLint from 'remark-lint'
2import remarkLintCheckboxContentIndent from 'remark-lint-checkbox-content-indent'
3import remarkParse from 'remark-parse'
4import remarkStringify from 'remark-stringify'
5import {read} from 'to-vfile'
6import {unified} from 'unified'
7import {reporter} from 'vfile-reporter'
8
9const file = await read('example.md')
10
11await unified()
12  .use(remarkParse)
13  .use(remarkLint)
14  .use(remarkLintCheckboxContentIndent)
15  .use(remarkStringify)
16  .process(file)
17
18console.error(reporter(file))

On the CLI:

1remark --frail --use remark-lint --use remark-lint-checkbox-content-indent .

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

1 …
2 "remarkConfig": {
3   "plugins": [
4     …
5     "remark-lint",
6+    "remark-lint-checkbox-content-indent",
7     …
8   ]
9 }
10 …

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintCheckboxContentIndent.

unified().use(remarkLintCheckboxContentIndent)

Warn when GFM tasklist checkboxes are followed by more than one space.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

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

1* [x]Pluto

More that one space is superfluous:

1* [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).

1- [ ] Mercury.
2+  [x] Venus.
3*   [X] Earth.
4-    [ ] Mars.

Out

No messages.

not-ok.md

In

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

1- [ ] Mercury.
2+ [x]  Venus.
3* [X]   Earth.
4- [ ]    Mars.

Out

12:8: Unexpected `2` spaces between checkbox and content, expected `1` space, remove `1` space
23:9: Unexpected `3` spaces between checkbox and content, expected `1` space, remove `2` spaces
34:10: Unexpected `4` spaces between checkbox and content, expected `1` space, remove `3` spaces

tab.md

In

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

1- [ ]␉Mercury.
2+ [x]␉␉Venus.

Out

12:8: Unexpected `2` spaces between checkbox and content, expected `1` space, remove `1` space

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-lint-checkbox-content-indent@5, compatible with Node.js 16.

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