tslint-rule-documentation

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;

// find uri for core rules
getRuleUri("no-var-keyword");
// => { found: true, uri: "https://palantir.github.io/tslint/rules/no-var-keyword"}

// find uri for known plugins
getRuleUri("__example/foo");
// => { 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
getRuleUri("unknown-plugin/foo");
// => { found: true, uri: "https://github.com/Xapphire13/tsli…tation/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

Coming soon

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