Warn when shortcut reference links are used.
Shortcut references render as links when a definition is found, and as
plain text without definition.
Sometimes, you don’t intend to create a link from the reference, but this
rule still warns anyway.
In that case, you can escape the reference like so: \[foo]
.
Presets
This rule is included in the following presets:
Example
ok.md
In
[foo][]
[foo]: http://foo.bar/baz
Out
No messages.
not-ok.md
In
[foo]
[foo]: http://foo.bar/baz
Out
1:1-1:6: Use the trailing `[]` on reference links
Install
This package is ESM only:
Node 12+ is needed to use it and it must be imported
ed instead of required
d.
npm:
npm install remark-lint-no-shortcut-reference-link
This package exports no identifiers.
The default export is remarkLintNoShortcutReferenceLink
.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-shortcut-reference-link",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-shortcut-reference-link readme.md
Or use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintNoShortcutReferenceLink from 'remark-lint-no-shortcut-reference-link'
remark()
.use(remarkLint)
+ .use(remarkLintNoShortcutReferenceLink)
.process('_Emphasis_ and **importance**')
.then((file) => {
console.error(reporter(file))
})
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