Package Exports
- eslint-rule-docs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-rule-docs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
eslint-rule-docs
Find documentation url for a given ESLint rule. Updated daily!
Install
$ npm install eslint-rule-docs
Usage
const getRuleUrl = require('eslint-rule-docs');
// Find url for core rules
getRuleUrl('no-undef');
// => { exactMatch: true, url: 'https://eslint.org/docs/rules/no-undef' }
// Find url for known plugins
getRuleUrl('react/sort-prop-types');
// => { exactMatch: true, url: 'https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-prop-types.md' }
// If the plugin has no documentation, return repository url
getRuleUrl('flowtype/semi');
// => { exactMatch: false, url: 'https://github.com/gajus/eslint-plugin-flowtype' }
// If the plugin is unknown, returns an empty object
getRuleUrl('unknown-foo/bar');
// => {}
License
MIT © Stefan Buck