Closed
Description
Before You File a Proposal Please Confirm You Have Done The Following...
- I have searched for related issues and found none that match my proposal.
- I have searched the current rule list and found no rules that match my proposal.
- I have read the FAQ and my problem is not listed.
My proposal is suitable for this project
- I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).
Link to the rule's documentation
https://typescript-eslint.io/rules/ban-ts-comment/
Description
A fairly common use-case for ban-ts-comment
is to ban @ts-ignore in favor of @ts-expect-error.
However, if developers are unfamiliar with @ts-expect-error, the error message doesn't help them find out about it.
The error message should recommend switching, and an autofix should be provided. If @ts-expect-error is also banned, the above original error message can be used instead.
I think it would be useful to autofix even if the rule is configured to require descriptions, as it still saves keystrokes. I don't know if autofixes are allowed to adjust code into a "fail" state however.
Fail
// @ts-ignore
Pass
// @ts-expect-error
// ^autofix
Additional Info
No response