remark-lint-no-auto-link-without-protocol

remark-lint rule to warn for angle bracketed links without protocol

Usage no npm install needed!

<script type="module">
  import remarkLintNoAutoLinkWithoutProtocol from 'https://cdn.skypack.dev/remark-lint-no-auto-link-without-protocol';
</script>

README

remark-lint-no-auto-link-without-protocol

Build Coverage Downloads Size Sponsors Backers Chat

Warn for autolinks without protocol. Autolinks are URLs enclosed in < (less than) and > (greater than) characters.

Fix

remark-stringify adds a protocol where needed.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

| Preset | Setting | | - | - | | remark-preset-lint-markdown-style-guide | | | remark-preset-lint-recommended | |

Example

ok.md
In
<http://www.example.com>
<mailto:foo@bar.com>

Most Markdown vendors don’t recognize the following as a link:
<www.example.com>
Out

No messages.

not-ok.md
In
<foo@bar.com>
Out
1:1-1:14: All automatic links must start with a protocol

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-no-auto-link-without-protocol

This package exports no identifiers. The default export is remarkLintNoAutoLinkWithoutProtocol.

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-auto-link-without-protocol",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-auto-link-without-protocol readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoAutoLinkWithoutProtocol from 'remark-lint-no-auto-link-without-protocol'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoAutoLinkWithoutProtocol)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

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