remark-lint/packages/remark-lint-no-undefined-references

remark-lint-no-undefined-references

Warn when references to undefined definitions are found.

Options: Object, optional.

The object can have an allow field, set to an array of strings that may appear between [ and ], but that should not be treated as link identifiers.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-recommended

Example

ok.md

In

[foo][]

[foo]: https://example.com

Out

No messages.

not-ok.md

In

[bar][]

Out

1:1-1:8: Found reference to undefined definition

ok-allow.md

When configured with { allow: [ '...', '…' ] }.

In

> Eliding a portion of a quoted passage […] is acceptable.

Out

No messages.

Install

npm:

npm install remark-lint-no-undefined-references

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-undefined-references",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-undefined-references 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-undefined-references'))
   .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