命令行接口

🌐 Command-line Interface

用法

🌐 Usage

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

基本配置

🌐 Basic Configuration

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

• 仅支持 .json 扩展

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

• 尝试与 ESLint v8 的格式兼容

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

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

允许 / 拒绝多个 Lint

🌐 Allowing / Denying Multiple Lints

在命令行上从左到右累积规则和类别。

🌐 Accumulate rules and categories from left to right on the command-line.

例如 -D correctness -A no-debugger 或 -A all -D no-debugger。分类如下：

🌐 For example -D correctness -A no-debugger or -A all -D no-debugger. The categories are:

• correctness - 完全错误或无用的代码（默认）
• suspicious - 很可能错误或无用的代码
• pedantic - 较严格或偶尔会产生假阳性的代码检查
• perf - 可以用更高效的方式编写的代码
• style - 应该以更地道的方式编写的代码
• restriction - 防止使用语言和库功能的代码检查
• nursery - 正在开发中的新 lint
• all - 上面列出的所有类别，除了 nursery。不会自动启用插件。

参数：

🌐 Arguments:

• -A、--allow=NAME — 允许该规则或类别（抑制警告）
• '-W'， '--warn'='NAME' — 拒绝该规则或类别（发出警告）
• '-D'， '--deny'='NAME' — 拒绝该规则或类别（发出错误）

启用/禁用插件

🌐 Enable/Disable Plugins

• --disable-unicorn-plugin — 禁用默认开启的独角兽插件
• --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 — 启用节点插件并检测节点使用问题
• --vue-plugin — 启用 Vue 插件并检测 Vue 使用问题

解决问题

🌐 Fix Problems

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

忽略文件

🌐 Ignore Files

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

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

  支持的语法与 .eslintignore 和 .gitignore 文件相同。你应该用引号括起你的模式，以避免 shell 对通配符模式的解释。

• --no-ignore — 禁用从 .eslintignore 文件、--ignore-path 标志和 --ignore-pattern 标志中排除文件

处理警告

🌐 Handle Warnings

• --quiet — 禁用警告报告，只报告错误
• --deny-warnings — 确保警告产生非零退出代码
• --max-warnings=INT — 指定警告阈值，如果项目中存在过多警告级别的规则违规，可以用于强制以错误状态退出

输出

🌐 Output

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

其他

🌐 Miscellaneous

• --silent — 不显示任何诊断信息
• --threads=INT — 使用的线程数量。设置为 1 表示仅使用 1 个 CPU 核心。
• --print-config — 此选项用于输出要使用的配置。启用时，不会执行任何代码检查，并且只有与配置相关的选项是有效的。

行内配置注释

🌐 Inline Configuration Comments

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

可用位置物品：

🌐 Available positional items:

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

可用选项：

🌐 Available options:

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