Oxlint 配置文件

此配置与 ESLint v8 的配置模式（eslintrc.json）保持一致。

用法：oxlint -c oxlintrc.json

示例

.oxlintrc.json

json

{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "plugins": ["import", "typescript", "unicorn"],
  "env": {
    "browser": true
  },
  "globals": {
    "foo": "readonly"
  },
  "settings": {
    "react": {
      "version": "18.2.0"
    },
    "custom": {
      "option": true
    }
  },
  "rules": {
    "eqeqeq": "warn",
    "import/no-cycle": "error",
    "react/self-closing-comp": [
      "error",
      {
        "html": false
      }
    ]
  },
  "overrides": [
    {
      "files": ["*.test.ts", "*.spec.ts"],
      "rules": {
        "@typescript-eslint/no-explicit-any": "off"
      }
    }
  ]
}

oxlint.config.ts

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["import", "typescript", "unicorn"],
  env: {
    browser: true,
  },
  globals: {
    foo: "readonly",
  },
  settings: {
    react: {
      version: "18.2.0",
    },
    custom: { option: true },
  },
  rules: {
    eqeqeq: "warn",
    "import/no-cycle": "error",
    "react/self-closing-comp": ["error", { html: false }],
  },
  overrides: [
    {
      files: ["*.test.ts", "*.spec.ts"],
      rules: {
        "@typescript-eslint/no-explicit-any": "off",
      },
    },
  ],
});

$schema

类型：string

用于编辑器工具的 Schema URI。

env

类型：Record<string, boolean>

预定义全局变量。

环境指定了预定义的全局变量。请参阅 ESLint 的环境列表以了解可用环境及其各自提供的内容。

extends

类型：string[]

此配置文件扩展（继承自）的配置文件路径。文件路径是相对于包含 extends 属性的配置文件的位置解析的。配置文件从第一个到最后一个合并，最后一个文件覆盖之前的文件。

globals

类型：Record<string, string>

添加或移除全局变量。

对于每个全局变量，将相应的值设置为 "writable" 以允许变量被覆盖，或设置为 "readonly" 以禁止覆盖。

可以通过将全局变量的值设置为 "off" 来禁用它们。例如，在一个大多数 Es2015 全局变量可用但 Promise 不可用的环境中，你可以使用此配置：

json

{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "env": {
    "es6": true
  },
  "globals": {
    "Promise": "off"
  }
}

你也可以使用 "readable" 或 false 来表示 "readonly"，使用 "writeable" 或 true 来表示 "writable"。

ignorePatterns

类型：string[]

默认值：[]

linting 期间要忽略的 Glob 模式。这些模式是从配置文件路径解析的。

jsPlugins

类型：array

JS 插件，允许在 Oxlint 中使用 ESLint 插件。

在文档中了解更多关于 JS 插件的信息。

注意：JS 插件处于 alpha 阶段，不受语义版本控制约束。

示例：

使用本地插件路径的基本用法。

json

{
  "jsPlugins": ["./custom-plugin.js"],
  "rules": {
    "custom/rule-name": "warn"
  }
}

使用 TypeScript 插件和本地插件路径的基本用法。

TypeScript 插件文件在以下环境中受支持：

Deno 和 Bun：原生支持 TypeScript 文件。
Node.js >=22.18.0 和 Node.js ^20.19.0：原生支持 TypeScript 文件，默认启用内置的类型剥离功能。

对于较旧版本的 Node.js，不支持 TypeScript 插件。请使用 JavaScript 插件或升级你的 Node 版本。

json

{
  "jsPlugins": ["./custom-plugin.ts"],
  "rules": {
    "custom/rule-name": "warn"
  }
}

通过给 JS 插件设置别名，将内置的 Rust 插件与同名的 JS 插件一起使用。

json

{
  "plugins": ["import"],
  "jsPlugins": [{ "name": "import-js", "specifier": "eslint-plugin-import" }],
  "rules": {
    "import/no-cycle": "error",
    "import-js/no-unresolved": "warn"
  }
}

jsPlugins[n]

类型：object | string

jsPlugins[n].name

类型：string

插件的自定义名称/别名。

注意：以下插件名称被保留，因为它们在 oxlint 中是以 Rust 原生实现的，不能用于 JS 插件：

react (includes react-hooks)
unicorn
typescript (includes @typescript-eslint)
oxc
import (includes import-x)
jsdoc
jest
vitest
jsx-a11y
nextjs
react-perf
promise
node
vue
eslint

如果你需要使用其中任何插件的 JavaScript 版本，请提供自定义别名以避免冲突。

jsPlugins[n].specifier

类型：string

插件的路径或包名

options

类型：object

linting 工具的选项。

options.denyWarnings

类型：boolean

确保警告产生非零退出代码。

等同于在 CLI 上传递 --deny-warnings。

options.maxWarnings

类型：integer

指定警告阈值。如果警告超过此值，则以错误状态退出。

等同于在 CLI 上传递 --max-warnings。

options.reportUnusedDisableDirectives

报告未使用的禁用指令（例如 // oxlint-disable-line 或 // eslint-disable-line）。

等同于在 CLI 上传递 --report-unused-disable-directives-severity。当两者都设置时，CLI 标志优先于此值。仅在根配置文件中支持。

options.typeAware

类型：boolean

启用需要类型信息的规则。

等同于在 CLI 上传递 --type-aware。

注意，这需要安装 oxlint-tsgolint 包。

options.typeCheck

类型：boolean

启用实验性类型检查（包括 TypeScript 编译器诊断）。

等同于在 CLI 上传递 --type-check。

注意，这需要安装 oxlint-tsgolint 包。

overrides

类型：array

overrides[n]

类型：object

overrides[n].env

类型：object

环境启用和禁用全局变量集合。

overrides[n].files

类型：string[]

一组 glob 模式。

overrides[n].globals

类型：object

启用或禁用特定的全局变量。

overrides[n].jsPlugins

类型：array

此覆盖的 JS 插件，允许在 Oxlint 中使用 ESLint 插件。

在文档中了解更多关于 JS 插件的信息。

注意：JS 插件处于 alpha 阶段，不受语义版本控制约束。

overrides[n].jsPlugins[n]

类型：object | string

overrides[n].jsPlugins[n].name

类型：string

插件的自定义名称/别名。

注意：以下插件名称被保留，因为它们在 oxlint 中是以 Rust 原生实现的，不能用于 JS 插件：

react (includes react-hooks)
unicorn
typescript (includes @typescript-eslint)
oxc
import (includes import-x)
jsdoc
jest
vitest
jsx-a11y
nextjs
react-perf
promise
node
vue
eslint

如果你需要使用其中任何插件的 JavaScript 版本，请提供自定义别名以避免冲突。

overrides[n].jsPlugins[n].specifier

类型：string

插件的路径或包名

overrides[n].plugins

类型：array

默认值：null

可选地更改为此覆盖启用的插件。省略时，使用基础配置的插件。

overrides[n].plugins[n]

overrides[n].rules

类型：object

请参阅 Oxlint 规则

plugins

类型：array

默认值：null

为 Oxlint 启用的内置插件。你可以在网站上查看可用插件列表。

注意：设置 plugins 字段将覆盖基础插件集。plugins 数组应反映你想要使用的所有插件。

plugins[n]

rules

类型：object

请参阅 Oxlint 规则

settings

类型：object

配置 linting 插件的行为。

如果你在 monorepo 中使用 Next.js，这是一个示例：

json

{
  "settings": {
    "next": {
      "rootDir": "apps/dashboard/"
    },
    "react": {
      "linkComponents": [
        {
          "name": "Link",
          "linkAttribute": "to"
        }
      ]
    },
    "jsx-a11y": {
      "components": {
        "Link": "a",
        "Button": "button"
      }
    }
  }
}

settings.jsdoc

类型：object

settings.jsdoc.augmentsExtendsReplacesDocs

类型：boolean

默认值：false

settings.jsdoc.exemptDestructuredRootsFromChecks

类型：boolean

默认值：false

仅适用于 require-param-type 和 require-param-description 规则

settings.jsdoc.ignoreInternal

类型：boolean

默认值：false

适用于所有规则，但不适用于 empty-tags 规则

settings.jsdoc.ignorePrivate

类型：boolean

默认值：false

适用于所有规则，但不适用于 check-access 和 empty-tags 规则

settings.jsdoc.ignoreReplacesDocs

类型：boolean

默认值：true

settings.jsdoc.implementsReplacesDocs

类型：boolean

默认值：false

settings.jsdoc.overrideReplacesDocs

类型：boolean

默认值：true

settings.jsdoc.tagNamePreference

类型：object

默认值：{}

类型：object

配置 JSX A11y 插件规则。

请参阅 eslint-plugin-jsx-a11y 的配置以获取完整参考。

类型：Record<string, array>

默认值：{}

属性名称到其 DOM 等效项的映射。这对于使用不同属性名称的非 React 框架很有用。

示例：

json

{
  "settings": {
    "jsx-a11y": {
      "attributes": {
        "for": ["htmlFor", "for"]
      }
    }
  }
}

类型：Record<string, string>

默认值：{}

为了让你的自定义组件作为 DOM 元素进行检查，你可以提供组件名称到 DOM 元素名称的映射。

示例：

json

{
  "settings": {
    "jsx-a11y": {
      "components": {
        "Link": "a",
        "IconButton": "button"
      }
    }
  }
}

类型：string

一个可选设置，定义你的代码用于创建多态组件的 prop。此设置将用于确定需要语义上下文的规则中的元素类型。

例如，如果你将 polymorphicPropName 设置为 as，则此元素：

jsx

<Box as="h3">Hello</Box>

将被视为 h3。如果未设置，此组件将被视为 Box。

settings.next

类型：object

配置 Next.js 插件规则。

settings.next.rootDir

类型：array | string

settings.next.rootDir[n]

类型：string

settings.react

类型：object

配置 React 插件规则。

源自 eslint-plugin-react

settings.react.componentWrapperFunctions

类型：string[]

默认值：[]

包装 React 组件并应被视为 HOC 的函数。

示例：

jsonc

{
  "settings": {
    "react": {
      "componentWrapperFunctions": ["observer", "withRouter"],
    },
  },
}

settings.react.formComponents

类型：array

默认值：[]

用作 <form> 替代方案的表单组件，例如 <Formik>。

示例：

jsonc

{
  "settings": {
    "react": {
      "formComponents": [
        "CustomForm",
        // OtherForm 被视为表单组件并具有一个 endpoint 属性
        { "name": "OtherForm", "formAttribute": "endpoint" },
        // 允许在必要时指定多个属性
        { "name": "Form", "formAttribute": ["registerEndpoint", "loginEndpoint"] },
      ],
    },
  },
}

settings.react.formComponents[n]

类型：object | string

settings.react.formComponents[n].attribute

类型：string

settings.react.formComponents[n].name

类型：string

settings.react.linkComponents

类型：array

默认值：[]

用作 <a> 替代方案的链接组件，例如 <Link>。

示例：

jsonc

{
  "settings": {
    "react": {
      "linkComponents": [
        "HyperLink",
        // 对于使用与 `href` 不同 prop 名称的组件，使用 `linkAttribute`。
        { "name": "MyLink", "linkAttribute": "to" },
        // 允许在必要时指定多个属性
        { "name": "Link", "linkAttribute": ["to", "href"] },
      ],
    },
  },
}

settings.react.linkComponents[n]

类型：object | string

settings.react.linkComponents[n].attribute

类型：string

settings.react.linkComponents[n].name

类型：string

settings.react.version

类型：string

默认值：null

用于特定版本规则的 React 版本。

接受语义化版本（例如，"18.2.0", "17.0"）。

示例：

jsonc

{
  "settings": {
    "react": {
      "version": "18.2.0",
    },
  },
}

settings.vitest

类型：object

配置 Vitest 插件规则。

请参阅 eslint-plugin-vitest 的配置以获取完整参考。

settings.vitest.typecheck

类型：boolean

默认值：false

是否为 Vitest 规则启用 typecheck 模式。启用后，某些规则将跳过对 describe 块的某些检查，以适应 TypeScript 类型检查场景。

Oxlint 配置文件 ​

$schema ​

categories ​

categories.correctness ​

categories.nursery ​

categories.pedantic ​

categories.perf ​

categories.restriction ​

categories.style ​

categories.suspicious ​

env ​

extends ​

globals ​

ignorePatterns ​

jsPlugins ​

jsPlugins[n] ​

jsPlugins[n].name ​

jsPlugins[n].specifier ​

options ​

options.denyWarnings ​

options.maxWarnings ​

options.reportUnusedDisableDirectives ​

options.typeAware ​

options.typeCheck ​

overrides ​

overrides[n] ​

overrides[n].env ​

overrides[n].files ​

overrides[n].globals ​

overrides[n].jsPlugins ​

overrides[n].jsPlugins[n] ​

overrides[n].jsPlugins[n].name ​

overrides[n].jsPlugins[n].specifier ​

overrides[n].plugins ​

overrides[n].plugins[n] ​

overrides[n].rules ​

plugins ​

plugins[n] ​

rules ​

settings ​

settings.jsdoc ​

settings.jsdoc.augmentsExtendsReplacesDocs ​

settings.jsdoc.exemptDestructuredRootsFromChecks ​

settings.jsdoc.ignoreInternal ​

settings.jsdoc.ignorePrivate ​

settings.jsdoc.ignoreReplacesDocs ​

settings.jsdoc.implementsReplacesDocs ​

settings.jsdoc.overrideReplacesDocs ​

settings.jsdoc.tagNamePreference ​

settings.jsx-a11y ​

settings.jsx-a11y.attributes ​

settings.jsx-a11y.components ​

settings.jsx-a11y.polymorphicPropName ​

settings.next ​

settings.next.rootDir ​

settings.next.rootDir[n] ​

settings.react ​

settings.react.componentWrapperFunctions ​

settings.react.formComponents ​

settings.react.formComponents[n] ​

settings.react.formComponents[n].attribute ​

settings.react.formComponents[n].name ​

settings.react.linkComponents ​

settings.react.linkComponents[n] ​

settings.react.linkComponents[n].attribute ​

settings.react.linkComponents[n].name ​

settings.react.version ​

settings.vitest ​

settings.vitest.typecheck ​

Oxlint 配置文件

$schema

categories

categories.correctness

categories.nursery

categories.pedantic

categories.perf

categories.restriction

categories.style

categories.suspicious

env

extends

globals

ignorePatterns

jsPlugins

jsPlugins[n]

jsPlugins[n].name

jsPlugins[n].specifier

options

options.denyWarnings

options.maxWarnings

options.reportUnusedDisableDirectives

options.typeAware

options.typeCheck

overrides

overrides[n]

overrides[n].env

overrides[n].files

overrides[n].globals

overrides[n].jsPlugins

overrides[n].jsPlugins[n]

overrides[n].jsPlugins[n].name

overrides[n].jsPlugins[n].specifier

overrides[n].plugins

overrides[n].plugins[n]

overrides[n].rules

plugins

plugins[n]

rules

settings

settings.jsdoc

settings.jsdoc.augmentsExtendsReplacesDocs

settings.jsdoc.exemptDestructuredRootsFromChecks

settings.jsdoc.ignoreInternal

settings.jsdoc.ignorePrivate

settings.jsdoc.ignoreReplacesDocs

settings.jsdoc.implementsReplacesDocs

settings.jsdoc.overrideReplacesDocs

settings.jsdoc.tagNamePreference

settings.jsx-a11y

settings.jsx-a11y.attributes

settings.jsx-a11y.components

settings.jsx-a11y.polymorphicPropName

settings.next

settings.next.rootDir

settings.next.rootDir[n]

settings.react

settings.react.componentWrapperFunctions

settings.react.formComponents

settings.react.formComponents[n]

settings.react.formComponents[n].attribute

settings.react.formComponents[n].name

settings.react.linkComponents

settings.react.linkComponents[n]

settings.react.linkComponents[n].attribute

settings.react.linkComponents[n].name

settings.react.version

settings.vitest

settings.vitest.typecheck