命令行界面
使用
oxlint [-c=<./oxlintrc.json>] [PATH]...
基本配置
-c,--config=<./oxlintrc.json>— Oxlint 配置文件（实验性）
- 仅支持
.json扩展名 - 尝试兼容 ESLint v8 的格式
--tsconfig=<./tsconfig.json>— TypeScripttsconfig.json路径，用于读取导入插件的路径别名和项目引用
允许 / 拒绝多重 Lints
从左到右累积命令行上的规则和类别。
例如 -D correctness -A no-debugger 或 -A all -D no-debugger。类别有
correctness- 完全错误或无用的代码（默认）。suspicious- 很有可能错误或无用的代码。pedantic- 相当严格的 Lint，偶尔会出现误报。style- 应该以更习惯的方式编写的代码。nursery- 仍处于开发中的新 Lint。restriction- 阻止使用语言和库功能的 Lint。all- nursery 之外的所有上述类别。不会自动启用插件。
参数
-A,--allow=NAME— 允许规则或类别（抑制 Lint）-W,--warn=NAME— 拒绝规则或类别（发出警告）-D,--deny=NAME— 拒绝规则或类别（发出错误）
启用插件
--disable-react-plugin— 禁用 react 插件，默认为启用--disable-unicorn-plugin— 禁用 unicorn 插件，默认为启用--disable-oxc-plugin— 禁用 oxc 唯一规则，默认为启用--disable-typescript-plugin— 禁用 TypeScript 插件，默认为启用--import-plugin— 启用实验性导入插件并检测 ESM 问题。建议与选项--tsconfig结合使用。--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 使用问题--security-plugin— 启用安全插件并检测安全问题
修复问题
--fix— 尽可能多地修复问题。输出中只报告未修复的问题--fix-suggestions— 应用可自动修复的建议。可能会改变程序行为。--fix-dangerously— 应用危险的修复和建议。
忽略文件
--ignore-path=PATH— 指定要作为 .eslintignore 的文件--ignore-pattern=PAT— 指定要忽略的文件模式（除了 .eslintignore 中的文件模式外）支持的语法与 .eslintignore 和 .gitignore 文件相同。应引用模式以避免 shell 对全局模式的解释
--no-ignore— 禁用从 .eslintignore 文件、--ignore-path标志和--ignore-pattern标志排除文件--symlinks— 遵循符号链接。Oxlint 默认会忽略符号链接。
处理警告
--quiet— 禁用报告警告，只报告错误--deny-warnings— 确保警告产生一个非零退出代码--max-warnings=INT— 指定警告阈值，可用于在项目中存在过多警告级规则违规时强制退出并显示错误状态
输出
-f,--format=ARG— 使用特定输出格式（默认值、json、unix、checkstyle、github）
其他
--silent— 不显示任何诊断--threads=INT— 要使用的线程数。设置为 1 表示仅使用 1 个 CPU 核心--print-config— 此选项输出要使用的配置。此选项存在时，不执行任何 Linting，并且只有与配置相关的选项有效。
可用的位置项目：
PATH— 单个文件、单个路径或路径列表
可用的选项：
--rules— 列出当前已注册的所有规则-h,--help— 打印帮助信息-V,--version— 打印版本信息