remark-lint-definition-spacing

remark-lint-definition-spacing

Warn when consecutive white space is used in a definition.

Presets

This rule is included in the following presets:

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

Example

valid.md

In

[example domain]: http://example.com "Example Domain"

Out

No messages.

invalid.md

In

Note: · represents a space.

[example····domain]: http://example.com "Example Domain"

Out

1:1-1:57: Do not use consecutive white-space in definition labels

Install

npm install remark-lint-definition-spacing

Usage

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

 ...
 "remarkConfig": {
   "plugins": [
     ...
     "lint",
+    "lint-definition-spacing",
     ...
   ]
 }
 ...

Or use it on the CLI directly

remark -u lint -u lint-definition-spacing 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-definition-spacing'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

License

MIT © Titus Wormer