Skip to content

docs(linter/plugins): update JS plugins API support #723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
camc314 merged 2 commits into from
Dec 22, 2025
Merged

docs(linter/plugins): update JS plugins API support #723

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
930323a
docs(linter/plugins): update JS plugins API support
overlookmotel Dec 22, 2025
4c512c5
Update js-plugins.md
camc314 Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions src/docs/guide/usage/linter/js-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ outline: deep

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

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

We are working towards implementing _all_ of ESLint's plugin APIs, and Oxlint will eventually be able to run
We are working towards implementing _all_ of ESLint's plugin APIs, and Oxlint will soon be able to run
_any_ ESLint plugin.

:::warning
JS plugins are currently in technical preview, and remain under heavy development.
Not all of ESLint's plugin API is implemented yet (see [here](#api-support)).
Almost all of ESLint's plugin API is implemented (see [here](#api-support)).

All APIs which _are_ implemented should behave identically to ESLint. If you find any differences in behavior,
All APIs should behave identically to ESLint. If you find any differences in behavior,
that's a bug - please [report it](https://github.com/oxc-project/oxc/issues/new?template=linter_bug_report.yaml).
:::

Expand Down Expand Up @@ -361,7 +361,7 @@ Rust-JS interop comes into play.

## API support

Oxlint supports most of ESLint's API surface:
Oxlint supports almost all of ESLint's API surface:

- AST traversal.
- AST exploration (`node.parent`, `context.sourceCode.getAncestors`).
Expand All @@ -371,13 +371,12 @@ Oxlint supports most of ESLint's API surface:
- `SourceCode` APIs (e.g. `context.sourceCode.getText(node)`).
- `SourceCode` tokens APIs (e.g. `context.sourceCode.getTokens(node)`).
- Scope analysis.
- Control flow analysis (code paths).

Not supported yet:

- Language server (IDE) support.
- Suggestions.
- Control flow analysis.
- Custom file formats (e.g. Svelte, Vue, Angular).
- Language server (IDE) support + suggestions.
- Custom file formats and parsers (e.g. Svelte, Vue, Angular).

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