remark-lint-rule-style
v4.0.0
Published
remark-lint rule to warn when horizontal rules violate a given style
Downloads
480,686
Readme
remark-lint-rule-style
remark-lint
rule to warn when thematic breaks (horizontal rules) are
inconsistent.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Fix
- Examples
- Compatibility
- Contribute
- License
What is this?
This package checks markers and whitespace of thematic rules.
When should I use this?
You can use this package to check that thematic breaks are consistent.
Presets
This plugin is included in the following presets:
| Preset | Options |
| - | - |
| remark-preset-lint-consistent
| 'consistent'
|
| remark-preset-lint-markdown-style-guide
| '---'
|
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-rule-style
In Deno with esm.sh
:
import remarkLintRuleStyle from 'https://esm.sh/remark-lint-rule-style@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintRuleStyle from 'https://esm.sh/remark-lint-rule-style@4?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintRuleStyle from 'remark-lint-rule-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(remarkLintRuleStyle)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-rule-style .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-rule-style",
…
]
}
…
API
This package exports no identifiers.
It exports the TypeScript type
Options
.
The default export is
remarkLintRuleStyle
.
unified().use(remarkLintRuleStyle[, options])
Warn when thematic breaks (horizontal rules) are inconsistent.
Parameters
options
(Options
, default:'consistent'
) — preferred style or whether to detect the first style and warn for further differences
Options
Configuration (TypeScript type).
'consistent'
— detect the first used style and warn when further rules differstring
(example:'** * **'
,'___'
) — thematic break to prefer
Type
type Options = string | 'consistent'
Recommendation
Rules consist of a *
, -
, or _
character,
which occurs at least three times with nothing else except for arbitrary
spaces or tabs on a single line.
Using spaces, tabs, or more than three markers is unnecessary work to type
out.
As asterisks can be used as a marker for more markdown constructs,
it’s recommended to use that for rules (and lists, emphasis, strong) too.
So it’s recommended to pass '***'
.
Fix
remark-stringify
formats rules with ***
by
default.
There are three settings to control rules:
rule
(default:'*'
) — markerruleRepetition
(default:3
) — repetitionsruleSpaces
(default:false
) — use spaces between markers
Examples
ok.md
In
Two rules:
* * *
* * *
Out
No messages.
ok.md
When configured with '_______'
.
In
_______
_______
Out
No messages.
not-ok.md
In
***
* * *
Out
3:1-3:6: Unexpected thematic rule `* * *`, expected `***`
not-ok.md
When configured with '🌍'
.
Out
1:1: Unexpected value `🌍` for `options`, expected thematic rule 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-rule-style@4
,
compatible with Node.js 16.
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.