unified

Project: remarkjs/remark-lint

Package: remark-lint-rule-style@2.0.1

  1. Dependencies: 4·Dependents: 16
  2. remark-lint rule to warn when horizontal rules violate a given style
  1. remark 182
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. break 4

remark-lint-rule-style

Build Coverage Downloads Size Sponsors Backers Chat

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:

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:

PresetSetting
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

npm:

npm install remark-lint-rule-style

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:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-rule-style'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || 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