remark-lint-no-literal-urls

remark-lint rule to warn when GFM autolink literals are used.

Contents

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

What is this?

This package checks that regular autolinks or full links are used. Literal autolinks is a GFM feature enabled with remark-gfm.

When should I use this?

You can use this package to check that links 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-literal-urls

In Deno with esm.sh:

import remarkLintNoLiteralUrls from 'https://esm.sh/remark-lint-no-literal-urls@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoLiteralUrls from 'https://esm.sh/remark-lint-no-literal-urls@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoLiteralUrls from 'remark-lint-no-literal-urls'
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(remarkLintNoLiteralUrls)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-literal-urls .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-no-literal-urls",
     …
   ]
 }
 …

API

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

unified().use(remarkLintNoLiteralUrls)

Warn when GFM autolink literals are used.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

GFM autolink literals (just a raw URL) are a feature enabled by GFM. They don’t work everywhere. So, it’s recommended to instead use regular autolinks (<https://url>) or full links ([text](url)).

Fix

remark-stringify never generates GFM autolink literals. It always generates regular autolinks or full links.

Examples

ok.md

In

👉 Note: this example uses GFM (remark-gfm).

<https://example.com/mercury/>

![Venus](http://example.com/venus/).

Out

No messages.

not-ok.md

In

👉 Note: this example uses GFM (remark-gfm).

https://example.com/mercury/

www.example.com/venus/

[e-mail]

Out

1:1-1:29: Unexpected GFM autolink literal, expected regular autolink, add `<` before and `>` after
3:1-3:23: Unexpected GFM autolink literal, expected regular autolink, add `<http://` before and `>` after
5:1-5:19: Unexpected GFM autolink literal, expected regular autolink, add `<mailto:` before and `>` after

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-literal-urls@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