Skip to content

Commit 7813b2a

Browse files
docs(oxlint): update JS plugins API support (#683)
Update list of supported/unsupported features in docs for Oxlint JS plugins. It had got out of date. Notably it still said that we don't support token-based APIs, which we now do. I added custom file formats to the "unsupported" section. I've also removed plugins-written-in-TS from the "supported" section, because it only *kind of* works - the types are a bit of a mess.
1 parent beb10f9 commit 7813b2a

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

src/docs/guide/usage/linter/js-plugins.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -339,12 +339,7 @@ Rust-JS interop comes into play.
339339

340340
## API support
341341

342-
Oxlint supports most of the APIs typically used in plugins/rules which rely on AST inspection.
343-
That includes most "fix code"-type rules.
344-
345-
It does not yet support token-based APIs, so stylistic (formatting) rules will not work yet.
346-
347-
Supported:
342+
Oxlint supports most of ESLint's API surface:
348343

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

359353
Not supported yet:
360354

361355
- Language server (IDE) support.
362356
- Suggestions.
363357
- Control flow analysis.
358+
- Custom file formats (e.g. Svelte, Vue, Angular).
364359

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

0 commit comments

Comments
 (0)