remark-lint rule to warn when GFM tasklist checkboxes are followed by more than one space.
Contents
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:
npm install remark-lint-checkbox-content-indent
In Deno with esm.sh:
import remarkLintCheckboxContentIndent from 'https://esm.sh/remark-lint-checkbox-content-indent@5'
In browsers with esm.sh:
<script type="module">
import remarkLintCheckboxContentIndent from 'https://esm.sh/remark-lint-checkbox-content-indent@5?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintCheckboxContentIndent from 'remark-lint-checkbox-content-indent'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintCheckboxContentIndent)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-checkbox-content-indent .
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. It exports no additional TypeScript types. The default export is 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:
* [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).
- [ ] Mercury.
+ [x] Venus.
* [X] Earth.
- [ ] Mars.
Out
No messages.
not-ok.md
In
👉 Note: this example uses GFM (remark-gfm).
- [ ] Mercury.
+ [x] Venus.
* [X] Earth.
- [ ] Mars.
Out
2:8: Unexpected `2` spaces between checkbox and content, expected `1` space, remove `1` space
3:9: Unexpected `3` spaces between checkbox and content, expected `1` space, remove `2` spaces
4:10: Unexpected `4` spaces between checkbox and content, expected `1` space, remove `3` spaces
tab.md
In
👉 Note: this example uses GFM (remark-gfm).
- [ ]␉Mercury.
+ [x]␉␉Venus.
Out
2: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