-
-
Notifications
You must be signed in to change notification settings - Fork 68
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.
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
base: main
Are you sure you want to change the base?
docs(oxlint): update JS plugins API support #683
Conversation
✅ Deploy Preview for oxc-project ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the Oxlint JS plugins documentation to accurately reflect the current state of API support. The documentation had become outdated regarding which ESLint APIs are currently supported and unsupported.
Key changes:
- Removed outdated statement that token-based APIs are not supported (they now are)
- Removed TypeScript plugin support from the supported features list due to incomplete type support
- Added Globals and Custom file formats to the unsupported features list
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Language server (IDE) support. | ||
| - Suggestions. | ||
| - Control flow analysis. | ||
| - Globals. |
There was a problem hiding this comment.
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? :)

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 a couple of the remaining missing features 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.