Package Exports
- remark-lint-no-shortcut-reference-image
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-shortcut-reference-image) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
remark-lint-no-shortcut-reference-image
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:
| Preset | Setting |
|---|---|
remark-preset-lint-markdown-style-guide |
|
remark-preset-lint-recommended |
Example
valid.md
In
![foo][]
[foo]: http://foo.bar/baz.pngOut
No messages.
invalid.md
In
![foo]
[foo]: http://foo.bar/baz.pngOut
1:1-1:7: Use the trailing [] on reference imagesInstall
npm install remark-lint-no-shortcut-reference-imageUsage
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.mdOr use this on the API:
var remark = require('remark');
var report = require('vfile-reporter');
remark()
.use(require('remark-lint'))
+ .use(require('remark-lint-no-shortcut-reference-image'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});