remark-lint-unordered-list-marker-style
!Buildbadge-build-imagebadge-build-url
!Coveragebadge-coverage-imagebadge-coverage-url
!Downloadsbadge-downloads-imagebadge-downloads-url
!Sizebadge-size-imagebadge-size-url
!Sponsorsbadge-funding-sponsors-imagebadge-funding-url
!Backersbadge-funding-backers-imagebadge-funding-url
!Chatbadge-chat-imagebadge-chat-urlremark-lint
github-remark-lint rule to warn when unordered list markers are inconsistent.Contents
unified().use(remarkLintUnorderedListMarkerStyle[, options])
Options
Style
What is this?
This package checks unordered list markers.When should I use this?
You can use this package to check unordered lists.Presets
This plugin is included in the following presets:| Preset | Options | | - | - | |
remark-preset-lint-markdown-style-guide
| '-'
|Install
This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint-unordered-list-marker-style
In Deno with
esm.sh
esm-sh:import remarkLintUnorderedListMarkerStyle from 'https://esm.sh/remark-lint-unordered-list-marker-style@4'
In browsers with
esm.sh
esm-sh:<script type="module">
import remarkLintUnorderedListMarkerStyle from 'https://esm.sh/remark-lint-unordered-list-marker-style@4?bundle'
</script>
Use
On the API:import remarkLint from 'remark-lint'
import remarkLintUnorderedListMarkerStyle from 'remark-lint-unordered-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(remarkLintUnorderedListMarkerStyle)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-unordered-list-marker-style .
On the CLI in a config file (here a
package.json
):…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-unordered-list-marker-style",
…
]
}
…
API
This package exports no identifiers. It exports the TypeScripttypescript typesOptions
api-options and
Style
api-style.
The default export is
remarkLintUnorderedListMarkerStyle
api-remark-lint-unordered-list-marker-style.unified().use(remarkLintUnorderedListMarkerStyle[, options])
Warn when unordered list markers are inconsistent.Parameters
options
(Options
api-options, default:'consistent'
)
Returns
Transform (Transformer
from unified
github-unified-transformer).Options
Configuration (TypeScript type).Type
type Options = Style | 'consistent'
Style
Style (TypeScript type).Type
type Style = '*' | '+' | '-'
Recommendation
Because asterisks can be used as a marker for more markdown constructs, it’s recommended to use that for lists (and thematic breaks, emphasis, strong) too.Fix
remark-stringify
github-remark-stringify formats unordered lists with
asterisks by default.
Pass bullet: '+'
or bullet: '-'
to use a different marker.Examples
ok.md
In
* Mercury
1. Venus
* Earth
Out
No messages.ok.md
When configured with '*'
.In
* Mercury
Out
No messages.ok.md
When configured with '-'
.In
- Mercury
Out
No messages.ok.md
When configured with '+'
.In
+ Mercury
Out
No messages.not-ok.md
In
* Mercury
- Venus
+ Earth
Out
3:1: Unexpected unordered list marker `-`, expected `*`
5:1: Unexpected unordered 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-unordered-list-marker-style@4
,
compatible with Node.js 16.Contribute
Seecontributing.md
github-dotfiles-contributing in remarkjs/.github
github-dotfiles-health for ways
to get started.
See support.md
github-dotfiles-support for ways to get help.This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.