.. | ||
.npmrc | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-no-unneeded-full-reference-link
remark-lint
rule to warn when unneeded full reference links are used.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Examples
- Compatibility
- Contribute
- License
What is this?
This package checks for unneeded full reference links.
When should I use this?
You can use this package to check that reference links are consistent.
Presets
This plugin is not included in presets maintained here.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-unneeded-full-reference-link
In Deno with esm.sh
:
import remarkLintNoUnneededFullReferenceLink from 'https://esm.sh/remark-lint-no-unneeded-full-reference-link@3'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoUnneededFullReferenceLink from 'https://esm.sh/remark-lint-no-unneeded-full-reference-link@3?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoUnneededFullReferenceLink from 'remark-lint-no-unneeded-full-reference-link'
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(remarkLintNoUnneededFullReferenceLink)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-unneeded-full-reference-link .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-unneeded-full-reference-link",
…
]
}
…
API
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintNoUnneededFullReferenceLink
.
unified().use(remarkLintNoUnneededFullReferenceLink)
Warn when unneeded full reference links are used.
Parameters
There are no options.
Returns
Transform (Transformer
from unified
).
Recommendation
Full reference syntax ([Text][text]
) is quite verbose compared to
the concise collapsed reference syntax ([Text][]
).
Examples
ok.md
In
[alpha][]
[Bravo][]
[Charlie][delta]
This only works if the link text is a `text` node:
[`echo`][]
[*foxtrot*][]
[alpha]: a
[bravo]: b
[delta]: d
[`echo`]: e
[*foxtrot*]: f
Out
No messages.
not-ok.md
In
[alpha][alpha]
[Bravo][bravo]
[charlie][Charlie]
[alpha]: a
[bravo]: b
[charlie]: c
Out
1:1-1:15: Remove the link label as it matches the reference text
2:1-2:15: Remove the link label as it matches the reference text
3:1-3:19: Remove the link label as it matches the reference text
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-unneeded-full-reference-link@3
,
compatible with Node.js 12.
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.