内置插件
Oxlint 包含许多流行 ESLint 插件规则集的内置实现。recommended 配置中的大多数规则已经实现,因此您可以无需额外设置就获得有用的结果。
Oxlint 也支持使用与 ESLint 兼容的 API 编写的 JavaScript 插件。参见 JS 插件。
插件在 Oxlint 中的含义
插件是一组命名的规则。启用插件使其规则可用,类别标志控制启用哪些规则以及以什么严重程度启用。
如果您正在从 ESLint 迁移,插件映射到您已经了解的生态系统,如 import、react、jsx-a11y、jest、unicorn 等。
启用插件
强烈建议使用配置文件启用插件,因为这样可以更容易地在项目中管理和与其他开发者共享。
在配置文件中启用
您可以在配置文件中使用 plugins 字段启用插件:
{
"plugins": ["import"]
}import { defineConfig } from "oxlint";
export default defineConfig({
plugins: ["import"],
});设置 plugins 会覆盖默认插件集。列表应包含您想启用的每个插件。
使用 CLI 启用
您也可以使用 --<plugin-name>-plugin CLI 标志启用插件。
例如,启用 import 插件:
oxlint --import-plugin启用后,类别标志决定启用哪些规则。
例如,启用 import 插件的 correctness 类别规则为错误,suspicious 为警告:
oxlint --import-plugin -D correctness -W suspiciousCorrectness 规则默认启用。
提示:运行 oxlint --help 查看完整的插件标志列表。
禁用默认插件
在配置文件中禁用默认插件
要在配置文件中禁用所有默认插件,将 plugins 设置为空数组:
{
"plugins": []
}import { defineConfig } from "oxlint";
export default defineConfig({
plugins: [],
});这会禁用所有默认插件,只使用基础规则集。
使用 CLI 禁用默认插件
有几个插件默认启用。您可以使用 --disable-<plugin-name>-plugin 禁用默认插件。
例如,禁用 unicorn:
oxlint --disable-unicorn-plugin只有默认插件支持被禁用。非默认插件可以直接省略。
支持的插件
此表列出内置插件及其来源。
| 插件名 | 默认 | 来源 |
|---|---|---|
eslint | 是 | ESLint 核心规则 |
typescript | 是 | 来自 typescript-eslint 的 TypeScript 规则(即 @typescript-eslint/plugin)。类型感知规则可通过类型感知模式使用。 |
unicorn | 是 | eslint-plugin-unicorn |
react | 否 | eslint-plugin-react、eslint-plugin-react-hooks 和 eslint-plugin-react-refresh |
react-perf | 否 | eslint-plugin-react-perf |
nextjs | 否 | @next/eslint-plugin-next |
oxc | 是 | Oxc 特定规则和从 deepscan 移植的选定规则 |
import | 否 | eslint-plugin-import(也等同于 eslint-plugin-import-x) |
jsdoc | 否 | eslint-plugin-jsdoc |
jsx-a11y | 否 | eslint-plugin-jsx-a11y |
node | 否 | eslint-plugin-n |
promise | 否 | eslint-plugin-promise |
jest | 否 | eslint-plugin-jest |
vitest | 否 | @vitest/eslint-plugin 即 eslint-plugin-vitest |
vue | 否 | eslint-plugin-vue 适用于 script 标签的规则 |
有关规则覆盖的当前状态,请参阅 linter 产品计划 issue。有关框架和文件类型支持,请参阅兼容性矩阵。
添加新插件
Oxlint 专注于通过内置插件和与 ESLint 兼容的 JavaScript 插件来支持生态系统。欢迎贡献规则到现有的内置插件。
如果您认为某个规则集应该作为内置插件实现,请先开启 GitHub 讨论。