{"library":"remark-lint-no-undefined-references","title":"remark-lint-no-undefined-references","description":"remark-lint rule to warn when Markdown references to undefined definitions are found. Current stable version: 5.0.2. Released as part of the remark-lint monorepo; patch updates follow release cadence of the monorepo. Differentiator: catches broken links in Markdown documents by ensuring all `[text][reference]` and `[text][]` references have a corresponding `[reference]: URL` definition. Supports options to allow shortcut references and custom allow-lists. Ships TypeScript types and is ESM-only from v5.","language":"javascript","status":"active","last_verified":"Fri May 01","install":{"commands":["npm install remark-lint-no-undefined-references"],"cli":{"name":"remark","version":null}},"imports":["import remarkLintNoUndefinedReferences from 'remark-lint-no-undefined-references'","import type { Options } from 'remark-lint-no-undefined-references'","const remarkLintNoUndefinedReferences = require('remark-lint-no-undefined-references').default"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import { unified } from 'unified'\nimport remarkParse from 'remark-parse'\nimport remarkStringify from 'remark-stringify'\nimport remarkLint from 'remark-lint'\nimport remarkLintNoUndefinedReferences from 'remark-lint-no-undefined-references'\nimport { read } from 'to-vfile'\nimport { reporter } from 'vfile-reporter'\n\nconst file = await read('example.md')\n\nawait unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintNoUndefinedReferences, { allowShortcutLink: true })\n  .use(remarkStringify)\n  .process(file)\n\nconsole.error(reporter(file))","lang":"typescript","description":"Sets up a unified pipeline to lint a Markdown file for undefined references, allowing shortcut links.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}