unified

Project: remarkjs/remark-lint

Package: remark-lint-ordered-list-marker-style@3.1.1

  1. Dependents: 0
  2. remark-lint rule to warn when the markers of ordered lists violate a given style
  1. remark 214
  2. lint 80
  3. rule 75
  4. remark-lint-rule 68
  5. marker 13
  6. list 12
  7. ordered 3

remark-lint-ordered-list-marker-style

Build Coverage Downloads Size Sponsors Backers Chat

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

Contents

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:

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

In browsers with esm.sh:

<script type="module">
  import remarkLintOrderedListMarkerStyle from 'https://esm.sh/remark-lint-ordered-list-marker-style@3?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 Marker and Options. The default export is remarkLintOrderedListMarkerStyle.

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

Warn when ordered list markers are inconsistent.

Parameters
Returns

Transform (Transformer from unified).

Marker

Marker (TypeScript type).

Type
type Marker = '.' | ')'

Options

Configuration (TypeScript type).

Type
type Options = Marker | 'consistent'

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.  Foo


1.  Bar

Unordered lists are not affected by this rule.

* Foo
Out

No messages.

ok.md

When configured with '.'.

In
1.  Foo

2.  Bar
Out

No messages.

ok.md

When configured with ')'.

In
1)  Foo

2)  Bar
Out

No messages.

not-ok.md
In
1.  Foo

2)  Bar
Out
3:1-3:8: Marker style should be `.`
not-ok.md

When configured with '💩'.

Out
1:1: Incorrect ordered list item marker style `💩`: use either `'.'` or `')'`

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