remark-lint-ordered-list-marker-value

v4.0.0

remark-lint rule to warn when the marker value of ordered lists violates a 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

70 / 100

security
No known security issues
popularity
Recognized
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
4.0.0	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.1.2	\|	05/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.1	\|	07/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.5	\|	03/2020		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

Recognized

Weekly Downloads (98,014)

GitHub Stars: 907
Forks: 129
Contributors: 50

Direct Usage Popularity

The npm package remark-lint-ordered-list-marker-value receives a total of 98,014 downloads a week. As such, we scored remark-lint-ordered-list-marker-value popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package remark-lint-ordered-list-marker-value, we found that it has been starred 907 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: 50
Funding: Yes

With more than 10 contributors for the remark-lint-ordered-list-marker-value repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

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

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

We found that remark-lint-ordered-list-marker-value 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: 8 years
Dependencies: 8 Direct
Versions: 15
Install Size: 22.5 kB
Dist-tags: 1
# of Files: 5
Maintainers: 3
TS Typings: No

remark-lint-ordered-list-marker-value 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-ordered-list-marker-value

remark-lint rule to warn when ordered list values are inconsistent.

What is this?

This package checks ordered list values.

When should I use this?

You can use this package to check ordered lists.

Presets

This plugin is included in the following presets:

Preset	Options
`remark-preset-lint-consistent`	`'consistent'`
`remark-preset-lint-markdown-style-guide`	`'one'`

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-ordered-list-marker-value

In Deno with esm.sh:

import remarkLintOrderedListMarkerValue from 'https://esm.sh/remark-lint-ordered-list-marker-value@4'

In browsers with esm.sh:

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintOrderedListMarkerValue from 'remark-lint-ordered-list-marker-value'
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(remarkLintOrderedListMarkerValue)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-ordered-list-marker-value .

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-ordered-list-marker-value",
     …
   ]
 }
 …

API

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

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

Warn when ordered list values are inconsistent.

Parameters

options (Options, default: 'consistent') — preferred style

Returns

Transform (Transformer from unified).

`Options`

Configuration (TypeScript type).

consistent looks at the first list with two or more items, and infer 'single' if both are the same, and 'ordered' otherwise.

Type

type Options = Style | 'consistent'

`Style`

Counter style (TypeScript type).

'one' — values should always be exactly 1
'ordered' — values should increment by one from the first item
'single' — values should stay the same as the first item

Type

type Style = 'one' | 'ordered' | 'single'

Recommendation

While 'single' might be the smartest style, as it makes it easier to move items around without having to renumber everything and doesn’t have problems with aligning content of the 9th and the 10th item, it’s not used a lot and arguably looks unnatural. 'one' is like 'single' but forces every list to start at 1. While not often needed, starting lists at other values is sometimes useful. So 'ordered' is recommended, although 'single' is also a viable choice.

Fix

remark-stringify retains the value of the first item and increments further items by default. Pass incrementListMarker: false to not increment further items.

Examples

`ok.md`

In

1. Mercury
2. Venus

***

3. Earth
4. Mars

***

* Jupiter

Out

No messages.

`ok-infer-single.md`

In

2. Mercury
2. Venus

***

3. Earth
3. Mars

Out

No messages.

`nok-chaotic.md`

In

2. Mercury
1. Venus

***

1. Earth
1. Mars

Out

2:2: Unexpected ordered list item value `1`, expected `3`
7:2: Unexpected ordered list item value `1`, expected `2`

`ok.md`

When configured with 'one'.

In

1. Mercury
1. Venus

Out

No messages.

`ok.md`

When configured with 'ordered'.

In

1. Mercury
2. Venus

***

3. Earth
4. Mars

***

0. Jupiter
1. Saturn

Out

No messages.

`ok.md`

When configured with 'single'.

In

1. Mercury
1. Venus

***

3. Earth
3. Mars

***

0. Jupiter
0. Saturn

Out

No messages.

`not-ok.md`

When configured with 'one'.

In

1. Mercury
2. Venus

***

3. Earth

***

2. Mars
1. Jupiter

Out

2:2: Unexpected ordered list item value `2`, expected `1`
6:2: Unexpected ordered list item value `3`, expected `1`
10:2: Unexpected ordered list item value `2`, expected `1`

`not-ok.md`

When configured with 'ordered'.

In

1. Mercury
1. Venus

***

2. Mars
1. Jupiter

Out

2:2: Unexpected ordered list item value `1`, expected `2`
7:2: Unexpected ordered list item value `1`, expected `3`

`not-ok.md`

When configured with 'single'.

In

1. Mercury
2. Venus

***

2. Mars
1. Jupiter

Out

2:2: Unexpected ordered list item value `2`, expected `1`
7:2: Unexpected ordered list item value `1`, expected `2`

`not-ok.md`

When configured with '🌍'.

Out

1:1: Unexpected value `🌍` for `options`, expected `'one'`, `'ordered'`, `'single'`, 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-ordered-list-marker-value@4, 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-ordered-list-marker-value dependencies

@types/mdast devlop mdast-util-phrasing micromark-util-character unified-lint-rule unist-util-position unist-util-visit-parents vfile-message

FAQs

What is remark-lint-ordered-list-marker-value?

remark-lint rule to warn when the marker value of ordered lists violates a given style. Visit Snyk Advisor to see a full health score report for remark-lint-ordered-list-marker-value, including popularity, security, maintenance & community analysis.

Is remark-lint-ordered-list-marker-value popular?

The npm package remark-lint-ordered-list-marker-value receives a total of 98,014 weekly downloads. As such, remark-lint-ordered-list-marker-value popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is remark-lint-ordered-list-marker-value well maintained?

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

Is remark-lint-ordered-list-marker-value safe to use?

The npm package remark-lint-ordered-list-marker-value 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 14 November-2024, at 08:25 (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 (98,014)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

remark-lint-ordered-list-marker-value

Contents

What is this?

When should I use this?

Presets

Install

Use

API

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

Parameters

Returns

Options

Type

Style

Type

Recommendation

Fix

Examples

ok.md

In

Out

ok-infer-single.md

In

Out

nok-chaotic.md

In

Out

ok.md

In

Out

ok.md

In

Out

ok.md

In

Out

not-ok.md

In

Out

not-ok.md

In

Out

not-ok.md

In

Out

not-ok.md

Out

Compatibility

Contribute

License

remark-lint-ordered-list-marker-value dependencies

FAQs

What is remark-lint-ordered-list-marker-value?

Is remark-lint-ordered-list-marker-value popular?

Is remark-lint-ordered-list-marker-value well maintained?

Is remark-lint-ordered-list-marker-value 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(remarkLintOrderedListMarkerValue[, options])`

`Options`

`Style`

`ok.md`

`ok-infer-single.md`

`nok-chaotic.md`

`ok.md`

`ok.md`

`ok.md`

`not-ok.md`

`not-ok.md`

`not-ok.md`

`not-ok.md`