Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
2 tasks done
JoshuaKGoldberg opened this issue Jul 1, 2023 · 0 comments · Fixed by #7440
Closed
2 tasks done

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

JoshuaKGoldberg opened this issue Jul 1, 2023 · 0 comments · Fixed by #7440
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating

Comments

@JoshuaKGoldberg
Copy link
Member

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

@JoshuaKGoldberg JoshuaKGoldberg added documentation Documentation ("docs") that needs adding/updating accepting prs Go ahead, send a pull request that resolves this issue labels Jul 1, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant