unified

Project: remarkjs/remark-lint

Package: remark-lint-strikethrough-marker@2.1.1

  1. Dependents: 0
  2. remark-lint rule to warn when strikethrough markers violate the given style
  1. remark 193
  2. lint 76
  3. rule 72
  4. remark-lint-rule 65
  5. marker 13
  6. strikethrough 6

remark-lint-strikethrough-marker

Build Coverage Downloads Size Sponsors Backers Chat

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

Contents

What is this?

This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.

When should I use this?

You can use this package to check that the number of strikethrough markers is consistent. Strikethrough is a GFM feature enabled with remark-gfm.

Presets

This rule is not included in a preset maintained here.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-lint-strikethrough-marker

In Deno with esm.sh:

import remarkLintStrikethroughMarker from 'https://esm.sh/remark-lint-strikethrough-marker@2'

In browsers with esm.sh:

<script type="module">
  import remarkLintStrikethroughMarker from 'https://esm.sh/remark-lint-strikethrough-marker@2?bundle'
</script>

Use

On the API:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintStrikethroughMarker from 'remark-lint-strikethrough-marker'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .use(remarkLintStrikethroughMarker)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:

remark --use remark-lint --use remark-lint-strikethrough-marker example.md

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. The default export is remarkLintStrikethroughMarker.

unified().use(remarkLintStrikethroughMarker[, 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:

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-gfm formats all strikethrough with two tildes.

Examples

ok.md

When configured with '~'.

In

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

~foo~
Out

No messages.

not-ok.md

When configured with '~'.

In

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

~~foo~~
Out
1:1-1:8: Strikethrough should use `~` as a marker
ok.md

When configured with '~~'.

In

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

~~foo~~
Out

No messages.

not-ok.md

When configured with '~~'.

In

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

~foo~
Out
1:1-1:6: Strikethrough should use `~~` as a marker
not-ok.md
In

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

~~foo~~
~bar~
Out
2:1-2:6: Strikethrough should use `~~` as a marker
not-ok.md

When configured with '💩'.

Out
1:1: Incorrect strikethrough marker `💩`: use either `'consistent'`, `'~'`, or `'~~'`

Compatibility

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.

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