typescript/ban-ts-comment Pedantic

🛠️ An auto-fix is available for this rule for some violations.

What it does

This rule lets you set which directive comments you want to allow in your codebase.

Why is this bad?

Using TypeScript directives to suppress TypeScript compiler errors reduces the effectiveness of TypeScript overall.

Examples

Examples of incorrect code for this rule:

if (false) {
  // @ts-ignore: Unreachable code error
  console.log("hello");
}

Configuration

This rule accepts a configuration object with the following properties:

minimumDescriptionLength

type: integer

default: 3

Minimum description length required when using directives with allow-with-description.

ts-check

How to handle the @ts-check directive.

ts-expect-error

How to handle the @ts-expect-error directive.

ts-ignore

How to handle the @ts-ignore directive.

ts-nocheck

How to handle the @ts-nocheck directive.

How to use

To enable this rule in the CLI or using the config file, you can use:

CLI

oxlint --deny typescript/ban-ts-comment

Config (.oxlintrc.json)

{
  "rules": {
    "typescript/ban-ts-comment": "error"
  }
}

References

• Rule Source