Find the url for the documentation of an ESLint rule
npm install eslint-rule-documentation
$ npm install --save eslint-rule-documentation
`
Usage
`js
const getRuleURI = require('eslint-rule-documentation');
// find url for core rules
getRuleURI('no-var');
// => { found: true, url: 'https://eslint.org/docs/rules/no-var' }
// find url for known plugins
getRuleURI('import/no-unresolved');
// => { found: true, url: 'https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md' }
// If the plugin is not known, get a link to help improve this
getRuleURI('unknown-foo/bar');
// => { found: false, url: 'https://github.com/jfmengels/eslint-rule-documentation/blob/master/contributing.md' }
`
Contributing
If you find a plugin that you use is not in the list of supported plugins, please consider adding it to the project by following the instructions here.
API
$3
#### ruleId
Type: string
Id of an [ESLint] rule.
Examples:
- core rule: no-var
- plugin rule: import/no-unresolved (from the [eslint-plugin-import] plugin).
#### returns
Type: object
`js
{
found: ,
url:
}
`
- found: true if the rule is an ESLint core rule, or a rule of a known plugin, false otherwise.
- url: if found is true, url of the documentation of a rule. If found is false`, url of the contribution guidelines.