Warn when shortcut reference images are used.
Shortcut references render as images when a definition is found, and as
plain text without definition.
Sometimes, you don’t intend to create an image 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.png
Out
No messages.
not-ok.md
In
![foo]
[foo]: http://foo.bar/baz.png
Out
1:1-1:7: Use the trailing [] on reference images
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-image
This package exports no identifiers.
The default export is remarkLintNoShortcutReferenceImage
.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-shortcut-reference-image",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-shortcut-reference-image readme.md
Or use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintNoShortcutReferenceImage from 'remark-lint-no-shortcut-reference-image'
remark()
.use(remarkLint)
+ .use(remarkLintNoShortcutReferenceImage)
.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