unified

Project: remarkjs/remark-lint

Package: remark-lint-no-reference-like-url@2.0.1

  1. Dependencies: 3·Dependents: 11
  2. remark-lint rule to warn when URLs are also defined identifiers
  1. remark 205
  2. lint 76
  3. rule 71
  4. remark-lint-rule 64
  5. definition 14
  6. url 11

remark-lint-no-reference-like-url

Build Coverage Downloads Size Sponsors Backers Chat

Warn when URLs are also defined identifiers.

Presets

This rule is not included in any default preset

Example

ok.md
In
[Alpha](http://example.com).

[bravo]: https://example.com
Out

No messages.

not-ok.md
In
[Charlie](delta).

[delta]: https://example.com
Out
1:1-1:17: Did you mean to use `[delta]` instead of `(delta)`, a reference?

Install

npm:

npm install remark-lint-no-reference-like-url

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-reference-like-url",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-reference-like-url 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-reference-like-url'))
   .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