Docs: rules in recommended

[ph-fritsche]

Suggested Changes

The docs should list those rules as recommended that are part of plugin:@typescript-eslint/recommended.

https://typescript-eslint.io/rules/ does not reflect configs/recommended:

@typescript-eslint/adjacent-overload-signatures
- @typescript-eslint/await-thenable
@typescript-eslint/ban-ts-comment
@typescript-eslint/ban-types
+ @typescript-eslint/no-array-constructor
+ @typescript-eslint/no-empty-function
@typescript-eslint/no-empty-interface
@typescript-eslint/no-explicit-any
@typescript-eslint/no-extra-non-null-assertion
+ @typescript-eslint/no-extra-semi
- @typescript-eslint/no-floating-promises
- @typescript-eslint/no-for-in-array
@typescript-eslint/no-inferrable-types
+ @typescript-eslint/no-loss-of-precision
@typescript-eslint/no-misused-new
@typescript-eslint/no-namespace
@typescript-eslint/no-non-null-asserted-optional-chain
@typescript-eslint/no-non-null-assertion
@typescript-eslint/no-this-alias
- @typescript-eslint/no-unnecessary-type-assertion
@typescript-eslint/no-unnecessary-type-constraint
- @typescript-eslint/no-unsafe-argument
- @typescript-eslint/no-unsafe-assignment
- @typescript-eslint/no-unsafe-call
- @typescript-eslint/no-unsafe-member-access
- @typescript-eslint/no-unsafe-return
+ @typescript-eslint/no-unused-vars
@typescript-eslint/no-var-requires
@typescript-eslint/prefer-as-const
@typescript-eslint/prefer-namespace-keyword
- @typescript-eslint/restrict-plus-operands
- @typescript-eslint/restrict-template-expressions
@typescript-eslint/triple-slash-reference
- @typescript-eslint/unbound-method

Affected URL(s)

https://typescript-eslint.io/rules/

[bradzacher]

https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts

We have two recommended configs that are intentionally separated.

This is mentioned explicitly at the top of that page.

'plugin:@typescript-eslint/recommended-requiring-type-checking' additional recommended rules that require type information. See Linting for more details.

[ph-fritsche]

But it doesn't reflect plugin:@typescript-eslint/recommended plus plugin:@typescript-eslint/recommended-requiring-type-checking either.

[bradzacher]

The table is generated - so it contains the same metadata as defined in the rules themselves.
https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/tools/generate-rules-lists.ts

So it should all match. What rules are erroneously there / missing?

[ph-fritsche]

recommended without type information:

@typescript-eslint/adjacent-overload-signatures
@typescript-eslint/ban-ts-comment
@typescript-eslint/ban-types
+ @typescript-eslint/no-array-constructor
+ @typescript-eslint/no-empty-function
@typescript-eslint/no-empty-interface
@typescript-eslint/no-explicit-any
@typescript-eslint/no-extra-non-null-assertion
+ @typescript-eslint/no-extra-semi
@typescript-eslint/no-inferrable-types
+ @typescript-eslint/no-loss-of-precision
@typescript-eslint/no-misused-new
@typescript-eslint/no-namespace
@typescript-eslint/no-non-null-asserted-optional-chain
@typescript-eslint/no-non-null-assertion
@typescript-eslint/no-this-alias
@typescript-eslint/no-unnecessary-type-constraint
+ @typescript-eslint/no-unused-vars
@typescript-eslint/no-var-requires
@typescript-eslint/prefer-as-const
@typescript-eslint/prefer-namespace-keyword
@typescript-eslint/triple-slash-reference

recommended-requiring-type-checking:

@typescript-eslint/await-thenable
@typescript-eslint/no-floating-promises
@typescript-eslint/no-for-in-array
+ @typescript-eslint/no-implied-eval
+ @typescript-eslint/no-misused-promise
@typescript-eslint/no-unnecessary-type-assertion
@typescript-eslint/no-unsafe-argument
@typescript-eslint/no-unsafe-assignment
@typescript-eslint/no-unsafe-call
@typescript-eslint/no-unsafe-member-access
@typescript-eslint/no-unsafe-return
+ @typescript-eslint/require-await
@typescript-eslint/restrict-plus-operands
@typescript-eslint/restrict-template-expressions
+ @typescript-eslint/unbound-method

Sidenote: In light mode the requires-type-information icon lacks contrast:

[bradzacher]

Scroll down to the third table and you'll find those listed:

https://typescript-eslint.io/rules/#extension-rules

[ph-fritsche]

I stand corrected. Sorry about the false report.
I just got confused scrolling up and down that page and when I found the complete list much faster in the code, I somehow got the impression there was something wrong with the docs. :(