remark-lint-ordered-list-marker-value

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

The remark-lint-ordered-list-marker-value package is a plugin for remark-lint that enforces consistent marker values in ordered lists. It helps maintain a uniform style in Markdown documents by ensuring that ordered list markers follow a specified pattern.

What are remark-lint-ordered-list-marker-value's main functionalities?

Consistent Ordered List Marker Values

This feature ensures that ordered list markers are in a consistent order. For example, if the first item is '1.', the second item should be '2.', and so on. The 'ordered' option enforces this rule.

module.exports = {
  plugins: [
    ['remark-lint-ordered-list-marker-value', 'ordered']
  ]
};

Enforce Specific Marker Value

This feature enforces that all ordered list markers use the value '1.'. This can be useful for lists where the actual order is not important, but consistency is.

module.exports = {
  plugins: [
    ['remark-lint-ordered-list-marker-value', 'one']
  ]
};

Other packages similar to remark-lint-ordered-list-marker-value

remark-lint

remark-lint is a general-purpose Markdown linter that provides a wide range of rules for ensuring consistent and error-free Markdown documents. While remark-lint-ordered-list-marker-value focuses specifically on ordered list markers, remark-lint offers a broader set of rules for various aspects of Markdown formatting.

markdownlint

markdownlint is a Node.js style checker and lint tool for Markdown files. It provides a comprehensive set of rules for maintaining consistent Markdown style, including rules for ordered list markers. It is similar to remark-lint but is a standalone tool rather than a plugin.

markdown-it

markdown-it is a Markdown parser that can be extended with plugins to enforce various rules and styles. While it is primarily a parser, it can be used with plugins to achieve similar functionality to remark-lint-ordered-list-marker-value, such as enforcing consistent ordered list markers.

README

remark-lint-ordered-list-marker-value

Warn when the list item marker values of ordered lists violate a given style.

Options: 'single', 'one', or 'ordered', default: 'ordered'.

When set to 'ordered', list item bullets should increment by one, relative to the starting point. When set to 'single', bullets should be the same as the relative starting point. When set to 'one', bullets should always be 1.

Fix

remark-stringify retains the number of the first list item bullet, and by default increments the other items. Pass incrementListMarker: false to not increment further list items.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-markdown-style-guide	'one'

Example

ok.md

In

The default value is `ordered`, so unless changed, the below
is OK.

1.  Foo
2.  Bar
3.  Baz

Paragraph.

3.  Alpha
4.  Bravo
5.  Charlie

Unordered lists are not affected by this rule.

*   Anton

Out

No messages.

ok.md

When configured with 'one'.

In

1.  Foo
1.  Bar
1.  Baz

Paragraph.

1.  Alpha
1.  Bravo
1.  Charlie

Out

No messages.

not-ok.md

When configured with 'one'.

In

1.  Foo
2.  Bar

Out

2:1-2:8: Marker should be `1`, was `2`

also-not-ok.md

When configured with 'one'.

In

2.  Foo
1.  Bar

Out

1:1-1:8: Marker should be `1`, was `2`

ok.md

When configured with 'single'.

In

1.  Foo
1.  Bar
1.  Baz

Paragraph.

3.  Alpha
3.  Bravo
3.  Charlie

Paragraph.

0.  Delta
0.  Echo
0.  Foxtrot

Out

No messages.

ok.md

When configured with 'ordered'.

In

1.  Foo
2.  Bar
3.  Baz

Paragraph.

3.  Alpha
4.  Bravo
5.  Charlie

Paragraph.

0.  Delta
1.  Echo
2.  Foxtrot

Out

No messages.

not-ok.md

When configured with 'ordered'.

In

1.  Foo
1.  Bar

Out

2:1-2:8: Marker should be `2`, was `1`

not-ok.md

When configured with '💩'.

Out

1:1: Incorrect ordered list item marker value `💩`: use either `'ordered'` or `'one'`

Install

npm:

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

Use

You probably want to use it on the CLI through a config file:

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

Or use it on the CLI directly

remark -u lint -u lint-ordered-list-marker-value readme.md

Or use this on the API:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-ordered-list-marker-value'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file))
   })

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