JSPM

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

remark-lint rule to warn when references to undefined definitions are found

Package Exports

  • remark-lint-no-undefined-references

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-undefined-references) 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-undefined-references

Warn when references to undefined definitions are found.

Presets

This rule is included in the following presets:

Preset Setting
remark-preset-lint-recommended

Example

valid.md
In
[foo][]

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

No messages.

invalid.md
In
[bar][]
Out
1:1-1:8: Found reference to undefined definition

Install

npm install remark-lint-no-undefined-references

Usage

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));
   });

License

MIT © Titus Wormer