eslint-rule-documentation's Introduction

eslint-rule-documentation

Find the url for the documentation of an ESLint rule

Install

$ npm install --save eslint-rule-documentation

Usage

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

getRuleURI(ruleId)

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

{
  found: <boolean>,
  url: <string>
}

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.

Thanks

Special thanks to the team behind linter-eslint for the original work, and the people who contributed there.

License

MIT © Jeroen Engels

eslint-rule-documentation's People

Contributors

Stargazers

Watchers

eslint-rule-documentation's Issues

Begin the mourning process 🎉

Once eslint/eslint#9788 is released the contributing document should be modified to direct people to encourage rule authors to supply their own URL in the rule's metadata so that eventually this package can be put to rest 😛.

Add support for eslint-plugin-babel

Add support for eslint-plugin-babel. Pending babel/eslint-plugin-babel#92

Originally issued in sindresorhus/atom-linter-xo#34.

non-existent core rules and contribution link

When specifying a non-existent core rule, a link to a non-existent page will be generated, e.g.

getRuleURI('foo-bar');
// => { found: true, url: 'http://eslint.org/docs/rules/foo-bar' }

Would it be viable to use eslint-find-rule (as a lib) or just use similar means to check if there's an actual rule by that name and print a help otherwise?

Recommend Projects

jfmengels / eslint-rule-documentation Goto Github PK