如何配置ESLint使"no-unused-vars"规则忽略指定文件与场景

要实现你需要的规则配置，需结合TypeScript ESLint插件的特性处理，具体步骤如下：

1. 依赖准备 #

确保项目已安装@typescript-eslint/eslint-plugin和@typescript-eslint/parser，这两个包是处理TypeScript语法ESLint规则的基础。

2. 核心规则配置 #

在ESLint配置文件（.eslintrc.js/.eslintrc.json）中，替换原生no-unused-vars规则为TypeScript版本，并添加针对性配置：

{
  "parser": "@typescript-eslint/parser",
  "plugins": ["@typescript-eslint"],
  "rules": {
    // 关闭原生规则，使用TypeScript版本
    "no-unused-vars": "off",
    "@typescript-eslint/no-unused-vars": [
      "error",
      {
        // 忽略命名为下划线的参数/解构props
        "argsIgnorePattern": "^_$",
        "varsIgnorePattern": "^_$",
        // 允许解构中存在未使用的重命名属性（如{ created: _ }）
        "ignoreRestSiblings": true,
        // 忽略函数类型、接口中的参数未使用情况
        "ignoreTypeParameters": true
      }
    ]
  }
}

3. 忽略TypeScript声明文件 #

有两种方式实现对*.d.ts文件的规则忽略：

方式一：使用.eslintignore文件 #

在项目根目录创建.eslintignore文件，添加：

*.d.ts

方式二：在ESLint配置中添加overrides #

{
  "overrides": [
    {
      "files": ["*.d.ts"],
      "rules": {
        "@typescript-eslint/no-unused-vars": "off"
      }
    }
  ]
}

配置说明 #

• argsIgnorePattern/varsIgnorePattern: 精准匹配下划线命名的变量/参数，忽略其未使用的报错。
• ignoreRestSiblings: 解决解构赋值中重命名为_的属性（如async ({ page, created: _ })）的未使用报错。
• ignoreTypeParameters: 忽略函数类型声明（如onChange: (new_value: string[]) => void）中参数未使用的情况。
• *.d.ts文件忽略: 声明文件中的变量多为对外暴露的类型定义，无需强制检查是否被使用。

内容的提问来源于stack exchange，提问作者Rolegur