mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 19:58:38 +03:00
282d27606d
This commit rewrites most of the documentation per rule and preset, `remark-lint` itself, and `unified-lint-rule`. * Better and more readable automatic examples * Check and update all rule descriptions * Use middot (·) and line-feed (␊) for relevant examples * Unify descriptions of `'consistent`' * Add some more docs where needed Closes GH-158.
1.4 KiB
1.4 KiB
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));
});