JS Plugins

Oxlint supports plugins written in JS - either custom-written, or from npm.

Oxlint's plugin API is compatible with ESLint v9+, so most existing ESLint plugins should work out of the box with Oxlint.

Almost the entirety of ESLint's plugin API is now implemented (see below), so most existing ESLint plugins should work out of the box.

INFO

JS plugins are currently in alpha, and remain under active development.

All APIs should behave identically to ESLint. If you find any differences in behavior, that's a bug - please report it.

Using JS plugins

1. Add a path to the plugin to the .oxlintrc.json config file, under jsPlugins.
2. Add rules from the plugin, under rules.

The path can be any valid import specifier e.g. ./plugin.js, eslint-plugin-foo, or @foo/eslint-plugin. Paths are resolved relative to the config file itself.

// .oxlintrc.json
{
  "jsPlugins": ["./path/to/my-plugin.js", "eslint-plugin-whatever", "@foobar/eslint-plugin"],
  "rules": {
    "my-plugin/rule1": "error",
    "my-plugin/rule2": "warn",
    "whatever/rule1": "error",
    "whatever/rule2": "warn",
    "@foobar/rule1": "error"
  }
  // ... other config ...
}

Plugin aliases

You can also define a different name (alias) for a plugin. This is useful if:

• The default plugin name clashes with name of a native Oxlint plugin (e.g. jsdoc, react, etc.).
• The default plugin name is very long.
• You want to use a plugin that Oxlint supports natively, but a specific rule you need is not yet implemented in Oxlint's native version.

{
  "jsPlugins": [
    // `jsdoc` is a reserved name, as Oxlint supports it natively
    {
      "name": "jsdoc-js",
      "specifier": "eslint-plugin-jsdoc"
    },
    // Shorten name
    {
      "name": "short",
      "specifier": "eslint-plugin-with-name-so-very-very-long"
    },
    // List plugins you don't want to alias as just specifiers
    "eslint-plugin-whatever"
  ],
  "rules": {
    "jsdoc-js/check-alignment": "error",
    "short/rule1": "error",
    "whatever/rule2": "error"
  }
}

See the Writing JS Plugins page for information on writing your own JS plugins and custom rules for Oxlint.

API Support

Oxlint supports almost all of ESLint's API surface:

• AST traversal.
• AST exploration (node.parent, context.sourceCode.getAncestors).
• Fixes.
• Rule options.
• Selectors (ESLint docs).
• SourceCode APIs (e.g. context.sourceCode.getText(node)).
• SourceCode tokens APIs (e.g. context.sourceCode.getTokens(node)).
• Scope analysis.
• Control flow analysis (code paths).
• Inline disable directives. (// oxlint-disable)
• Language server (IDE) support + suggestions (in-editor diagnostics and quick-fixes)

Not supported yet:

• Custom file formats and parsers (e.g. Svelte, Vue, Angular).
• Lint rules that rely on TypeScript type-awareness.

ESLint APIs that were removed in ESLint v9 or earlier will not be implemented in most cases. If an ESLint plugin is unmaintained and was never updated to upgrade their API usage for ESLint v9, you may need to modify the plugin yourself or find an alternative.

We will be implementing the remaining features over the next few months, aiming to support 100% of ESLint's plugin API surface.