Package Exports

remark-lint-ordered-list-marker-style

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-ordered-list-marker-style) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-lint-ordered-list-marker-style

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:

Preset	Setting
`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.