oxlint

Only for require-(yields|returns|description|example|param|throws) rule

Only for require-param-type and require-param-description rule

For all rules but NOT apply to empty-tags rule

For all rules but NOT apply to check-access and empty-tags rule

Only for require-(yields|returns|description|example|param|throws) rule

Only for require-(yields|returns|description|example|param|throws) rule

Only for require-(yields|returns|description|example|param|throws) rule

Map of attribute names to their DOM equivalents. This is useful for non-React frameworks that use different attribute names.

Example:

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

To have your custom components be checked as DOM elements, you can provide a mapping of your component names to the DOM element name.

Example:

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

An optional setting that define the prop your code uses to create polymorphic components. This setting will be used to determine the element type in rules that require semantic context.

For example, if you set the polymorphicPropName to as, then this element:

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

Will be treated as an h3. If not set, this component will be treated as a Box.

The root directory of the Next.js project.

This is particularly useful when you have a monorepo and your Next.js project is in a subfolder.

Example:

{
"settings": {
"next": {
"rootDir": "apps/dashboard/"
}
}
}

Ensure warnings produce a non-zero exit code.

Equivalent to passing --deny-warnings on the CLI.

Specify a warning threshold. Exits with an error status if warnings exceed this value.

Equivalent to passing --max-warnings on the CLI.

Report unused disable directives (e.g. // oxlint-disable-line or // eslint-disable-line).

Equivalent to passing --report-unused-disable-directives-severity on the CLI. CLI flags take precedence over this value when both are set. Only supported in the root configuration file.

Enable rules that require type information.

Equivalent to passing --type-aware on the CLI.

Note that this requires the oxlint-tsgolint package to be installed.

Enable experimental type checking (includes TypeScript compiler diagnostics).

Equivalent to passing --type-check on the CLI.

Note that this requires the oxlint-tsgolint package to be installed.

A list of glob patterns to override.

Example

[ "*.test.ts", "*.spec.ts" ]

Environments enable and disable collections of global variables.

Enabled or disabled specific global variables.

JS plugins for this override, allows usage of ESLint plugins with Oxlint.

Read more about JS plugins in the docs.

Note: JS plugins are in alpha and not subject to semver.

Optionally change what plugins are enabled for this override. When omitted, the base config's plugins are used.

Functions that wrap React components and should be treated as HOCs.

Example:

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

Components used as alternatives to <form> for forms, such as <Formik>.

Example:

{
"settings": {
"react": {
"formComponents": [
"CustomForm",
// OtherForm is considered a form component and has an endpoint attribute
{ "name": "OtherForm", "formAttribute": "endpoint" },
// allows specifying multiple properties if necessary
{ "name": "Form", "formAttribute": ["registerEndpoint", "loginEndpoint"] }
]
}
}
}

Components used as alternatives to <a> for linking, such as <Link>.

Example:

{
"settings": {
"react": {
"linkComponents": [
"HyperLink",
// Use `linkAttribute` for components that use a different prop name
// than `href`.
{ "name": "MyLink", "linkAttribute": "to" },
// allows specifying multiple properties if necessary
{ "name": "Link", "linkAttribute": ["to", "href"] }
]
}
}
}

React version to use for version-specific rules.

Accepts semver versions (e.g., "18.2.0", "17.0").

Example:

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

Whether to enable typecheck mode for Vitest rules. When enabled, some rules will skip certain checks for describe blocks to accommodate TypeScript type checking scenarios.