remark-lint-strikethrough-marker

remark-lint-strikethrough-marker

remark-lint rule to warn when the number of GFM strikethrough markers are inconsistent.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintStrikethroughMarker[, options])
  • Marker
  • Options
• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks the number of strikethrough markers. Strikethrough is a GFM feature enabled with remark-gfm.

When should I use this?

You can use this package to check that GFM strikethrough is consistent.

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-strikethrough-marker

In 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>

Use

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",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports the TypeScript types Marker and Options. The default export is remarkLintStrikethroughMarker.

unified().use(remarkLintStrikethroughMarker[, options])

Warn when the number of GFM strikethrough markers are inconsistent.

Parameters

• options (Options, default: 'consistent') — preferred style or whether to detect the first style and warn for further differences

Returns

Transform (Transformer from unified).

Marker

Marker (TypeScript type).

Type

type Marker = '~~' | '~'

Options

Configuration (TypeScript type).

Type

type Options = Marker | 'consistent'

Recommendation

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.

Fix

remark-stringify with remark-gfm formats all strikethrough with two tildes.

Examples

not-ok.md

In

👉 Note: this example uses GFM (remark-gfm).

~Mercury~Venus and ~~Earth~~Mars.

Out

1:20-1:29: Unexpected double tilde strikethrough sequences (`~~`), expected single tilde (`~`)

ok.md

When configured with '~'.

In

👉 Note: this example uses GFM (remark-gfm).

~Mercury~Venus.

Out

No messages.

not-ok.md

When configured with '~'.

In

👉 Note: this example uses GFM (remark-gfm).

~~Mercury~~Venus.

Out

1:1-1:12: Unexpected double tilde strikethrough sequences (`~~`), expected single tilde (`~`)

ok.md

When configured with '~~'.

In

👉 Note: this example uses GFM (remark-gfm).

~~Mercury~~Venus.

Out

No messages.

not-ok.md

When configured with '~~'.

In

👉 Note: this example uses GFM (remark-gfm).

~Mercury~Venus.

Out

1:1-1:10: Unexpected single tilde strikethrough sequences (`~`), expected double tilde (`~~`)

not-ok.md

When configured with '🌍'.

Out

1:1: Unexpected value `🌍` for `options`, expected `'~~'`, `'~'`, 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-strikethrough-marker@3, 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