remark-lint-rule-style

remark-lint-rule-style

Warn when the thematic breaks (horizontal rules) violate a given or detected style.

Options: string, either a corect thematic breaks such as ***, or 'consistent', default: 'consistent'.

'consistent' detects the first used thematic break style and warns when subsequent rules use different styles.

Fix

remark-stringify has three settings that define how rules are created:

• rule (default: *) — Marker to use
• ruleRepetition (default: 3) — Number of markers to use
• ruleSpaces (default: true) — Whether to pad markers with spaces

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-consistent	'consistent'
remark-preset-lint-markdown-style-guide	'---'

Example

ok.md

When configured with '* * *'.

In

* * *

* * *

Out

No messages.

ok.md

When configured with '_______'.

In

_______

_______

Out

No messages.

not-ok.md

In

***

* * *

Out

3:1-3:6: Rules should use `***`

not-ok.md

When configured with '💩'.

Out

1:1: Incorrect preferred rule style: provide a correct markdown rule or `'consistent'`

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-rule-style

This package exports no identifiers. The default export is remarkLintRuleStyle.

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-rule-style",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-rule-style readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintRuleStyle from 'remark-lint-rule-style'

 remark()
   .use(remarkLint)
+  .use(remarkLintRuleStyle)
   .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.

License

MIT © Titus Wormer