Skip to content

忽略文件

大型仓库包含不应被检查的文件,如构建输出、vendor 代码、快照或生成的产物。Oxlint 提供了一个可预测的忽略模型,在 monorepo 和 CI 中运行良好。

TIP

强烈建议在 Oxlint 配置文件(.oxlintrc.jsonoxlint.config.ts)中使用 "ignorePatterns" 来忽略文件,而不是使用单独的忽略文件。这确保每个开发者在所有运行 Oxlint 的工具和命令(特别是 IDE/编辑器集成)中都有相同的忽略设置。这也使您的配置集中在一个文件中。

默认忽略

Oxlint 自动忽略:

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

隐藏文件不会自动忽略。

ignorePatterns

推荐的方法是在配置文件中使用 ignorePatterns 定义忽略。这使忽略设置与其所属的配置保持接近,并与嵌套配置自然配合。

模式相对于配置文件解析。

json
{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "ignorePatterns": ["dist/**", "coverage/**", "vendor/**", "test/snapshots/**"]
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  ignorePatterns: ["dist/**", "coverage/**", "vendor/**", "test/snapshots/**"],
});

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

.eslintignore

Oxlint 也支持 .eslintignore 以兼容现有的 ESLint 设置。现有的 .eslintignore 文件可以在迁移期间保留。语法与 .gitignore 兼容,包括注释和否定模式。

新项目应该优先使用配置文件中的 "ignorePatterns",我们强烈建议在迁移后不久(如果不是在迁移期间)就转到 "ignorePatterns"

从命令行忽略

CLI 标志对于 CI 或本地调试中的一次性更改很有用。

使用自定义忽略文件:

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

添加额外的忽略模式:

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

请给模式加引号以避免 shell glob 展开。

取消忽略文件

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

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

json
{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "ignorePatterns": ["build/**/*", "!build/keep.js"]
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  ignorePatterns: ["build/**/*", "!build/keep.js"],
});

这保持了遍历的可能性,同时仍然忽略几乎所有内容。

禁用忽略

要禁用所有忽略行为,包括忽略文件和 CLI 忽略选项,使用 --no-ignore

bash
oxlint --no-ignore