remark-lint/packages/remark-lint-no-duplicate-definitions/readme.md

91 lines
1.4 KiB
Markdown
Raw Normal View History

<!--This file is generated-->
# remark-lint-no-duplicate-definitions
Warn when duplicate definitions are found.
## Presets
This rule is included in the following presets:
| Preset | Setting |
| ------ | ------- |
2017-12-08 17:39:26 +03:00
| [`remark-preset-lint-recommended`](https://github.com/remarkjs/remark-lint/tree/master/packages/remark-preset-lint-recommended) | |
## Example
##### `valid.md`
###### In
```markdown
[foo]: bar
[baz]: qux
```
###### Out
No messages.
##### `invalid.md`
###### In
```markdown
[foo]: bar
[foo]: qux
```
###### Out
```text
2:1-2:11: Do not use definitions with the same identifier (1:1)
```
## Install
```sh
npm install remark-lint-no-duplicate-definitions
```
## Usage
You probably want to use it on the CLI through a config file:
```diff
...
"remarkConfig": {
"plugins": [
...
"lint",
+ "lint-no-duplicate-definitions",
...
]
}
...
```
Or use it on the CLI directly
```sh
remark -u lint -u lint-no-duplicate-definitions readme.md
```
Or use this on the API:
```diff
var remark = require('remark');
var report = require('vfile-reporter');
remark()
.use(require('remark-lint'))
+ .use(require('remark-lint-no-duplicate-definitions'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});
```
## License
2018-11-22 14:18:12 +03:00
[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com)