tslint-rule-documentation
Find the url for the documentation of a TSLint rule
Install
npm install --save tslint-rule-documentation
Usage
const getRuleUri = getRuleUri; // find uri for core rules;// => { found: true, uri: "https://palantir.github.io/tslint/rules/no-var-keyword"} // find uri for known plugins;// => { found: true, uri: "https://github.com/<user>/<repo>/blob/master/docs/foo.md"} // If the plugin is not known, get a link to help improve this;// => { found: false, uri: "https://github.com/Xapphire13/tslint-rule-documentation/blob/master/CONTRIBUTING.md"}Contributing
If a plugin 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: string): IRuleResult
ruleId
Type: string
The ID of a TSLint rule
Examples:
- core rule:
no-var-keyword - plugin rule:
__example/foo
returns
Type: IRuleResult
interface IRuleResult { found: boolean; // true if the rule is a TSLint core rule, or a known plugin rule, false otherwise uri: string; // If found is true, uri of the documentation of the rule. If found is false, uri of the contribution guidelines}Credit
This is based on eslint-rules-documentation, so I would like to thank the authors of that for the inspiration and code to base this on.
License
MIT