remark-lint-rule-style

remark-lint-rule-style

Warn when the horizontal rules violate a given or detected style.

Options: string, either a valid markdown rule, or 'consistent', default: 'consistent'.

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

Note: horizontal rules are also called “thematic break”.

Presets

This rule is included in the following presets:

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

Example

valid.md

When configured with '* * *'.

In

* * *

* * *

Out

No messages.

valid.md

When configured with '_______'.

In

_______

_______

Out

No messages.

invalid.md

In

***

* * *

Out

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

invalid.md

When configured with '!!!'.

Out

1:1: Invalid preferred rule-style: provide a valid markdown rule, or `'consistent'`

Install

npm install remark-lint-rule-style

Usage

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));
   });

License

MIT © Titus Wormer