remark-lint/packages/remark-lint-no-unused-definitions

remark-lint-no-unused-definitions

Warn when unused definitions are found.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-recommended

Example

valid.md

In

[foo][]

[foo]: https://example.com

Out

No messages.

invalid.md

In

[bar]: https://example.com

Out

1:1-1:27: Found unused definition

Install

npm install remark-lint-no-unused-definitions

Usage

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

 ...
 "remarkConfig": {
   "plugins": [
     ...
     "lint",
+    "lint-no-unused-definitions",
     ...
   ]
 }
 ...

Or use it on the CLI directly

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

License

MIT © Titus Wormer