remark-lint rule to warn when the markers of ordered lists violate a given style
npm install remark-lint-ordered-list-marker-style[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]
[![Sponsors][badge-funding-sponsors-image]][badge-funding-url]
[![Backers][badge-funding-backers-image]][badge-funding-url]
[![Chat][badge-chat-image]][badge-chat-url]
[remark-lint][github-remark-lint] rule to warn when ordered list markers are inconsistent.
* What is this?
* When should I use this?
* Presets
* Install
* Use
* API
* [unified().use(remarkLintOrderedListMarkerStyle[, options])](#unifieduseremarklintorderedlistmarkerstyle-options)
* Options
* Style
* Recommendation
* Fix
* Examples
* Compatibility
* Contribute
* License
This package checks ordered list markers.
You can use this package to check ordered lists.
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 | '.' |
This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
install with [npm][npm-install]:
``sh`
npm install remark-lint-ordered-list-marker-style
In Deno with [esm.sh][esm-sh]:
`js`
import remarkLintOrderedListMarkerStyle from 'https://esm.sh/remark-lint-ordered-list-marker-style@4'
In browsers with [esm.sh][esm-sh]:
`html`
On the API:
`js
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:
`sh`
remark --frail --use remark-lint --use remark-lint-ordered-list-marker-style .
On the CLI in a config file (here a package.json):
`diff`
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-ordered-list-marker-style",
…
]
}
…
This package exports no identifiers.
It exports the [TypeScript][typescript] types
[Options][api-options] andStyle
[][api-style].remarkLintOrderedListMarkerStyle
The default export is
[][api-remark-lint-ordered-list-marker-style].
Warn when ordered list markers are inconsistent.
###### Parameters
* options ([Options][api-options], default: 'consistent')
— preferred style or whether to detect the first style and warn for
further differences
###### Returns
Transform ([Transformer from unified][github-unified-transformer]).
Configuration (TypeScript type).
###### Type
`ts`
type Options = Style | 'consistent'
Style (TypeScript type).
###### Type
`ts`
type Style = '.' | ')'
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.
[remark-stringify][github-remark-stringify] formats ordered lists withbulletOrdered: ')'
dots by default.
Pass to always use parens.
##### ok.md
###### In
`markdown
1. Mercury
* Venus
1. Earth
`
###### Out
No messages.
##### ok.md
When configured with '.'.
###### In
`markdown`
1. Mercury
###### Out
No messages.
##### ok.md
When configured with ')'.
###### In
`markdown`
1) Mercury
###### Out
No messages.
##### not-ok.md
###### In
`markdown
1. Mercury
1) Venus
`
###### Out
`text)
3:2: Unexpected ordered list marker , expected .`
##### not-ok.md
When configured with '🌍'.
###### Out
`text🌍
1:1: Unexpected value for options, expected '.', ')', or 'consistent'`
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.
See [contributing.md][github-dotfiles-contributing] in [remarkjs/.github][github-dotfiles-health] for wayssupport.md`][github-dotfiles-support] for ways to get help.
to get started.
See [
This project has a [code of conduct][github-dotfiles-coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
[MIT][file-license] © [Titus Wormer][author]
[api-options]: #options
[api-remark-lint-ordered-list-marker-style]: #unifieduseremarklintorderedlistmarkerstyle-options
[api-style]: #style
[author]: https://wooorm.com
[badge-build-image]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg
[badge-build-url]: https://github.com/remarkjs/remark-lint/actions
[badge-chat-image]: https://img.shields.io/badge/chat-discussions-success.svg
[badge-chat-url]: https://github.com/remarkjs/remark/discussions
[badge-coverage-image]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
[badge-coverage-url]: https://codecov.io/github/remarkjs/remark-lint
[badge-downloads-image]: https://img.shields.io/npm/dm/remark-lint-ordered-list-marker-style.svg
[badge-downloads-url]: https://www.npmjs.com/package/remark-lint-ordered-list-marker-style
[badge-funding-backers-image]: https://opencollective.com/unified/backers/badge.svg
[badge-funding-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg
[badge-funding-url]: https://opencollective.com/unified
[badge-size-image]: https://img.shields.io/bundlejs/size/remark-lint-ordered-list-marker-style
[badge-size-url]: https://bundlejs.com/?q=remark-lint-ordered-list-marker-style
[esm-sh]: https://esm.sh
[file-license]: https://github.com/remarkjs/remark-lint/blob/main/license
[github-dotfiles-coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
[github-dotfiles-contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
[github-dotfiles-health]: https://github.com/remarkjs/.github
[github-dotfiles-support]: https://github.com/remarkjs/.github/blob/main/support.md
[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[github-remark-lint]: https://github.com/remarkjs/remark-lint
[github-remark-stringify]: https://github.com/remarkjs/remark/tree/main/packages/remark-stringify
[github-unified-transformer]: https://github.com/unifiedjs/unified#transformer
[npm-install]: https://docs.npmjs.com/cli/install
[typescript]: https://www.typescriptlang.org