From 5c46857c497fb5d8d6f28dd248abb821df02e2d7 Mon Sep 17 00:00:00 2001 From: 0froq Date: Tue, 17 Nov 2026 14:53:23 +0800 Subject: [PATCH] fix(devtools): resolve open-in-editor paths against the workspace root The component inspector sends paths relative to the workspace root, but openInEditor only joined them with the package cwd. Files outside that package were reported missing. Co-authored-by: Cursor --- packages/devtools/src/server-rpc/general.ts | 30 +++-- packages/devtools/test/open-in-editor.test.ts | 119 ++++++++++++++++++ 2 files changed, 138 insertions(+), 11 deletions(-) create mode 100644 packages/devtools/test/open-in-editor.test.ts diff --git a/packages/devtools/src/server-rpc/general.ts b/packages/devtools/src/server-rpc/general.ts index 6b5a772e38..371b776d01 100644 --- a/packages/devtools/src/server-rpc/general.ts +++ b/packages/devtools/src/server-rpc/general.ts @@ -201,10 +201,10 @@ export function setupGeneralRPC({ }, async openInEditor(token: string, input: string): Promise { await ensureDevAuthToken(token) - if (input.startsWith('./') || !ABSOLUTE_PATH_RE.test(input)) - input = resolve(process.cwd(), input) + const isRelative = input.startsWith('./') || !ABSOLUTE_PATH_RE.test(input) - // separate line and column syntax + // separate line and column syntax before resolving, so `:line:col` + // is not part of the filename const match = input.match(FILE_LINE_COL_RE) let suffix = '' if (match) { @@ -212,16 +212,24 @@ export function setupGeneralRPC({ suffix = match[2]! } - // search for existing path - const path = [ - input, - `${input}.js`, - `${input}.mjs`, - `${input}.ts`, - ].find(i => existsSync(i)) + // Inspector paths are workspace-relative. cwd is the package directory + // in a workspace, so try cwd, rootDir, then workspaceDir. + const candidates = isRelative + ? [ + ...new Set([ + process.cwd(), + nuxt.options.rootDir, + nuxt.options.workspaceDir, + ].filter(Boolean)), + ].map(dir => resolve(dir, input)) + : [input] + + const path = candidates + .flatMap(i => [i, `${i}.js`, `${i}.mjs`, `${i}.ts`]) + .find(i => existsSync(i)) if (!path) { - console.error('File not found:', input) + console.error('File not found:', candidates[0]) return false } diff --git a/packages/devtools/test/open-in-editor.test.ts b/packages/devtools/test/open-in-editor.test.ts new file mode 100644 index 0000000000..b1173b2efa --- /dev/null +++ b/packages/devtools/test/open-in-editor.test.ts @@ -0,0 +1,119 @@ +import type { Nuxt } from 'nuxt/schema' +import type { NuxtDevtoolsServerContext } from '../src/types' +import fsp from 'node:fs/promises' +import { tmpdir } from 'node:os' +import { createHooks } from 'hookable' +import { join, normalize } from 'pathe' +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' +import { setupGeneralRPC } from '../src/server-rpc/general' +import { getOptions } from '../src/server-rpc/options' + +vi.mock('launch-editor', () => ({ + default: vi.fn(), +})) + +vi.mock('../src/server-rpc/options', () => ({ + getOptions: vi.fn(), +})) + +const TOKEN = 'token' + +function fakeContext(root: string, handledByHook = true) { + const hooks = createHooks() + const opened: string[] = [] + const ctx = { + nuxt: { + options: { + rootDir: join(root, 'docs'), + workspaceDir: root, + }, + hooks, + hook: hooks.hook.bind(hooks), + } as unknown as Nuxt, + options: {}, + refresh: () => {}, + ensureDevAuthToken: async () => {}, + openInEditorHooks: [ + (filepath: string) => { + opened.push(filepath) + return handledByHook + }, + ], + } as unknown as NuxtDevtoolsServerContext + return { ctx, opened } +} + +describe('openInEditor', () => { + let root: string + + beforeEach(async () => { + root = normalize(await fsp.mkdtemp(join(tmpdir(), 'devtools-editor-'))) + await fsp.mkdir(join(root, 'docs/app/components'), { recursive: true }) + await fsp.mkdir(join(root, 'src/components/button'), { recursive: true }) + await fsp.writeFile(join(root, 'docs/app/components/DocPage.vue'), '') + await fsp.writeFile(join(root, 'src/components/button/Button.demo.vue'), '') + vi.spyOn(process, 'cwd').mockReturnValue(join(root, 'docs')) + vi.mocked(getOptions).mockReset() + }) + + afterEach(async () => { + vi.restoreAllMocks() + await fsp.rm(root, { recursive: true, force: true }) + }) + + it('opens a path relative to the current working directory', async () => { + const { ctx, opened } = fakeContext(root) + const { openInEditor } = setupGeneralRPC(ctx) + + await expect(openInEditor(TOKEN, 'app/components/DocPage.vue')).resolves.toBe(true) + expect(opened).toEqual([ + join(root, 'docs/app/components/DocPage.vue'), + ]) + }) + + it('opens a path relative to the root directory when the cwd holds no such file', async () => { + vi.spyOn(process, 'cwd').mockReturnValue(join(root, 'tools')) + const { ctx, opened } = fakeContext(root) + const { openInEditor } = setupGeneralRPC(ctx) + + await expect(openInEditor(TOKEN, 'app/components/DocPage.vue')).resolves.toBe(true) + expect(opened).toEqual([ + join(root, 'docs/app/components/DocPage.vue'), + ]) + }) + + it('opens a workspace-relative path while the cwd is the package directory', async () => { + const { ctx, opened } = fakeContext(root) + const { openInEditor } = setupGeneralRPC(ctx) + + await expect(openInEditor(TOKEN, 'docs/app/components/DocPage.vue:3:5')).resolves.toBe(true) + expect(opened).toEqual([`${join(root, 'docs/app/components/DocPage.vue')}:3:5`]) + }) + + it('opens a file that lives at the workspace root, outside the Nuxt package', async () => { + const { ctx, opened } = fakeContext(root) + const { openInEditor } = setupGeneralRPC(ctx) + + await expect(openInEditor(TOKEN, 'src/components/button/Button.demo.vue:27:2')).resolves.toBe(true) + expect(opened).toEqual([`${join(root, 'src/components/button/Button.demo.vue')}:27:2`]) + }) + + it('opens an absolute path without touching the base directories', async () => { + const { ctx, opened } = fakeContext(root) + const { openInEditor } = setupGeneralRPC(ctx) + const filepath = join(root, 'docs/app/components/DocPage.vue') + + await expect(openInEditor(TOKEN, filepath)).resolves.toBe(true) + expect(opened).toEqual([filepath]) + }) + + it('reports the cwd candidate when the file exists under none of the bases', async () => { + const error = vi.spyOn(console, 'error').mockImplementation(() => {}) + const { ctx, opened } = fakeContext(root) + const { openInEditor } = setupGeneralRPC(ctx) + + await expect(openInEditor(TOKEN, 'app/components/Missing.vue')).resolves.toBe(false) + expect(opened).toEqual([]) + expect(error).toHaveBeenCalledWith('File not found:', join(root, 'docs/app/components/Missing.vue')) + }) +})