typescript/ban-ts-comment Pedantic

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

它的作用

此规则允许您设置在代码库中允许使用哪些指令注释。

为什么这不好？

使用 TypeScript 指令来抑制 TypeScript 编译器错误会降低 TypeScript 整体的有效性。

示例

此规则的错误代码示例如下：

if (false) {
  // @ts-ignore: 无法执行的代码错误
  console.log("hello");
}

配置

此规则允许您指定应如何处理不同的 TypeScript 指令注释。

对于每个指令（@ts-expect-error、@ts-ignore、@ts-nocheck、@ts-check），您可以选择以下选项之一：

true：完全禁止该指令，阻止其在整个代码库中使用。
false：不加限制地允许该指令。
"allow-with-description"：仅当该指令后跟有说明其用途的描述时才允许使用。该描述必须满足 minimumDescriptionLength 指定的最小长度。
{ "descriptionFormat": "<regex>" }：仅当描述匹配指定的正则表达式模式时才允许使用该指令。

例如：

json

{
  "ts-expect-error": "allow-with-description",
  "ts-ignore": true,
  "ts-nocheck": { "descriptionFormat": "^: TS\\d+ because .+$" },
  "ts-check": false,
  "minimumDescriptionLength": 3
}

此规则接受一个包含以下属性的配置对象：

minimumDescriptionLength

type: integer

default: 3

使用 allow-with-description 指令时所需的最小描述长度。

ts-check

如何处理 @ts-check 指令。

ts-expect-error

如何处理 @ts-expect-error 指令。

ts-ignore

如何处理 @ts-ignore 指令。

ts-nocheck

如何处理 @ts-nocheck 指令。

如何使用

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

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

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

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "typescript/ban-ts-comment": "error",
  },
});

bash

oxlint --deny typescript/ban-ts-comment

版本

此规则于 v0.0.8 中添加。

它的作用 ​

为什么这不好？ ​

示例 ​

配置 ​

minimumDescriptionLength ​

ts-check ​

ts-expect-error ​

ts-ignore ​

ts-nocheck ​

如何使用 ​

版本 ​

参考 ​