eslint-rule-docs

Find documentation url for a given ESLint rule. Updated daily!

Install

1$ npm install eslint-rule-docs

Usage

1const getRuleUrl = require('eslint-rule-docs');
2
3// Find url for core rules
4getRuleUrl('no-undef');
5// => { exactMatch: true, url: 'https://eslint.org/docs/rules/no-undef' }
6
7// Find url for known plugins
8getRuleUrl('react/sort-prop-types');
9// => { exactMatch: true, url: 'https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-prop-types.md' }
10
11// If the plugin has no documentation, return repository url 
12getRuleUrl('flowtype/semi');
13// => { exactMatch: false, url: 'https://github.com/gajus/eslint-plugin-flowtype' }
14
15// If the plugin is unknown, returns an empty object
16getRuleUrl('unknown-foo/bar');
17// => {}

License

Copyright (c) 2018–present Stefan Buck. Licensed under the MIT license.