Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
remark-lint-no-shortcut-reference-link
Advanced tools
Readme
remark-lint
rule to warn when shortcut reference links are used.
This package checks that collapsed or full reference links are used.
You can use this package to check that references are consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide | |
remark-preset-lint-recommended |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-shortcut-reference-link
In Deno with esm.sh
:
import remarkLintNoShortcutReferenceLink from 'https://esm.sh/remark-lint-no-shortcut-reference-link@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoShortcutReferenceLink from 'https://esm.sh/remark-lint-no-shortcut-reference-link@4?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoShortcutReferenceLink from 'remark-lint-no-shortcut-reference-link'
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(remarkLintNoShortcutReferenceLink)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-shortcut-reference-link .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-shortcut-reference-link",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintNoShortcutReferenceLink
.
unified().use(remarkLintNoShortcutReferenceLink)
Warn when shortcut reference links are used.
There are no options.
Transform (Transformer
from unified
).
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 a link. So it’s recommended to use collapsed or full references instead.
ok.md
[Mercury][]
[mercury]: http://example.com/mercury/
No messages.
not-ok.md
[Mercury]
[mercury]: http://example.com/mercury/
1:1-1:10: Unexpected shortcut reference link (`[text]`), expected collapsed reference (`[text][]`)
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-link@4
,
compatible with Node.js 16.
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.
FAQs
remark-lint rule to warn when shortcut reference links are used
The npm package remark-lint-no-shortcut-reference-link receives a total of 109,329 weekly downloads. As such, remark-lint-no-shortcut-reference-link popularity was classified as popular.
We found that remark-lint-no-shortcut-reference-link demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.