命令行界面

使用方法

oxlint [-c=<./.oxlintrc.json>] [PATH]...

基本配置

• -c, --config=<./.oxlintrc.json> — Oxlint 配置文件

• 支持所有运行时的 .json 配置文件

• JavaScript/TypeScript 配置文件处于实验阶段，需要通过 Node.js 运行

• 可以在配置文件中使用注释

• 尽量与 ESLint v8 的格式兼容

  如果未提供，Oxlint 将在当前工作目录中查找 .oxlintrc.json。

• --tsconfig=<./tsconfig.json> — TypeScript tsconfig.json 的路径，用于读取导入插件中的路径别名和项目引用。如果未提供，将在当前工作目录中查找 tsconfig.json。
• --init — 使用默认值初始化 oxlint 配置

允许 / 禁止多个检查规则

从命令行左侧向右侧累积规则和类别。

例如 -D correctness -A no-debugger 或 -A all -D no-debugger。类别包括：

• correctness - 明显错误或无用的代码（默认）
• suspicious - 很可能错误或无用的代码
• pedantic - 比较严格或偶尔会产生误报的检查规则
• perf - 可以以更高效方式编写的代码
• style - 应以更符合习惯的方式编写的代码
• restriction - 限制使用语言和库特性的检查规则
• nursery - 仍在开发中的新检查规则
• all - 列出以上所有类别，但不包含 nursery。不会自动启用插件。

参数说明：

• -A, --allow=NAME — 允许该规则或类别（抑制检查）
• -W, --warn=NAME — 禁止该规则或类别（发出警告）
• -D, --deny=NAME — 禁止该规则或类别（发出错误）

启用/禁用插件

• --disable-unicorn-plugin — 禁用 Unicorn 插件（默认开启）
• --disable-oxc-plugin — 禁用 oxc 特有的规则（默认开启）
• --disable-typescript-plugin — 禁用 TypeScript 插件（默认开启）
• --import-plugin — 启用导入插件并检测 ESM 问题。如果项目中使用非 tsconfig.json 名称的 tsconfig，应配合 --tsconfig 标志使用。
• --react-plugin — 启用 React 插件（默认关闭）
• --jsdoc-plugin — 启用 JSDoc 插件并检测 JSDoc 问题
• --jest-plugin — 启用 Jest 插件并检测测试问题
• --vitest-plugin — 启用 Vitest 插件并检测测试问题
• --jsx-a11y-plugin — 启用 JSX-a11y 插件并检测可访问性问题
• --nextjs-plugin — 启用 Next.js 插件并检测 Next.js 相关问题
• --react-perf-plugin — 启用 React 性能插件并检测渲染性能问题
• --promise-plugin — 启用 Promise 插件并检测 Promise 使用问题
• --node-plugin — 启用 Node 插件并检测 Node 用法问题
• --vue-plugin — 启用 Vue 插件并检测 Vue 用法问题

修复问题

• --fix — 尽可能修复问题。输出中仅报告尚未修复的问题。
• --fix-suggestions — 应用可自动修复的建议。可能会改变程序行为。
• --fix-dangerously — 应用危险的修复和建议

忽略文件

• --ignore-path=PATH — 指定用作 .eslintignore 的文件

• --ignore-pattern=PAT — 指定要忽略的文件模式（除了 .eslintignore 中定义的之外）

  支持的语法与 .eslintignore 和 .gitignore 文件相同。为避免 shell 对通配符模式的解释，请对模式加引号。

• --no-ignore — 禁用从 .eslintignore、--ignore-path 和 --ignore-pattern 指定的文件排除

处理警告

• --quiet — 禁用警告报告，仅报告错误
• --deny-warnings — 确保警告会导致非零退出码
• --max-warnings=INT — 指定警告阈值，可用于在项目中警告级别规则违规过多时强制以错误状态退出

输出格式

• -f, --format=ARG — 使用特定的输出格式。可用值：checkstyle, default, github, gitlab, json, junit, stylish, unix

杂项

• --silent — 不显示任何诊断信息
• --threads=INT — 使用的线程数。设置为 1 表示仅使用一个 CPU 核心。
• --print-config — 此选项输出将使用的配置。当此选项存在时，不会执行任何检查，且仅允许与配置相关的选项。

内联配置注释

• --report-unused-disable-directives — 报告如 // oxlint-disable-line 的指令注释，即使该行本就不会产生任何错误
• --report-unused-disable-directives-severity=SEVERITY — 与 --report-unused-disable-directives 相同，但允许指定报告错误的严重程度。这两个选项只能同时使用其中一个。

可用的位置参数：

• PATH — 单个文件、单个路径或路径列表

可用的选项：

• --rules — 列出当前注册的所有规则
• --lsp — 启动语言服务器
• --disable-nested-config — 禁用嵌套配置文件的自动加载
• --type-aware — 启用需要类型信息的规则
• --type-check — 启用实验性类型检查（包含 TypeScript 编译器诊断）
• -h, --help — 打印帮助信息
• -V, --version — 打印版本信息