Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
remark-lint-unordered-list-marker-style
Advanced tools
Readme
remark-lint
rule to warn when unordered list markers are inconsistent.
This package checks unordered list markers.
You can use this package to check unordered lists.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide | '-' |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-unordered-list-marker-style
In Deno with esm.sh
:
import remarkLintUnorderedListMarkerStyle from 'https://esm.sh/remark-lint-unordered-list-marker-style@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintUnorderedListMarkerStyle from 'https://esm.sh/remark-lint-unordered-list-marker-style@4?bundle'
</script>
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",
…
]
}
…
This package exports no identifiers.
It exports the TypeScript types
Options
and
Style
.
The default export is
remarkLintUnorderedListMarkerStyle
.
unified().use(remarkLintUnorderedListMarkerStyle[, options])
Warn when unordered list markers are inconsistent.
options
(Options
, default: 'consistent'
)
— preferred style or whether to detect the first style and warn for
further differencesTransform (Transformer
from unified
).
Options
Configuration (TypeScript type).
type Options = Style | 'consistent'
Style
Style (TypeScript type).
type Style = '*' | '+' | '-'
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.
remark-stringify
formats unordered lists with
asterisks by default.
Pass bullet: '+'
or bullet: '-'
to use a different marker.
ok.md
* Mercury
1. Venus
* Earth
No messages.
ok.md
When configured with '*'
.
* Mercury
No messages.
ok.md
When configured with '-'
.
- Mercury
No messages.
ok.md
When configured with '+'
.
+ Mercury
No messages.
not-ok.md
* Mercury
- Venus
+ Earth
3:1: Unexpected unordered list marker `-`, expected `*`
5:1: Unexpected unordered list marker `+`, expected `*`
not-ok.md
When configured with '🌍'
.
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-unordered-list-marker-style@4
,
compatible with Node.js 16.
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.
FAQs
remark-lint rule to warn when markers of unordered lists violate a given style
The npm package remark-lint-unordered-list-marker-style receives a total of 91,187 weekly downloads. As such, remark-lint-unordered-list-marker-style popularity was classified as popular.
We found that remark-lint-unordered-list-marker-style demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.