remark-lint rule to warn when unreferenced definitions are used.
Contents
What is this?
This package checks that definitions are referenced.
When should I use this?
You can use this package to check definitions.
Presets
This plugin is included in the following presets:
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-unused-definitions
In Deno with esm.sh:
import remarkLintNoUnusedDefinitions from 'https://esm.sh/remark-lint-no-unused-definitions@4'
In browsers with esm.sh:
<script type="module">
import remarkLintNoUnusedDefinitions from 'https://esm.sh/remark-lint-no-unused-definitions@4?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoUnusedDefinitions from 'remark-lint-no-unused-definitions'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintNoUnusedDefinitions)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-unused-definitions .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-unused-definitions",
…
]
}
…
API
This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoUnusedDefinitions.
Warn when unreferenced definitions are used.
Parameters
There are no options.
Returns
Transform (Transformer from unified).
Recommendation
Unused definitions do not contribute anything, so they can be removed.
Examples
ok.md
In
[Mercury][]
[mercury]: https://example.com/mercury/
Out
No messages.
not-ok.md
In
[mercury]: https://example.com/mercury/
Out
1:1-1:40: Unexpected unused definition, expected no definition or one or more references to `mercury`
gfm.md
In
👉 Note: this example uses GFM (remark-gfm).
Mercury[^mercury] is a planet.
[^Mercury]:
**Mercury** is the first planet from the Sun and the smallest
in the Solar System.
[^Venus]:
**Venus** is the second planet from
the Sun.
Out
6:1-8:13: Unexpected unused footnote definition, expected no definition or one or more footnote references to `venus`
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-lint-no-unused-definitions@4, compatible with Node.js 16.
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