Skip to content

忽略文件

大型代码库包含不应进行检查的文件,例如构建输出、第三方代码、测试快照或生成的制品。Oxlint 提供了一种可预测的忽略模型,适用于单体仓库(monorepos)和 CI 环境。

TIP

强烈建议在 Oxlint 配置文件(.oxlintrc.jsonoxlint.config.ts)中使用 "ignorePatterns" 来忽略文件,而不是使用单独的忽略文件。这样可以确保所有开发者在运行 Oxlint 时具有相同的忽略规则,尤其是在 IDE/编辑器集成中。此外,这还能将配置集中于单一文件中。

默认忽略项

Oxlint 会自动忽略以下内容:

  • .git 目录
  • 文件名中包含 .min.-min._min. 的压缩文件
  • .gitignore 匹配的文件(全局 gitignore 文件不会被尊重)

隐藏文件不会被自动忽略。

ignorePatterns

推荐的做法是在配置文件中使用 ignorePatterns 定义忽略规则。这使得忽略规则与所属配置更接近,并能自然地支持嵌套配置。

模式路径相对于配置文件进行解析。

.oxlintrc.json
json
{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "ignorePatterns": ["dist/**", "coverage/**", "vendor/**", "test/snapshots/**"]
}

在单体仓库中,嵌套配置可以忽略特定包的输出,而不会影响仓库其余部分。

.eslintignore

Oxlint 还支持 .eslintignore,以兼容现有的 ESLint 设置。迁移过程中,现有 .eslintignore 文件可保持不变。其语法与 .gitignore 兼容,包括注释和否定模式。

新项目应优先在配置文件中使用 "ignorePatterns",我们强烈建议在迁移后尽快(甚至在迁移期间)过渡到 "ignorePatterns"

通过命令行忽略

命令行标志对 CI 中的一次性更改或本地调试非常有用。

使用自定义忽略文件:

bash
oxlint --ignore-path path/to/ignorefile

添加额外的忽略模式:

bash
oxlint --ignore-pattern 'dist/**' --ignore-pattern 'coverage/**'

使用引号包裹模式,以避免 shell 的通配符展开。

取消忽略文件

忽略文件支持否定模式,允许忽略一个目录,同时保留特定文件。

若要忽略 build/ 下的所有内容,但保留一个文件,应忽略目录内容而非目录本身:

.oxlintrc.json
json
{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "ignorePatterns": ["build/**/*", "!build/keep.js"]
}

这既能保持遍历能力,又可忽略几乎全部内容。

禁用忽略

如需完全禁用所有忽略行为(包括忽略文件和 CLI 忽略选项),请使用 --no-ignore

bash
oxlint --no-ignore