tslint-rule-documentation
Find the url for the documentation of a TSLint rule
Install
npm install --save tslint-rule-documentation
Usage
const getRuleUri = require("tslint-rule-documentation").getRuleUri;
getRuleUri("no-var-keyword");
getRuleUri("__example/foo");
getRuleUri("unknown-plugin/foo");
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;
uri: string;
}
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