refactor(linter): split entry points for custom plugins/config/types

[camc314]

This is technically breaking (only for types), but custom plugins are experimental.

The ruletester/defineRule/definePlugin are re-exported but with a @deprecated tag which I think is a good enough trade off

I want to avoid users bringing in a ton of custom plugin code when doing import { defineConfig } from 'oxlint'

[camc314]

• feat(vscode): watch `oxlint.config.ts #18599
• feat(linter/lsp): add support for dynamic configs #18598
• feat(linter): auto generate oxlint.config.ts types #18597
• feat(oxlint): introduce defineConfig helper #18596
• feat(linter): implement oxlint.config.ts support #17563
• refactor(linter): split entry points for custom plugins/config/types #18601 👈 (View in Graphite)
• refactor(linter): update type references for lazy-loaded functions #18600
• main

---

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

• 0-merge - adds this PR to the back of the merge queue
• hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

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

[Copilot]

Pull request overview

This PR refactors the oxlint package to split entry points for custom plugins, rule testing, and configuration. The goal is to separate concerns and reduce bundle size for users who only need configuration imports without bringing in custom plugin code.

Changes:

• Add new entry points oxlint/plugin and oxlint/rule-tester for custom plugin and rule testing APIs
• Update package.json exports to include the new entry points
• Deprecate definePlugin, defineRule, and RuleTester exports from main entry point with JSDoc warnings
• Move all TypeScript type exports to the plugin.ts entry point

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
npm/oxlint/package.json	Adds exports configuration for new entry points (./plugin and ./rule-tester)
apps/oxlint/package.json	Adds exports and imports configuration for new entry points
apps/oxlint/tsdown.config.ts	Updates build configuration to include new entry point files in the build
apps/oxlint/src-js/plugin.ts	New entry point exporting definePlugin, defineRule, and all plugin-related types
apps/oxlint/src-js/rule-tester.ts	New entry point exporting RuleTester class
apps/oxlint/src-js/index.ts	Refactored to only export deprecated functions, removes all type exports

---

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

[overlookmotel]

Good idea to move RuleTester into a separate export. It's a lot of code.

But I don't particularly see the benefit of moving definePlugin and defineRule into oxlint/plugin, because that leaves the oxlint entry point empty. The index.ts entry point is only loaded if you import / require Oxlint programatically.

I actually think definePlugin and defineRule should move into a separate package anyway. I think I wrote about this somewhere, but I can't find it now, so I opened #18610.

[camc314]

But I don't particularly see the benefit of moving definePlugin and defineRule into oxlint/plugin, because that leaves the oxlint entry point empty.

Yeah I'm adding defineConfig in a PR a little higher up the stack - users importing defineConfig is the most common case, so I think it makes sense for it to be at the root of the package.

[overlookmotel]

Yeah I'm adding defineConfig in a PR a little higher up the stack

Ah ha now it makes sense.

Would appreciate your thoughts on #18610 when you have time.

[overlookmotel]

Pushed a commit to fix lint errors. Merging.

[camc314]

🙏i couldn't work out why it was failing. thanks

[overlookmotel]

Merge activity

• Jan 27, 12:57 AM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
• Jan 27, 12:57 AM UTC: overlookmotel added this pull request to the Graphite merge queue.
• Jan 27, 1:04 AM UTC: Merged by the Graphite merge queue.