Conversation
✅ Deploy Preview for oxc-project ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the JavaScript plugins documentation to reflect the new @oxlint/plugins package and its eslintCompatPlugin function, replacing the previous defineRule and definePlugin API.
Changes:
- Updated import statements from
oxlintto@oxlint/pluginspackage - Replaced
defineRule/definePluginwrapper functions witheslintCompatPluginthat wraps the entire plugin - Updated section headers, cross-references, and explanations to reflect the new API
- Added guidance about adding
@oxlint/pluginsas a runtime dependency
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
8160124 to
b70a6d9
Compare
b70a6d9 to
35726d3
Compare
camc314
approved these changes
Feb 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

oxc-project/oxc#18791 added
eslintCompatPluginfunction to convert a plugin using alternativecreateOnceAPI to an ESLint-compatible plugin.oxc-project/oxc#18824 added
@oxlint/pluginspackage, which contains thiseslintCompatPluginfunction.Update the docs to reflect these changes.
Note: Not all these changes are yet in an Oxlint release, but
@oxlint/pluginshas been published to NPM, so we don't need to wait for next Oxlint release before updating the docs. The new instructions work already.