remark-lint-no-shortcut-reference-link

remark-lint rule to warn when shortcut reference links are used.

Contents

What is this?
When should I use this?
Presets
Install
Use
API
- unified().use(remarkLintNoShortcutReferenceLink)
Recommendation
Examples
Compatibility
Contribute
License

What is this?

This package checks that collapsed or full reference links 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-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>

Use

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",
     …
   ]
 }
 …

API

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.

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 a link. So it’s recommended to use collapsed or full references instead.

Examples

`ok.md`

In

[Mercury][]

[mercury]: https://example.com/mercury/

Out

No messages.

`not-ok.md`

In

[Mercury]

[mercury]: https://example.com/mercury/

Out

1:1-1:10: Unexpected shortcut reference link (`[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-link@4, compatible with Node.js 16.

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

Uh oh!