remark-lint rule to warn when the number of GFM strikethrough markers are
inconsistent.
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Fix
- Examples
- Compatibility
- Contribute
- License
This package checks the number of strikethrough markers.
Strikethrough is a GFM feature enabled with
remark-gfm.
You can use this package to check that GFM strikethrough is consistent.
This plugin is not included in presets maintained here.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-strikethrough-markerIn Deno with esm.sh:
import remarkLintStrikethroughMarker from 'https://esm.sh/remark-lint-strikethrough-marker@3'In browsers with esm.sh:
<script type="module">
import remarkLintStrikethroughMarker from 'https://esm.sh/remark-lint-strikethrough-marker@3?bundle'
</script>On the API:
import remarkLint from 'remark-lint'
import remarkLintStrikethroughMarker from 'remark-lint-strikethrough-marker'
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(remarkLintStrikethroughMarker)
.use(remarkStringify)
.process(file)
console.error(reporter(file))On the CLI:
remark --frail --use remark-lint --use remark-lint-strikethrough-marker .On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-strikethrough-marker",
…
]
}
…This package exports no identifiers.
It exports the TypeScript types
Marker and
Options.
The default export is
remarkLintStrikethroughMarker.
Warn when the number of GFM strikethrough markers are inconsistent.
-
options(Options, default:'consistent') — preferred style or whether to detect the first style and warn for further differences
Transform (Transformer from unified).
Marker (TypeScript type).
type Marker = '~~' | '~'Configuration (TypeScript type).
type Options = Marker | 'consistent'GitHub flavored markdown (GFM) specifies that two tildes should be used,
but github.com allows one tilde everywhere.
It’s recommended to use two tildes.
remark-stringify with
remark-gfm formats all strikethrough with two tildes.
👉 Note: this example uses GFM (
remark-gfm).
~Mercury~Venus and ~~Earth~~Mars.1:20-1:29: Unexpected double tilde strikethrough sequences (`~~`), expected single tilde (`~`)
When configured with '~'.
👉 Note: this example uses GFM (
remark-gfm).
~Mercury~Venus.No messages.
When configured with '~'.
👉 Note: this example uses GFM (
remark-gfm).
~~Mercury~~Venus.1:1-1:12: Unexpected double tilde strikethrough sequences (`~~`), expected single tilde (`~`)
When configured with '~~'.
👉 Note: this example uses GFM (
remark-gfm).
~~Mercury~~Venus.No messages.
When configured with '~~'.
👉 Note: this example uses GFM (
remark-gfm).
~Mercury~Venus.1:1-1:10: Unexpected single tilde strikethrough sequences (`~`), expected double tilde (`~~`)
When configured with '🌍'.
1:1: Unexpected value `🌍` for `options`, expected `'~~'`, `'~'`, or `'consistent'`
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-strikethrough-marker@3,
compatible with Node.js 16.
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.