Skip to content

docs(oxlint): update JS plugins API support #683

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

Open
overlookmotel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(oxlint): update JS plugins API support #683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 4 additions & 9 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 @@ -339,12 +339,7 @@ Rust-JS interop comes into play.

## API support

Oxlint supports most of the APIs typically used in plugins/rules which rely on AST inspection.
That includes most "fix code"-type rules.

It does not yet support token-based APIs, so stylistic (formatting) rules will not work yet.

Supported:
Oxlint supports most of ESLint's API surface:

- AST traversal.
- AST exploration (`node.parent`, `context.sourceCode.getAncestors`).
Expand All @@ -354,13 +349,13 @@ Supported:
- `SourceCode` APIs (e.g. `context.sourceCode.getText(node)`).
- `SourceCode` tokens APIs (e.g. `context.sourceCode.getTokens(node)`).
- Scope analysis.
- Plugins written in TypeScript (with NodeJS 22.18.0+).

Not supported yet:

- Language server (IDE) support.
- Suggestions.
- Control flow analysis.
- Globals.
Copy link
Contributor

@connorshea connorshea Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is out of date now isn't it? :)

- Custom file formats (e.g. Svelte, Vue, Angular).

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