Skip to content

Docs: Advise against "progressive enhancement" with rule type information #7158

Closed
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Coming over from #7124 (comment), quoting @bradzacher:

... we've always given the advice that you shouldn't do progressive enhancement of lint rules depending on if type information might be there.

Thats the same hard-and-fast rule that we have taken with every single one of our lint rules.

The reason we take this line is because config is hard and if you just silently enhance a rule with type information but the user misconfigures it how can you alert the user to the misconfiguration?

This is good advice, but I don't believe it's in the public rule docs? We should add it so folks know. This comes up once in a while on social media too.

Affected URL(s)

https://typescript-eslint.io/developers/custom-rules#typed-rules

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updating

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions