Registry /
testing / remark-lint-checkbox-character-style
Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
default
✓ import remarkLintCheckboxCharacterStyle from 'remark-lint-checkbox-character-style'
✗ const remarkLintCheckboxCharacterStyle = require('remark-lint-checkbox-character-style')
ESM-only since v5; CJS require will fail or throw.
remarkLintCheckboxCharacterStyle
✓ import remarkLintCheckboxCharacterStyle from 'remark-lint-checkbox-character-style'
✗ import { remarkLintCheckboxCharacterStyle } from 'remark-lint-checkbox-character-style'
The package has no named exports; default import is required.
Options
✓ import type { Options } from 'remark-lint-checkbox-character-style'
✗ import { Options } from 'remark-lint-checkbox-character-style'
Only usable as TypeScript type; use with `import type`.
Shows unified integration with remark-lint-checkbox-character-style, enforcing checked='X' and unchecked space.
import { unified } from 'unified'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import remarkLint from 'remark-lint'
import remarkLintCheckboxCharacterStyle from 'remark-lint-checkbox-character-style'
const file = await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintCheckboxCharacterStyle, { checked: 'X', unchecked: ' ' }) // enforce 'X' and space
.use(remarkStringify)
.process('- [x] done\n- [ ] todo\n- [X] also done')
console.log(String(file))
// No warning because 'x' and 'X' are mixed; 'x' is invalid. Warnings emitted via vfile-reporter.
// To see warnings: import { reporter } from 'vfile-reporter' and console.error(reporter(file))
Errors
Common errors & fixes
Error [ERR_REQUIRE_ESM]: require() of ES Module
Using CommonJS require with an ESM-only package (v5+).
fixSwitch to ESM imports or use dynamic import().
SyntaxError: The requested module 'remark-lint-checkbox-character-style' does not provide an export named 'remarkLintCheckboxCharacterStyle'
Named import used but package only has a default export.
fixUse default import: import remarkLintCheckboxCharacterStyle from 'remark-lint-checkbox-character-style'
Audit
Dependencies
remark-lintrequiredRequired to use any rule; linting framework
unifiedrequiredCore processing pipeline; required by remark-lint