JSPM

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

2.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 75927
  • Score
    100M100P100Q17314F
  • License MIT

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

Package Exports

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

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-auto-link-without-protocol) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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

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