unified

Project: remarkjs/remark-lint

Package: remark-lint-no-auto-link-without-protocol@2.0.1

  1. Dependencies: 0·Dependents: 20
  2. remark-lint rule to warn for angle bracketed links without protocol
  1. remark 202
  2. lint 76
  3. rule 71
  4. remark-lint-rule 64
  5. link 15
  6. auto 4

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:

PresetSetting
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

npm:

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

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:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-auto-link-without-protocol'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || 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