Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
remark-lint-checkbox-character-style
Advanced tools
remark-lint rule to warn when list item checkboxes violate a given style
Weekly downloads
Readme
remark-lint
rule to warn when list item checkboxes violate a given
style.
This package is a unified (remark) plugin, specifically a remark-lint
rule.
Lint rules check markdown code style.
You can use this package to check that the style of GFM tasklists is consistent.
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-consistent | 'consistent' |
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-lint-checkbox-character-style
In Deno with esm.sh
:
import remarkLintCheckboxCharacterStyle from 'https://esm.sh/remark-lint-checkbox-character-style@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintCheckboxCharacterStyle from 'https://esm.sh/remark-lint-checkbox-character-style@4?bundle'
</script>
On the API:
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintCheckboxCharacterStyle from 'remark-lint-checkbox-character-style'
main()
async function main() {
const file = await remark()
.use(remarkLint)
.use(remarkLintCheckboxCharacterStyle)
.process(await read('example.md'))
console.error(reporter(file))
}
On the CLI:
remark --use remark-lint --use remark-lint-checkbox-character-style example.md
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-checkbox-character-style",
…
]
}
…
This package exports no identifiers.
The default export is remarkLintCheckboxCharacterStyle
.
unified().use(remarkLintCheckboxCharacterStyle[, 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).
The following options (default: 'consistent'
) are accepted:
Object
with the following fields:
checked
('x'
, 'X'
, or 'consistent'
, default: 'consistent'
)
— preferred character to use for checked checkboxesunchecked
('·'
(a space), '»'
(a tab), or 'consistent'
,
default: 'consistent'
)
— preferred character to use for unchecked checkboxes'consistent'
— detect the first used styles and warn when further checkboxes differIt’s recommended to set options.checked
to 'x'
(a lowercase X) as it
prevents an extra keyboard press and options.unchecked
to '·'
(a space)
to make all checkboxes align.
remark-stringify
formats checked checkboxes using 'x'
(lowercase X) and unchecked checkboxes
using '·'
(a space).
ok.md
When configured with { checked: 'x' }
.
👉 Note: this example uses GFM (
remark-gfm
).
- [x] List item
- [x] List item
No messages.
ok.md
When configured with { checked: 'X' }
.
👉 Note: this example uses GFM (
remark-gfm
).
- [X] List item
- [X] List item
No messages.
ok.md
When configured with { unchecked: ' ' }
.
👉 Note: this example uses GFM (
remark-gfm
).
👉 Note:
·
represents a space.
- [ ] List item
- [ ] List item
- [ ]··
- [ ]
No messages.
ok.md
When configured with { unchecked: '\t' }
.
👉 Note: this example uses GFM (
remark-gfm
).
👉 Note:
»
represents a tab.
- [»] List item
- [»] List item
No messages.
not-ok.md
👉 Note: this example uses GFM (
remark-gfm
).
👉 Note:
»
represents a tab.
- [x] List item
- [X] List item
- [ ] List item
- [»] List item
2:5: Checked checkboxes should use `x` as a marker
4:5: Unchecked checkboxes should use ` ` as a marker
not-ok.md
When configured with { unchecked: '💩' }
.
1:1: Incorrect unchecked checkbox marker `💩`: use either `'\t'`, or `' '`
not-ok.md
When configured with { checked: '💩' }
.
1:1: Incorrect checked checkbox marker `💩`: use either `'x'`, or `'X'`
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.
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.
FAQs
remark-lint rule to warn when list item checkboxes violate a given style
The npm package remark-lint-checkbox-character-style receives a total of 55,747 weekly downloads. As such, remark-lint-checkbox-character-style popularity was classified as popular.
We found that remark-lint-checkbox-character-style demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.