remark-lint/packages/remark-lint-ordered-list-marker-value

remark-lint-ordered-list-marker-value

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

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintOrderedListMarkerValue[, options])
  • Options
• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

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-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@3'

In browsers with esm.sh:

<script type="module">
  import remarkLintOrderedListMarkerValue from 'https://esm.sh/remark-lint-ordered-list-marker-value@3?bundle'
</script>

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 type Options. The default export is remarkLintOrderedListMarkerValue.

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

Warn when ordered list values are inconsistent.

Parameters

• options (Options, default: 'ordered') — preferred style

Returns

Transform (Transformer from unified).

Options

Configuration (TypeScript type).

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

Type

type Options = '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

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.

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 '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`

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'`, `'one'`, or `'single'`

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@3, compatible with Node.js 12.

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