remark-lint-no-reference-like-url

remark-lint-no-reference-like-url

remark-lint rule to warn when URLs are also defined identifiers.

Contents

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

What is this?

This package checks for likely broken URLs that should probably have been references.

When should I use this?

You can use this package to check links.

Presets

This plugin is not included in presets maintained here.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-no-reference-like-url

In Deno with esm.sh:

import remarkLintNoReferenceLikeUrl from 'https://esm.sh/remark-lint-no-reference-like-url@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoReferenceLikeUrl from 'https://esm.sh/remark-lint-no-reference-like-url@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoReferenceLikeUrl from 'remark-lint-no-reference-like-url'
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(remarkLintNoReferenceLikeUrl)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-reference-like-url .

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-no-reference-like-url",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoReferenceLikeUrl.

unified().use(remarkLintNoReferenceLikeUrl)

Warn when URLs are also defined identifiers.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

While full URLs for definition identifiers are okay ([https://example.com]: https://example.com), and what looks like an identifier could be an actual URL ([text](alpha)), the more common case is that, assuming a definition [alpha]: https://example.com, then a link [text](alpha) should instead have been [text][alpha].

Examples

ok.md

In

[**Mercury**][mercury] is the first planet from the sun.

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

Out

No messages.

not-ok.md

In

[**Mercury**](mercury) is the first planet from the sun.

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

Out

1:1-1:23: Unexpected resource link (`[text](url)`) with URL that matches a definition identifier (as `mercury`), expected reference (`[text][id]`)

image.md

In

![**Mercury** is a planet](mercury).

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

Out

1:1-1:36: Unexpected resource image (`![text](url)`) with URL that matches a definition identifier (as `mercury`), expected reference (`![text][id]`)

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-reference-like-url@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