unified

Project:remarkjs/remark-lint

Package:remark-lint-no-literal-urls@1.0.3

  1. Dependencies:5·Dependents:14
  2. remark-lint rule to warn when URLs without angle-brackets are used
  1. remark 165
  2. lint 70
  3. rule 64
  4. url 9
  5. literal 2

remark-lint-no-literal-urls

Build Coverage Downloads Size Sponsors Backers Chat

Warn for literal URLs in text. URLs are treated as links in some Markdown vendors, but not in others. To make sure they are always linked, wrap them in < (less-than) and > (greater-than).

Fix

remark-stringify never creates literal URLs and always uses < (less-than) and > (greater-than).

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

valid.md
In
<http://foo.bar/baz>
Out

No messages.

invalid.md
In
http://foo.bar/baz
Out
1:1-1:19: Don’t use literal URLs without angle brackets

Install

npm:

npm install remark-lint-no-literal-urls

Use

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

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

Or use it on the CLI directly

remark -u lint -u lint-no-literal-urls 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-literal-urls'))
   .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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer