快速入门

本页展示了 Oxlint 的推荐设置和最常见的工作流程，并提供可复制粘贴的命令。

安装

将 oxlint 作为开发依赖项安装：

npm

$ npm add -D oxlint

pnpm

$ pnpm add -D oxlint

yarn

$ yarn add -D oxlint

bun

$ bun add -D oxlint

向 package.json 添加 lint 命令：

package.json

{
  "scripts": {
    "lint": "oxlint",
    "lint:fix": "oxlint --fix"
  }
}

运行它：

npm

npm run lint

pnpm

pnpm run lint

yarn

yarn run lint

bun

bun run lint

应用修复：

npm

npm run lint:fix

pnpm

pnpm run lint:fix

yarn

yarn run lint:fix

bun

bun run lint:fix

使用

有关完整选项列表，请参阅 CLI 参考。

oxlint [OPTIONS] [PATH]...

如果省略 PATH，Oxlint 将检查当前工作目录。

常见工作流程

与 lint-staged 配合使用

npm

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "npm run lint"
  }
}

pnpm

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "pnpm run lint"
  }
}

yarn

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "yarn run lint"
  }
}

bun

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "bun run lint"
  }
}

创建配置文件

使用默认值初始化 .oxlintrc.json 配置文件：

oxlint --init

然后根据需要自定义 .oxlintrc.json。详见 配置。

或者，Oxlint 支持名为 oxlint.config.ts 的 TypeScript 配置文件。详情请参阅 配置。

然后运行 Oxlint：

oxlint

TIP

如果您正从 ESLint 迁移，请参阅 “从 ESLint 迁移”页面，获取详细的迁移指导。

修复问题

应用安全修复：

oxlint --fix

应用建议（可能会改变程序行为）：

oxlint --fix-suggestions

应用危险的修复和建议：

oxlint --fix-dangerously

有关每种模式的使用时机，请参阅 自动修复。

忽略文件

使用显式的忽略文件：

oxlint --ignore-path .oxlintignore

从命令行添加忽略模式：

oxlint --ignore-pattern "dist/**" --ignore-pattern "*.min.js"

禁用忽略处理：

oxlint --no-ignore

详见 忽略文件。

可靠地在 CI 中失败

仅报告错误：

oxlint --quiet

发现任何警告时即失败：

oxlint --deny-warnings

当警告数量超过阈值时失败：

oxlint --max-warnings 0

详见 CI 设置。

使用机器可读的输出

选择输出格式：

oxlint -f json

可用格式包括：default、json、unix、checkstyle、github、gitlab、junit、stylish。

检查有效配置

打印用于文件的配置：

oxlint --print-config path/to/file.ts

列出可用规则

列出已注册的规则，包括当前 Oxlint 配置启用的规则：

oxlint --rules

完整列表请见 规则参考。

下一步

• 配置规则、插件和忽略项：配置
• 配置编辑器
• 配置 CI
• 学习高级功能：多文件分析、类型感知的检查、JS 插件
• 迁移：从 ESLint 迁移
• CLI 参考