Skip to content

docs(linter): update JS plugins docs to include @oxlint/plugins package#865

Merged
camc314 merged 1 commit intomainfrom
om/02-04-docs_linter_update_js_plugins_docs_to_include_oxlint_plugins_package
Feb 4, 2026
Merged

docs(linter): update JS plugins docs to include @oxlint/plugins package#865
camc314 merged 1 commit intomainfrom
om/02-04-docs_linter_update_js_plugins_docs_to_include_oxlint_plugins_package

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Feb 4, 2026

oxc-project/oxc#18791 added eslintCompatPlugin function to convert a plugin using alternative createOnce API to an ESLint-compatible plugin.

oxc-project/oxc#18824 added @oxlint/plugins package, which contains this eslintCompatPlugin function.

Update the docs to reflect these changes.

Note: Not all these changes are yet in an Oxlint release, but @oxlint/plugins has been published to NPM, so we don't need to wait for next Oxlint release before updating the docs. The new instructions work already.

@netlify
Copy link

netlify bot commented Feb 4, 2026

Deploy Preview for oxc-project ready!

Name Link
🔨 Latest commit 35726d3
🔍 Latest deploy log https://app.netlify.com/projects/oxc-project/deploys/698345189575cc0007576818
😎 Deploy Preview https://deploy-preview-865--oxc-project.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@overlookmotel overlookmotel marked this pull request as ready for review February 4, 2026 12:55
Copilot AI review requested due to automatic review settings February 4, 2026 12:55
Copy link
Contributor

Copilot AI left a 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 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 oxlint to @oxlint/plugins package
  • Replaced defineRule/definePlugin wrapper functions with eslintCompatPlugin that wraps the entire plugin
  • Updated section headers, cross-references, and explanations to reflect the new API
  • Added guidance about adding @oxlint/plugins as a runtime dependency

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@overlookmotel overlookmotel requested a review from camc314 February 4, 2026 13:02
@overlookmotel overlookmotel force-pushed the om/02-04-docs_linter_update_js_plugins_docs_to_include_oxlint_plugins_package branch from 8160124 to b70a6d9 Compare February 4, 2026 13:06
@overlookmotel overlookmotel force-pushed the om/02-04-docs_linter_update_js_plugins_docs_to_include_oxlint_plugins_package branch from b70a6d9 to 35726d3 Compare February 4, 2026 13:09
@camc314 camc314 merged commit fd1904d into main Feb 4, 2026
6 checks passed
@camc314 camc314 deleted the om/02-04-docs_linter_update_js_plugins_docs_to_include_oxlint_plugins_package branch February 4, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants