remark-lint-no-unused-definitions
!Buildbadge-build-imagebadge-build-url
!Coveragebadge-coverage-imagebadge-coverage-url
!Downloadsbadge-downloads-imagebadge-downloads-url
!Sizebadge-size-imagebadge-size-url
!Sponsorsbadge-funding-sponsors-imagebadge-funding-url
!Backersbadge-funding-backers-imagebadge-funding-url
!Chatbadge-chat-imagebadge-chat-urlremark-lint
github-remark-lint rule to warn when unreferenced definitions are used.Contents
unified().use(remarkLintNoUnusedDefinitions)
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:| Preset | Options | | - | - | |
remark-preset-lint-recommended
| |Install
This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint-no-unused-definitions
In Deno with
esm.sh
esm-sh:import remarkLintNoUnusedDefinitions from 'https://esm.sh/remark-lint-no-unused-definitions@4'
In browsers with
esm.sh
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 TypeScripttypescript types. The default export isremarkLintNoUnusedDefinitions
api-remark-lint-no-unused-definitions.unified().use(remarkLintNoUnusedDefinitions)
Warn when unreferenced definitions are used.Parameters
There are no options.Returns
Transform (Transformer
from unified
github-unified-transformer).Recommendation
Unused definitions do not contribute anything, so they can be removed.Examples
ok.md
In
[Mercury][]
Out
No messages.not-ok.md
In
```markdown ```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
github-remark-gfm).
Mercury[^mercury] is a planet.
in the Solar System.
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
Seecontributing.md
github-dotfiles-contributing in remarkjs/.github
github-dotfiles-health for ways
to get started.
See support.md
github-dotfiles-support for ways to get help.This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.