remark-lint-no-shortcut-reference-image
!Buildbadge-build-imagebadge-build-url
!Coveragebadge-coverage-imagebadge-coverage-url
!Downloadsbadge-downloads-imagebadge-downloads-url
!Sizebadge-size-imagebadge-size-url
!Sponsorsbadge-funding-sponsors-imagebadge-funding-url
!Backersbadge-funding-backers-imagebadge-funding-url
!Chatbadge-chat-imagebadge-chat-urlremark-lint
github-remark-lint rule to warn when shortcut reference images are used.Contents
unified().use(remarkLintNoShortcutReferenceImage)
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 onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint-no-shortcut-reference-image
In Deno with
esm.sh
esm-sh:import remarkLintNoShortcutReferenceImage from 'https://esm.sh/remark-lint-no-shortcut-reference-image@4'
In browsers with
esm.sh
esm-sh:<script type="module">
import remarkLintNoShortcutReferenceImage from 'https://esm.sh/remark-lint-no-shortcut-reference-image@4?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 TypeScripttypescript types. The default export isremarkLintNoShortcutReferenceImage
api-remark-lint-no-shortcut-reference-image.unified().use(remarkLintNoShortcutReferenceImage)
Warn when shortcut reference images are used.Parameters
There are no options.Returns
Transform (Transformer
from unified
github-unified-transformer).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
![Mercury][]
Out
No messages.not-ok.md
In
![Mercury]
Out
1:1-1:11: Unexpected shortcut reference image (`![text]`), expected collapsed 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-shortcut-reference-image@4
,
compatible with Node.js 16.Contribute
Seecontributing.md
github-dotfiles-contributing in remarkjs/.github
github-dotfiles-health for ways
to get started.
See support.md
github-dotfiles-support for ways to get help.This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.