Built-in Plugins

Oxlint includes built in implementations of many popular ESLint plugin rule sets. Most rules in the recommended configs are already implemented, so you can get useful results without extra setup.

Oxlint also supports plugins written in JavaScript with an ESLint compatible API. See JS Plugins.

What a plugin means in Oxlint

A plugin is a named group of rules. Enabling a plugin makes its rules available, and category flags control which rules are enabled and at what severity.

If you are migrating from ESLint, plugins map to the ecosystems you already know, such as import, react, jsx a11y, jest, unicorn, and more.

Enable a plugin

Enable with the CLI

Enable a plugin using a --<plugin-name>-plugin flag.

Example, enable the import plugin:

oxlint --import-plugin

Once enabled, category flags determine what is turned on.

Example, enable import plugin rules in the correctness category as errors and suspicious as warnings:

oxlint --import-plugin -D correctness -W suspicious

Correctness rules are enabled by default.

Tip: run oxlint --help to see the full list of plugin flags.

Enable in a config file

You can also enable plugins in .oxlintrc.json using the plugins field:

{
  "plugins": ["import"]
}

Setting plugins overwrites the default plugin set. The list should include every plugin you want enabled.

Disable default plugins

Several plugins are enabled by default. You can disable a default plugin with --disable-<plugin-name>-plugin.

Example, disable unicorn:

oxlint --disable-unicorn-plugin

Only default plugins support being disabled. Non default plugins can simply be omitted.

Disable default plugins in a config file

To disable all default plugins in a config file, set plugins to an empty array:

{
  "plugins": []
}

This disables all default plugins and uses only the base rule set.

Supported plugins

This table lists the built in plugins and where they come from.

Plugin name	Default	Source
eslint	Yes	ESLint core rules
typescript	Yes	TypeScript rules from the typescript eslint ecosystem. Type aware rules are available in alpha using the type aware mode
unicorn	Yes	eslint plugin unicorn
react	No	eslint plugin react and eslint plugin react hooks
react-perf	No	eslint plugin react perf
nextjs	No	eslint plugin next
oxc	Yes	Oxc specific rules and selected rules ported from deepscan
import	No	eslint plugin import
jsdoc	No	eslint plugin jsdoc
jsx-a11y	No	eslint plugin jsx a11y
node	No	eslint plugin n
promise	No	eslint plugin promise
jest	No	eslint plugin jest
vitest	No	eslint plugin vitest
vue	No	eslint plugin vue rules that work with script tags

For the current status of rule coverage, see the linter product plan issue.

Adding new plugins

Oxlint focuses on supporting the ecosystem through built in plugins and ESLint compatible JavaScript plugins. Contributions that add rules to existing built in plugins are encouraged.

If you think a rule set should be implemented as a built in plugin, open a discussion first.