refactor(linter/plugins): add napi function `createWorkspace` and `destroyWorkspace` by Sysix · Pull Request #17809 · oxc-project/oxc

Sysix · 2026-01-08T21:04:05Z

This PR introduces workspace isolation for the oxlint NAPI plugin system, adding createWorkspace and destroyWorkspace functions to manage multi workspace support for the language server.

This does not fully solve the integration, but should be a good start for all future work. One example is the buffer for multiple calls at the same time (?).

Added a new workspace isolation layer that uses the current working directory (cwd) as the workspace identifier:

createWorkspace(cwd: string): Initializes a new isolated workspace for plugins and configurations
destroyWorkspace(cwd: string): Cleans up workspace resources, unloading all associated plugins and options
getResponsibleWorkspace(filePath: string): Determines which workspace is responsible for a given file path, reflecting the changes in fix(lsp): fix workspace worker selection for nested and similar-named workspaces #17853

Sysix · 2026-01-08T21:04:21Z

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.

codspeed-hq · 2026-01-08T21:11:31Z

Merging this PR will not alter performance

✅ 46 untouched benchmarks
⏩ 3 skipped benchmarks¹

_{Comparing 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ (2949b9d) with main (e39a983)²}

3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
No successful run was found on main (b34a155) during the generation of this report, so e39a983 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

Copilot

Pull request overview

This PR adds workspace management capabilities to the oxlint NAPI bindings, introducing createWorkspace and destroyWorkspace functions. The changes enable proper isolation of plugin dependencies across different workspace directories, and update the context API to pass the current working directory (cwd) through the configuration setup chain.

Key changes:

Added NAPI callbacks for workspace creation and destruction with corresponding Rust and TypeScript implementations
Modified the context API to reject cwd access in createOnce hooks, requiring explicit workspace setup
Updated plugin loading to be workspace-aware, storing rules per workspace instead of globally

Reviewed changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
crates/oxc_linter/src/lib.rs	Exports new workspace callback types
crates/oxc_linter/src/external_linter.rs	Adds workspace creation/destruction callbacks to ExternalLinter struct
crates/oxc_linter/src/external_plugin_store.rs	Adds cwd parameter to setup_configs method
apps/oxlint/src/run.rs	Defines NAPI callback types for workspace management
apps/oxlint/src/result.rs	Adds JsPluginWorkspaceSetupFailed result variant
apps/oxlint/src/lsp/server_linter.rs	Integrates workspace lifecycle into LSP server
apps/oxlint/src/lint.rs	Calls workspace setup during CLI initialization
apps/oxlint/src/js_plugins/external_linter.rs	Implements Rust wrappers for workspace callbacks
apps/oxlint/src-js/workspace/index.ts	New workspace management module
apps/oxlint/src-js/plugins/context.ts	Updates context to enforce workspace requirements for cwd access
apps/oxlint/src-js/plugins/load.ts	Makes plugin loading workspace-aware
apps/oxlint/src-js/plugins/lint.ts	Updates linting to be workspace-aware
apps/oxlint/src-js/plugins/options.ts	Adds workspace validation to options setup
apps/oxlint/src-js/cli.ts	Integrates workspace callbacks into CLI entry point
apps/oxlint/src-js/bindings.d.ts	Adds TypeScript definitions for workspace callbacks
apps/oxlint/src-js/package/rule_tester.ts	Updates rule tester to use workspace APIs
apps/oxlint/test/tokens.test.ts	Updates test to pass cwd to setupFileContext
apps/oxlint/test/isSpaceBetween.test.ts	Updates test to pass cwd to setupFileContext
apps/oxlint/test/fixtures/createOnce/plugin.ts	Updates test to verify cwd access restrictions
apps/oxlint/test/fixtures/createOnce/output.snap.md	Updates expected output for cwd error messages

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

apps/oxlint/src-js/plugins/load.ts

apps/oxlint/src/lsp/server_linter.rs

apps/oxlint/src-js/workspace/index.ts

apps/oxlint/src-js/plugins/options.ts

apps/oxlint/src/lint.rs

apps/oxlint/src/js_plugins/external_linter.rs

apps/oxlint/src-js/plugins/load.ts

apps/oxlint/src/lint.rs

apps/oxlint/src-js/workspace/index.ts

apps/oxlint/src-js/cli.ts

Pass `cwd` into `setupFileContext`, so it can be set per file, rather than being a global setting. This is preamble to #17809. This PR is some of the changes from that one split off, so the diff on #17809 is focused just on that one change. This PR does nothing in itself, as currently `process.cwd()` is always passed to `setupFileContext`.

… path (#18702) `RuleTester` accepts `filename` as a property of test cases. Previously it passed `filename` directly through to the linter, but that wasn't right - the linter expects it to be passed an absolute path. Instead, convert `filename` to an absolute path, if it isn't one already. Not using `process.cwd()` as the base of the path, as `RuleTester` is a testing utility, and the results should be deterministic, unaffected by external factors like CWD. Use the root of `oxlint` package as the base instead (a bit arbitrary, but what would be better?). This is preamble to #17809. This PR is some of the changes from that one split off, so the diff on #17809 is focused just on that one change.

overlookmotel · 2026-01-30T11:06:54Z

I believe there's a bug here in loadPlugin. It's assuming that the plugin file is within the workspace, but that's not necessarily the case. e.g.:

Workspace 1: /path/to/project/packages/foo
Workspace 2: /path/to/project/packages/bar
JS plugin: /path/to/project/node_modules/eslint-plugin-whatever

I don't propose that we try to fix this in this PR - I think better to merge this stack and then iterate on it, but just making this comment here to describe the issue.

camc314 · 2026-01-30T13:52:13Z

Merge activity

Jan 30, 1:52 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Jan 30, 1:52 PM UTC: camc314 added this pull request to the Graphite merge queue.
Jan 30, 1:59 PM UTC: Merged by the Graphite merge queue.

…stroyWorkspace` (#17809) This PR introduces workspace isolation for the oxlint NAPI plugin system, adding `createWorkspace` and `destroyWorkspace` functions to manage multi workspace support for the language server. This does not fully solve the integration, but should be a good start for all future work. One example is the buffer for multiple calls at the same time (?). Added a new workspace isolation layer that uses the current working directory (cwd) as the workspace identifier: - `createWorkspace(cwd: string)`: Initializes a new isolated workspace for plugins and configurations - `destroyWorkspace(cwd: string)`: Cleans up workspace resources, unloading all associated plugins and options - `getResponsibleWorkspace(filePath: string)`: Determines which workspace is responsible for a given file path, reflecting the changes in #17853

…18727) #17809 and #17840 add support for JS plugins to LSP. However: * We don't have much test coverage yet. * The support for workspaces imposes a perf cost on Oxlint CLI (frequent hash map lookups on JS side). * I believe there's a bug in JS-side code - #17809 (comment). I think it'd be easier to merge this stack and then iterate on it in further PRs to fix the above. To prevent any breakage for users in the meantime, this PR disables JS plugin support in LSP unless the `testing` Cargo feature is enabled - i.e. it's only enabled in tests for now.

Update conformance snapshots. They got out of sync after #17809 (1 broken test, and change to how code is split across files in bundle).

Add a `cwd` option to `RuleTester`. Use this option in conformance tests to set `cwd` to the test files directory. This fixes the 1 test which #17809 broke.

Workspaces support (#17809) added overhead on JS side of hashmap lookups. Every call to `lintFile` has to look up details (e.g. registered rules, rule options) from hashmaps keyed by workspace URI. ### Perf Take a different approach which is optimized for common case of there being only 1 workspace: * At any time there's 1 "current workspace". * Store rules, options, and CWD in top-level vars (back to how it was before #17809). * Switch workspaces only when required. Switching reassigns the values in these top level vars. Before: * Get rules, options, and CWD from hashmaps keyed by workspace URI. After: * Quick check "is the current workspace the one we need?". * If so, do nothing - the top-level vars `registeredRules`, `allOptions`, and `cwd` elready contain the right settings for the desired workspace. * If current workspace is not the right one, look up the details for desired workspace in `workspaces` hash map and write them into the top-level vars. In CLI, `workspaceUri` passed to `lintFile` etc is `null`, so the quick "in the right workspace?" check is particularly cheap - just `null === null`. So this reduces the overhead that workspace support adds to CLI to just that 1 instruction. Add of these functions are entirely synchronous, so there's no possibility of a race where 1 call switches out the values in the top-level vars, while another call is busy using them. ### CLI: No call to `createWorkspace` CLI now doesn't need to call `createWorkspace` at all. The "are we in right workspace?" check always succeeds, so it's irrelevant whether a workspace has been created or not - `workspaces` hashmap is never accessed. So workspaces is now an LSP-only thing. ### Bundle This PR also removes all imports from other files from `src-js/workspace/index.ts`. It now only imports `debugAssert`, which is optimized out in release build., leaving no imports at all. Previously, the imports from other files were causing most of the JS plugins code to get loaded on first call to `createWorkspace`, which broke the lazy loading optimization - Oxlint CLI and LSP were both loading all the JS plugins code eagerly even if the user doesn't use JS plugins. With this change, the lazy loading optimization is restored. This is visible in the conformance snapshot change in this PR.

github-actions bot added A-linter Area - Linter A-cli Area - CLI A-linter-plugins Area - Linter JS plugins labels Jan 8, 2026

github-actions bot added the C-cleanup Category - technical debt or refactoring. Solution not expected to change behavior label Jan 8, 2026

Sysix mentioned this pull request Jan 8, 2026

refactor(oxlint/lsp): pass ExternalLinter/-Store to nested config search #17808

Merged

Sysix force-pushed the 01-08-refactor_oxlint_lsp_pass_externallinter_-store_to_nested_config_search branch from 1522106 to abc83bc Compare January 8, 2026 21:52

Sysix force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch 2 times, most recently from 4624412 to fd1a69a Compare January 8, 2026 22:29

github-actions bot added the A-formatter Area - Formatter label Jan 8, 2026

graphite-app bot changed the base branch from 01-08-refactor_oxlint_lsp_pass_externallinter_-store_to_nested_config_search to graphite-base/17809 January 8, 2026 22:30

graphite-app bot force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch from fd1a69a to 77c0e93 Compare January 8, 2026 22:37

graphite-app bot force-pushed the graphite-base/17809 branch from abc83bc to 36b82ec Compare January 8, 2026 22:37

graphite-app bot changed the base branch from graphite-base/17809 to main January 8, 2026 22:37

graphite-app bot force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch from 77c0e93 to d783e7d Compare January 8, 2026 22:38

Sysix force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch 2 times, most recently from b52ddea to f0982bf Compare January 8, 2026 22:39

Sysix removed the A-formatter Area - Formatter label Jan 8, 2026

Sysix force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch 5 times, most recently from a64e84a to a816eec Compare January 9, 2026 21:35

Sysix mentioned this pull request Jan 9, 2026

feat(oxlint/lsp): support jsPlugins #17840

Merged

Sysix requested a review from Copilot January 10, 2026 00:05

Copilot started reviewing on behalf of Sysix January 10, 2026 00:06 View session

Sysix mentioned this pull request Jan 10, 2026

chore(oxlint/napi): add createWorkspace & destroyWorkspace js callback function #16121

Closed

Copilot AI reviewed Jan 10, 2026

View reviewed changes

Sysix force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch from a816eec to dd99973 Compare January 10, 2026 12:57

overlookmotel mentioned this pull request Jan 29, 2026

fix(linter/plugins)!: RuleTester set context.filename to absolute path #18702

Merged

overlookmotel changed the title ~~chore(oxlint/napi): add napi function createWorkspace and destroyWorkspace~~ refactor(linter/plugins): add napi function createWorkspace and destroyWorkspace Jan 29, 2026

graphite-app bot changed the base branch from om/01-29-fix_linter_plugins_ruletester_set_context.filename_to_absolute_path to graphite-base/17809 January 30, 2026 01:14

graphite-app bot force-pushed the graphite-base/17809 branch from b13bd73 to b34a155 Compare January 30, 2026 01:23

graphite-app bot force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch from 2a0a3c7 to dffa2f3 Compare January 30, 2026 01:23

graphite-app bot changed the base branch from graphite-base/17809 to main January 30, 2026 01:23

graphite-app bot force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch from dffa2f3 to 2949b9d Compare January 30, 2026 01:23

overlookmotel mentioned this pull request Jan 30, 2026

fix(oxlint/lsp): disable JS plugins support in LSP except in tests #18727

Merged

camc314 approved these changes Jan 30, 2026

View reviewed changes

camc314 added the 0-merge Merge with Graphite Merge Queue label Jan 30, 2026

graphite-app bot force-pushed the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch from 2949b9d to 5bd6758 Compare January 30, 2026 13:52

graphite-app bot merged commit 5bd6758 into main Jan 30, 2026
22 checks passed

graphite-app bot deleted the 01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_ branch January 30, 2026 13:59

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Jan 30, 2026

camc314 mentioned this pull request Jan 30, 2026

language server: JS Plugins support #18662

Closed

Sysix mentioned this pull request Jan 30, 2026

feat(linter): introduce DiscoveredConfig in preparation for JS configs #18674

Merged

This was referenced Jan 31, 2026

test(linter/plugins): update conformance snapshots #18752

Merged

feat(linter/plugins): RuleTester take cwd property #18756

Merged

perf(linter/plugins): reduce cost of workspaces #18758

Merged

graphite-app bot pushed a commit that referenced this pull request Jan 31, 2026

test(linter/plugins): update conformance snapshots (#18752)

7c7a984

Update conformance snapshots. They got out of sync after #17809 (1 broken test, and change to how code is split across files in bundle).

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(linter/plugins): add napi function `createWorkspace` and `destroyWorkspace`#17809

refactor(linter/plugins): add napi function `createWorkspace` and `destroyWorkspace`#17809
graphite-app[bot] merged 1 commit intomainfrom
01-08-chore_oxlint_napi_add_napi_function_createworkspace_and_destroyworkspace_

Sysix commented Jan 8, 2026 •

edited

Loading

Uh oh!

Sysix commented Jan 8, 2026 •

edited by overlookmotel

Loading

Uh oh!

codspeed-hq bot commented Jan 8, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

overlookmotel commented Jan 30, 2026

Uh oh!

camc314 commented Jan 30, 2026 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Uh oh!

Conversation

Sysix commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sysix commented Jan 8, 2026 • edited by overlookmotel Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

codspeed-hq bot commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

overlookmotel commented Jan 30, 2026

Uh oh!

camc314 commented Jan 30, 2026 • edited by graphite-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Sysix commented Jan 8, 2026 •

edited

Loading

Sysix commented Jan 8, 2026 •

edited by overlookmotel

Loading

codspeed-hq bot commented Jan 8, 2026 •

edited

Loading

camc314 commented Jan 30, 2026 •

edited by graphite-app bot

Loading