Skip to content

Enhancement: [ban-ts-comment] Autofix ts-ignore to ts-expect-error depending on options #7843

Closed
@NotWoods

Description

@NotWoods

Before You File a Proposal Please Confirm You Have Done The Following...

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issueenhancement: plugin rule optionNew rule option for an existing eslint-plugin rulepackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions