.. | ||
.npmrc | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-no-shortcut-reference-image
remark-lint
rule to warn when shortcut reference images 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 that collapsed or full reference images are used.
When should I use this?
You can use this package to check that references are consistent.
Presets
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
|
remark-preset-lint-recommended |
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-shortcut-reference-image
In Deno with esm.sh
:
import remarkLintNoShortcutReferenceImage from 'https://esm.sh/remark-lint-no-shortcut-reference-image@3'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoShortcutReferenceImage from 'https://esm.sh/remark-lint-no-shortcut-reference-image@3?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoShortcutReferenceImage from 'remark-lint-no-shortcut-reference-image'
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(remarkLintNoShortcutReferenceImage)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-shortcut-reference-image .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-shortcut-reference-image",
…
]
}
…
API
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintNoShortcutReferenceImage
.
unified().use(remarkLintNoShortcutReferenceImage)
Warn when shortcut reference images are used.
Parameters
There are no options.
Returns
Transform (Transformer
from unified
).
Recommendation
Shortcut references use an implicit style that looks a lot like something that could occur as plain text instead of syntax. In some cases, plain text is intended instead of an image. So it’s recommended to use collapsed or full references instead.
Examples
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
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-shortcut-reference-image@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.