nlesc / codacy-tslint Goto Github PK

Should create Docker container and run the tests.

Blocked by #2

Codacy requires a docs/patterns.json file which specifies all the available patterns.
TSLint and some tslint-* packages include with rules.

Each TSLint rule should be mentioned in the docs/patterns.json file with their Codacy parameters or TSLint rule arguments.

Needed for #1

A pattern can be enriched by a description.

See Documentation chapter at https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide how to write these descriptions.

It would we nice if all patterns at least have a link to the rule page (eg. https://palantir.github.io/tslint/rules/typedef/) for more information.

At https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide there is a chapter explaining how to write tests and how to execute them.

There is a lot of overlap between the rules of tslint and eslint.
For a mapping see https://github.com/buzinas/tslint-eslint-rules

It should be possible to copy tests and documentation from https://github.com/codacy/codacy-eslint .

Refs #5 and #2