codelyzer icon indicating copy to clipboard operation
codelyzer copied to clipboard

[Feature Request] Docs should mention defaults

Open lonix1 opened this issue 5 years ago • 2 comments

The docs pages for the rules should mention each rule's default.

Otherwise the only way to know is to inspect the code.

lonix1 avatar Mar 25 '19 10:03 lonix1

Unfortunately, TSLint doesn't do this for any rule. No rules are enabled by default with ESLint, so I'd imagine that is the case for TSLint and codelyzer. Instead, they can come with predefined configurations, like "recommended" used with TSLint and ESLint. The codelyzer recommended configuration is provided in the README. However, codelyzer is integrated with Angular CLI and generates default configuration in workspace/tslint.json and workspace/src/tslint.json. Maybe they intend to expand on this approach?

TrevorKarjanis avatar Apr 03 '19 20:04 TrevorKarjanis

Hi, not sure if my request is similar to this but I am expect something like "extends": "tslint:recommended",

So please implement a tslint profile for extending the default rule set.

example of usage:

  "extends": [
    "tslint:recommended"
    "codelyzer:recommended"
  ]

So that we can add automatically more rules on each upgrade of the dependency.

Thanks for your work.

mercuriete avatar Jul 23 '20 21:07 mercuriete