remark-lint-ordered-list-marker-style

remark-lint-ordered-list-marker-style

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

Contents

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

What is this?

This package checks ordered list markers.

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	'.'
remark-preset-lint-recommended	'.'

Install

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

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

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

On the API:

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

console.error(reporter(file))

On the CLI:

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

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

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

API

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

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

Warn when ordered list 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).

Options

Configuration (TypeScript type).

Type

type Options = Style | 'consistent'

Style

Style (TypeScript type).

Type

type Style = '.' | ')'

Recommendation

Parens for list markers were not supported in markdown before CommonMark. While they should work in most places now, not all markdown parsers follow CommonMark. So it’s recommended to prefer dots.

Fix

remark-stringify formats ordered lists with dots by default. Pass bulletOrdered: ')' to always use parens.

Examples

ok.md

In

1. Mercury

* Venus

1. Earth

Out

No messages.

ok.md

When configured with '.'.

In

1. Mercury

Out

No messages.

ok.md

When configured with ')'.

In

1) Mercury

Out

No messages.

not-ok.md

In

1. Mercury

1) Venus

Out

3:2: Unexpected ordered list marker `)`, expected `.`

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-ordered-list-marker-style@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

MIT © Titus Wormer