unified

Project: remarkjs/remark-lint

Package: remark-lint-no-duplicate-definitions@3.1.0

  1. Dependents: 23
  2. remark-lint rule to warn on duplicate definitions
  1. remark 196
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. definition 15
  6. duplicate 4

remark-lint-no-duplicate-definitions

Build Coverage Downloads Size Sponsors Backers Chat

Warn when duplicate definitions are found.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-recommended

Example

ok.md
In
[foo]: bar
[baz]: qux
Out

No messages.

not-ok.md
In
[foo]: bar
[foo]: qux
Out
2:1-2:11: Do not use definitions with the same identifier (1:1)

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-no-duplicate-definitions

This package exports no identifiers. The default export is remarkLintNoDuplicateDefinitions.

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-duplicate-definitions",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-duplicate-definitions readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoDuplicateDefinitions from 'remark-lint-no-duplicate-definitions'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoDuplicateDefinitions)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(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