remark-lint-strikethrough-marker

remark-lint rule to warn when strikethrough markers violate the given style

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-lint-strikethrough-marker
850162.1.1a year ago2 years agoMinified + gzip package size for remark-lint-strikethrough-marker in KB

Readme

remark-lint-strikethrough-marker
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
remark-lintmono rule to warn when the number of strikethrough markers is inconsistent.

Contents

*   [`unified().use(remarkLintStrikethroughMarker[, config])`](#unifieduseremarklintstrikethroughmarker-config)

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 onlyesm. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-lint-strikethrough-marker

In Deno with Skypack:
import remarkLintStrikethroughMarker from 'https://cdn.skypack.dev/remark-lint-strikethrough-marker@2?dts'

In browsers with Skypack:
<script type="module">
  import remarkLintStrikethroughMarker from 'https://cdn.skypack.dev/remark-lint-strikethrough-marker@2?min'
</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:
  • '~'
— prefer one strikethrough marker
  • '~~'
— prefer two strikethrough markers
  • 'consistent'
— detect the first used style and warn when further strikethrough differs

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-gfmgfm).

~foo~
Out
No messages.
not-ok.md
When configured with '~'.
In
👉 Note: this example uses GFM (remark-gfmgfm).

~~foo~~
Out
1:1-1:8: Strikethrough should use `~` as a marker
ok.md
When configured with '~~'.
In
👉 Note: this example uses GFM (remark-gfmgfm).

~~foo~~
Out
No messages.
not-ok.md
When configured with '~~'.
In
👉 Note: this example uses GFM (remark-gfmgfm).

~foo~
Out
1:1-1:6: Strikethrough should use `~~` as a marker
not-ok.md
In
👉 Note: this example uses GFM (remark-gfmgfm).

~~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.mdcontributing in remarkjs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor