remark-lint-strikethrough-marker

v3.0.0

remark-lint rule to warn when strikethrough markers violate the given style For more information about how to use this package see README

Latest version published 7 months ago

License: MIT

NPM

GitHub

Package Health Score

65 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.0.0	\|	04/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.2	\|	05/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	06/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (2,249)

GitHub Stars: 904
Forks: 129
Contributors: -

Direct Usage Popularity

The npm package remark-lint-strikethrough-marker receives a total of 2,249 downloads a week. As such, we scored remark-lint-strikethrough-marker popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package remark-lint-strikethrough-marker, we found that it has been starred 904 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 0
Funding: Yes

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 10
Open PR: 5
Last Release: 7 months ago
Last Commit: 9 months ago

Further analysis of the maintenance status of remark-lint-strikethrough-marker based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that remark-lint-strikethrough-marker demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 5 Direct
Versions: 8
Install Size: 16.3 kB
Dist-tags: 1
# of Files: 5
Maintainers: 3
TS Typings: No

remark-lint-strikethrough-marker has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

remark-lint-strikethrough-marker

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

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:

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

remark-lint-strikethrough-marker dependencies

@types/mdast unified-lint-rule unist-util-position unist-util-visit-parents vfile-message

FAQs

What is remark-lint-strikethrough-marker?

remark-lint rule to warn when strikethrough markers violate the given style. Visit Snyk Advisor to see a full health score report for remark-lint-strikethrough-marker, including popularity, security, maintenance & community analysis.

Is remark-lint-strikethrough-marker popular?

The npm package remark-lint-strikethrough-marker receives a total of 2,249 weekly downloads. As such, remark-lint-strikethrough-marker popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is remark-lint-strikethrough-marker well maintained?

We found indications that remark-lint-strikethrough-marker maintenance is sustainable demonstrating some project activity. We saw a total of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is remark-lint-strikethrough-marker safe to use?

The npm package remark-lint-strikethrough-marker was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 29 October-2024, at 19:05 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (2,249)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

remark-lint-strikethrough-marker

Contents

What is this?

When should I use this?

Presets

Install

Use

API

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

Parameters

Returns

Marker

Type

Options

Type

Recommendation

Fix

Examples

not-ok.md

In

Out

ok.md

In

Out

not-ok.md

In

Out

ok.md

In

Out

not-ok.md

In

Out

not-ok.md

Out

Compatibility

Contribute

License

remark-lint-strikethrough-marker dependencies

FAQs

What is remark-lint-strikethrough-marker?

Is remark-lint-strikethrough-marker popular?

Is remark-lint-strikethrough-marker well maintained?

Is remark-lint-strikethrough-marker safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

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

`Marker`

`Options`

`not-ok.md`

`ok.md`

`not-ok.md`

`ok.md`

`not-ok.md`

`not-ok.md`