Plugins
Oxlint supports several of the most popular ESLint plugins out of the box with most rules in recommended
configs already implemented.
WARNING
Oxlint does not support custom plugins at this time. We have plans to implement this in the future. You can track its status on our backlog.
Enabling Plugins
You can enable plugins using the --<plugin-name>-plugin
CLI flag. For example, to enable eslint-plugin-import
, run
oxlint --import-plugin
Once enabled, rules in categories you have enabled will automatically be turned on. For example,
oxlint --import-plugin -W correctness -W suspicious
Will enable all correctness
and suspicious
rules in the import
plugin, as well as the base rule set. Note that correctness
rules are turned on by default.
Disabling Plugins
Several plugins are enabled by default, and are listed below. You can disable them with the --no-<plugin-name>-plugin
flag. For example, to disable eslint-plugin-unicorn
, run:
oxlint --no-unicorn-plugin
INFO
run oxlint --help
to see a full list of flags to enable or disable plugins.
Supported Plugins
INFO
You can also find this information on the linter product plan
issue on GitHub.
Plugin Name | Default? | Issue | Notes |
---|---|---|---|
typescript-eslint | ✅ | #2180 | Typescript-specific rules from @typescript-eslint/eslint-plugin . We do not support type-aware rules at this time. |
eslint-plugin-unicorn | ✅ | #684 | |
eslint-plugin-react | ✅ | #1022 | |
eslint-plugin-react-hooks | ✅ | #2174 | |
eslint-plugin-react-perf | #2041 | ||
eslint-plugin-next | #1929 | ||
oxc | ✅ | N/A | Custom oxc-specific rules, as well as some rules ported from deepscan |
oxc-security | N/A | Custom oxc-specific security and vulnerability detection rules. | |
eslint-plugin-import | #1117 | ||
eslint-plugin-jsdoc | #1170 | ||
eslint-plugin-jsx-a11y | #1141 | ||
eslint-plugin-n | #493 | Rules use node as the plugin prefix (e.g. node/no-exports-assign | |
eslint-plugin-promise | #4655 | ||
eslint-plugin-jest | #492 | ||
eslint-plugin-vitest | #4656 |
Adding New Plugins
Do you have a favorite ESLint plugin that you'd like to see supported in Oxlint? Please open a feature request. Please be aware that we have no plans on supporting rules in plugins that require special parsers, such as eslint-plugin-vue
and eslint-plugin-svelte
, though we are open to supporting rules in these plugins that only affect script tags in their source files.