remark-lint-checkbox-character-style
!Buildbadge-build-imagebadge-build-url
!Coveragebadge-coverage-imagebadge-coverage-url
!Downloadsbadge-downloads-imagebadge-downloads-url
!Sizebadge-size-imagebadge-size-url
!Sponsorsbadge-funding-sponsors-imagebadge-funding-url
!Backersbadge-funding-backers-imagebadge-funding-url
!Chatbadge-chat-imagebadge-chat-urlremark-lint
github-remark-lint rule to warn when list item checkboxes violate a given
style.Contents
unified().use(remarkLintCheckboxCharacterStyle[, options])
Options
Styles
What is this?
This package checks the character used in checkboxes.When should I use this?
You can use this package to check that the style of GFM tasklists is consistent. Task lists are a GFM feature enabled withremark-gfm
github-remark-gfm.Presets
This plugin is included in the following presets:| Preset | Options | | - | - | |
remark-preset-lint-consistent
| 'consistent'
|Install
This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint-checkbox-character-style
In Deno with
esm.sh
esm-sh:import remarkLintCheckboxCharacterStyle from 'https://esm.sh/remark-lint-checkbox-character-style@5'
In browsers with
esm.sh
esm-sh:<script type="module">
import remarkLintCheckboxCharacterStyle from 'https://esm.sh/remark-lint-checkbox-character-style@5?bundle'
</script>
Use
On the API:import remarkLint from 'remark-lint'
import remarkLintCheckboxCharacterStyle from 'remark-lint-checkbox-character-style'
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(remarkLintCheckboxCharacterStyle)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-checkbox-character-style .
On the CLI in a config file (here a
package.json
):…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-checkbox-character-style",
…
]
}
…
API
This package exports no identifiers. It exports the TypeScripttypescript typesOptions
api-options and
Styles
api-styles.
The default export is
remarkLintCheckboxCharacterStyle
api-remark-lint-checkbox-character-style.unified().use(remarkLintCheckboxCharacterStyle[, options])
Warn when list item checkboxes violate a given style.Parameters
options
(Options
api-options, default:'consistent'
)
Returns
Transform (Transformer
from unified
github-unified-transformer).Options
Configuration (TypeScript type).Type
type Options = Styles | 'consistent'
Styles
Styles (TypeScript type).Fields
checked
('X'
,'x'
, or'consistent'
, default:'consistent'
)
unchecked
('␉'
(a tab),'␠'
(a space), or'consistent'
, default:
'consistent'
)
— preferred style to use for unchecked checkboxesRecommendation
It’s recommended to setoptions.checked
to 'x'
(a lowercase X) as it
prevents an extra keyboard press and options.unchecked
to '␠'
(a space)
to make all checkboxes align.Fix
remark-stringify
github-remark-stringify formats checked checkboxes
using 'x'
(lowercase X) and unchecked checkboxes using '␠'
(a space).Examples
ok-x.md
When configured with { checked: 'x' }
.In
👉 Note: this example uses
GFM (remark-gfm
github-remark-gfm).
- [x] Mercury.
- [x] Venus.
Out
No messages.ok-x-upper.md
When configured with { checked: 'X' }
.In
👉 Note: this example uses
GFM (remark-gfm
github-remark-gfm).
- [X] Mercury.
- [X] Venus.
Out
No messages.ok-space.md
When configured with { unchecked: ' ' }
.In
👉 Note: this example uses
GFM (remark-gfm
github-remark-gfm).
- [ ] Mercury.
- [ ] Venus.
- [ ]␠␠
- [ ]
Out
No messages.ok-tab.md
When configured with { unchecked: '\t' }
.In
👉 Note: this example uses
GFM (remark-gfm
github-remark-gfm).
- [␉] Mercury.
- [␉] Venus.
Out
No messages.not-ok-default.md
In
👉 Note: this example uses
GFM (remark-gfm
github-remark-gfm).
- [x] Mercury.
- [X] Venus.
- [ ] Earth.
- [␉] Mars.
Out
2:5: Unexpected checked checkbox value `X`, expected `x`
4:5: Unexpected unchecked checkbox value `\t`, expected ` `
not-ok-option.md
When configured with '🌍'
.Out
1:1: Unexpected value `🌍` for `options`, expected an object or `'consistent'`
not-ok-option-unchecked.md
When configured with { unchecked: '🌍' }
.Out
1:1: Unexpected value `🌍` for `options.unchecked`, expected `'\t'`, `' '`, or `'consistent'`
not-ok-option-checked.md
When configured with { checked: '🌍' }
.Out
1:1: Unexpected value `🌍` for `options.checked`, expected `'X'`, `'x'`, or `'consistent'`
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-character-style@5
,
compatible with Node.js 16.Contribute
Seecontributing.md
github-dotfiles-contributing in remarkjs/.github
github-dotfiles-health for ways
to get started.
See support.md
github-dotfiles-support for ways to get help.This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.