unified

Project: remarkjs/remark-lint

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

  1. Dependents: 20
  2. remark-lint rule to warn when the markers of ordered lists violate a given style
  1. remark 196
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. marker 13
  6. list 11
  7. ordered 3

remark-lint-ordered-list-marker-style

Build Coverage Downloads Size Sponsors Backers Chat

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

Options: 'consistent', '.', or ')', default: 'consistent'.

'consistent' detects the first used list style and warns when subsequent lists use different styles.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-consistent'consistent'
remark-preset-lint-markdown-style-guide'.'
remark-preset-lint-recommended'.'

Example

ok.md
In
1.  Foo


1.  Bar

Unordered lists are not affected by this rule.

* Foo
Out

No messages.

not-ok.md
In
1.  Foo

2)  Bar
Out
3:1-3:8: Marker style should be `.`
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

When configured with '💩'.

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

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

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

This package exports no identifiers. The default export is remarkLintOrderedListMarkerStyle.

Use

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

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

Or use it on the CLI directly

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

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintOrderedListMarkerStyle from 'remark-lint-ordered-list-marker-style'

 remark()
   .use(remarkLint)
+  .use(remarkLintOrderedListMarkerStyle)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(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