From ce38da8f7ebfc7b85ff33a88c204f36e42bfb2da Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Wed, 15 Apr 2026 22:06:27 +0200 Subject: [PATCH 1/7] feat: external directories in `physical()` virtual route mounts --- .changeset/virtual-route-external-physical.md | 6 ++ packages/router-generator/src/generator.ts | 4 ++ .../router-generator/tests/generator.test.ts | 33 +++++++++ .../external-target/bar.tsx | 2 + .../external-target/foo.tsx | 2 + .../routeTree.snapshot.ts | 59 ++++++++++++++++ .../routes/__root.tsx | 5 ++ .../routes/index.tsx | 2 + .../src/core/router-generator-plugin.ts | 67 +++++++++++++++++-- 9 files changed, 174 insertions(+), 6 deletions(-) create mode 100644 .changeset/virtual-route-external-physical.md create mode 100644 packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/bar.tsx create mode 100644 packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/foo.tsx create mode 100644 packages/router-generator/tests/generator/virtual-physical-external-abs/routeTree.snapshot.ts create mode 100644 packages/router-generator/tests/generator/virtual-physical-external-abs/routes/__root.tsx create mode 100644 packages/router-generator/tests/generator/virtual-physical-external-abs/routes/index.tsx diff --git a/.changeset/virtual-route-external-physical.md b/.changeset/virtual-route-external-physical.md new file mode 100644 index 0000000000..66a39b2c9b --- /dev/null +++ b/.changeset/virtual-route-external-physical.md @@ -0,0 +1,6 @@ +--- +'@tanstack/router-generator': minor +'@tanstack/router-plugin': minor +--- + +feat: external directories in `physical()` virtual route mounts \ No newline at end of file diff --git a/packages/router-generator/src/generator.ts b/packages/router-generator/src/generator.ts index e1b72327f2..e4d16972a7 100644 --- a/packages/router-generator/src/generator.ts +++ b/packages/router-generator/src/generator.ts @@ -275,6 +275,10 @@ export class Generator { ) } + public getPhysicalDirectories(): Array { + return [...this.physicalDirectories] + } + public async run(event?: GeneratorEvent): Promise { if ( event && diff --git a/packages/router-generator/tests/generator.test.ts b/packages/router-generator/tests/generator.test.ts index 79f7d505b2..2b9524f597 100644 --- a/packages/router-generator/tests/generator.test.ts +++ b/packages/router-generator/tests/generator.test.ts @@ -388,6 +388,39 @@ describe('generator works', async () => { }) }) + it('physical() accepts a path outside routesDirectory', async () => { + const folderName = 'virtual-physical-external-abs' + const dir = makeFolderDir(folderName) + const externalDir = path.join(dir, 'external-target') + const config = await setupConfig(folderName, { + virtualRouteConfig: rootRoute('__root.tsx', [ + index('index.tsx'), + physical('/external', externalDir), + ]), + }) + + const { routeNodes, physicalDirectories } = await virtualGetRouteNodes( + config, + dir, + { + indexTokenSegmentRegex: /^(?:index)$/, + routeTokenSegmentRegex: /^(?:route)$/, + }, + ) + + expect(physicalDirectories).toContain(externalDir) + expect(routeNodes.map((n) => n.routePath).sort()).toEqual([ + '/', + '/external/bar', + '/external/foo', + ]) + + const externalFoo = routeNodes.find((n) => n.routePath === '/external/foo')! + expect(path.resolve(config.routesDirectory, externalFoo.filePath)).toBe( + path.join(externalDir, 'foo.tsx'), + ) + }) + it.each(folderNames)( 'should create directory for routeTree if it does not exist', async () => { diff --git a/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/bar.tsx b/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/bar.tsx new file mode 100644 index 0000000000..0117add41a --- /dev/null +++ b/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/bar.tsx @@ -0,0 +1,2 @@ +import { createFileRoute } from '@tanstack/react-router' +export const Route = createFileRoute('/external/bar')({ component: () => 'bar' }) diff --git a/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/foo.tsx b/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/foo.tsx new file mode 100644 index 0000000000..71fd91d06a --- /dev/null +++ b/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/foo.tsx @@ -0,0 +1,2 @@ +import { createFileRoute } from '@tanstack/react-router' +export const Route = createFileRoute('/external/foo')({ component: () => 'foo' }) diff --git a/packages/router-generator/tests/generator/virtual-physical-external-abs/routeTree.snapshot.ts b/packages/router-generator/tests/generator/virtual-physical-external-abs/routeTree.snapshot.ts new file mode 100644 index 0000000000..d204c269b3 --- /dev/null +++ b/packages/router-generator/tests/generator/virtual-physical-external-abs/routeTree.snapshot.ts @@ -0,0 +1,59 @@ +/* eslint-disable */ + +// @ts-nocheck + +// noinspection JSUnusedGlobalSymbols + +// This file was automatically generated by TanStack Router. +// You should NOT make any changes in this file as it will be overwritten. +// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified. + +import { Route as rootRouteImport } from './routes/__root' +import { Route as IndexRouteImport } from './routes/index' + +const IndexRoute = IndexRouteImport.update({ + id: '/', + path: '/', + getParentRoute: () => rootRouteImport, +} as any) + +export interface FileRoutesByFullPath { + '/': typeof IndexRoute +} +export interface FileRoutesByTo { + '/': typeof IndexRoute +} +export interface FileRoutesById { + __root__: typeof rootRouteImport + '/': typeof IndexRoute +} +export interface FileRouteTypes { + fileRoutesByFullPath: FileRoutesByFullPath + fullPaths: '/' + fileRoutesByTo: FileRoutesByTo + to: '/' + id: '__root__' | '/' + fileRoutesById: FileRoutesById +} +export interface RootRouteChildren { + IndexRoute: typeof IndexRoute +} + +declare module '@tanstack/react-router' { + interface FileRoutesByPath { + '/': { + id: '/' + path: '/' + fullPath: '/' + preLoaderRoute: typeof IndexRouteImport + parentRoute: typeof rootRouteImport + } + } +} + +const rootRouteChildren: RootRouteChildren = { + IndexRoute: IndexRoute, +} +export const routeTree = rootRouteImport + ._addFileChildren(rootRouteChildren) + ._addFileTypes() diff --git a/packages/router-generator/tests/generator/virtual-physical-external-abs/routes/__root.tsx b/packages/router-generator/tests/generator/virtual-physical-external-abs/routes/__root.tsx new file mode 100644 index 0000000000..f463b796b4 --- /dev/null +++ b/packages/router-generator/tests/generator/virtual-physical-external-abs/routes/__root.tsx @@ -0,0 +1,5 @@ +import { createRootRoute, Outlet } from '@tanstack/react-router' + +export const Route = createRootRoute({ + component: () => , +}) diff --git a/packages/router-generator/tests/generator/virtual-physical-external-abs/routes/index.tsx b/packages/router-generator/tests/generator/virtual-physical-external-abs/routes/index.tsx new file mode 100644 index 0000000000..0a298cf6cc --- /dev/null +++ b/packages/router-generator/tests/generator/virtual-physical-external-abs/routes/index.tsx @@ -0,0 +1,2 @@ +import { createFileRoute } from '@tanstack/react-router' +export const Route = createFileRoute('/')({ component: () => 'home' }) diff --git a/packages/router-plugin/src/core/router-generator-plugin.ts b/packages/router-plugin/src/core/router-generator-plugin.ts index 055a1bc3c5..4eeca38832 100644 --- a/packages/router-plugin/src/core/router-generator-plugin.ts +++ b/packages/router-plugin/src/core/router-generator-plugin.ts @@ -9,6 +9,17 @@ import type { Config } from './config' const PLUGIN_NAME = 'unplugin:router-generator' +// Physical mounts that point outside `routesDirectory` — their files aren't +// covered by the bundler's own watcher. +function getExternalPhysicalDirs( + generator: Generator, + routesDirectoryPath: string, +): Array { + return generator + .getPhysicalDirectories() + .filter((dir) => !dir.startsWith(routesDirectoryPath)) +} + export const unpluginRouterGeneratorFactory: UnpluginFactory< Partial Config)> | undefined > = (options = {}) => { @@ -78,11 +89,30 @@ export const unpluginRouterGeneratorFactory: UnpluginFactory< initConfigAndGenerator({ root: config.root }) await generate() }, + configureServer(server) { + const external = getExternalPhysicalDirs( + generator, + getRoutesDirectoryPath(), + ) + if (external.length === 0) return + for (const dir of external) { + server.watcher.add(dir) + } + const onEvent = + (event: 'create' | 'update' | 'delete') => (file: string) => { + if (!external.some((dir) => file.startsWith(dir))) return + void generate({ file, event }) + } + server.watcher.on('add', onEvent('create')) + server.watcher.on('change', onEvent('update')) + server.watcher.on('unlink', onEvent('delete')) + }, }, rspack(compiler) { initConfigAndGenerator() let handle: FSWatcher | null = null + let externalHandle: FSWatcher | null = null compiler.hooks.beforeRun.tapPromise(PLUGIN_NAME, () => generate()) @@ -98,19 +128,32 @@ export const unpluginRouterGeneratorFactory: UnpluginFactory< .watch(routesDirectoryPath, { ignoreInitial: true }) .on('add', (file) => generate({ file, event: 'create' })) + // External physical() mounts are outside rspack's file graph. + const external = getExternalPhysicalDirs( + generator, + routesDirectoryPath, + ) + if (external.length > 0) { + externalHandle = chokidar + .watch(external, { ignoreInitial: true }) + .on('add', (file) => generate({ file, event: 'create' })) + .on('change', (file) => generate({ file, event: 'update' })) + .on('unlink', (file) => generate({ file, event: 'delete' })) + } + await generate() }) compiler.hooks.watchClose.tap(PLUGIN_NAME, async () => { - if (handle) { - await handle.close() - } + if (handle) await handle.close() + if (externalHandle) await externalHandle.close() }) }, webpack(compiler) { initConfigAndGenerator() let handle: FSWatcher | null = null + let externalHandle: FSWatcher | null = null compiler.hooks.beforeRun.tapPromise(PLUGIN_NAME, () => generate()) @@ -126,13 +169,25 @@ export const unpluginRouterGeneratorFactory: UnpluginFactory< .watch(routesDirectoryPath, { ignoreInitial: true }) .on('add', (file) => generate({ file, event: 'create' })) + // External physical() mounts are outside webpack's file graph. + const external = getExternalPhysicalDirs( + generator, + routesDirectoryPath, + ) + if (external.length > 0) { + externalHandle = chokidar + .watch(external, { ignoreInitial: true }) + .on('add', (file) => generate({ file, event: 'create' })) + .on('change', (file) => generate({ file, event: 'update' })) + .on('unlink', (file) => generate({ file, event: 'delete' })) + } + await generate() }) compiler.hooks.watchClose.tap(PLUGIN_NAME, async () => { - if (handle) { - await handle.close() - } + if (handle) await handle.close() + if (externalHandle) await externalHandle.close() }) compiler.hooks.done.tap(PLUGIN_NAME, () => { From 8cdb7e48a1cd006514c1c544265a87c0a27930fc Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Wed, 15 Apr 2026 23:56:14 +0200 Subject: [PATCH 2/7] watcher test --- .../router-generator-plugin-watcher.test.ts | 108 ++++++++++++++++++ 1 file changed, 108 insertions(+) create mode 100644 packages/router-plugin/tests/router-generator-plugin-watcher.test.ts diff --git a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts new file mode 100644 index 0000000000..ba9b0381a5 --- /dev/null +++ b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts @@ -0,0 +1,108 @@ +import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises' +import { tmpdir } from 'node:os' +import path from 'node:path' +import chokidar from 'chokidar' +import { afterEach, beforeEach, describe, it } from 'vitest' + +import { physical, rootRoute } from '@tanstack/virtual-file-routes' +import { unpluginRouterGeneratorFactory } from '../src/core/router-generator-plugin' + +const ROOT_ROUTE = `import { createRootRoute, Outlet } from '@tanstack/react-router' +export const Route = createRootRoute({ component: () => null }) +` + +const makeRouteFile = (routePath: string) => + `import { createFileRoute } from '@tanstack/react-router' +export const Route = createFileRoute('${routePath}')({ component: () => null }) +` + +async function waitUntil( + condition: () => boolean | Promise, + { timeoutMs = 2000, intervalMs = 25 } = {}, +) { + const start = Date.now() + while (Date.now() - start < timeoutMs) { + if (await condition()) return + await new Promise((r) => setTimeout(r, intervalMs)) + } + throw new Error(`Timed out after ${timeoutMs}ms`) +} + +async function routeTreeIncludes(generatedRouteTree: string, match: string) { + try { + const text = await readFile(generatedRouteTree, 'utf-8') + return text.includes(match) + } catch { + return false + } +} + +describe('router-generator-plugin vite watcher', () => { + let fixtureDir = '' + let externalDir = '' + let routesDir = '' + let generatedRouteTree = '' + let watcher: chokidar.FSWatcher | undefined + + beforeEach(async () => { + fixtureDir = await mkdtemp(path.join(tmpdir(), 'tsr-plugin-watcher-')) + routesDir = path.join(fixtureDir, 'routes') + externalDir = path.join(fixtureDir, 'external') + generatedRouteTree = path.join(fixtureDir, 'routeTree.gen.ts') + + await mkdir(routesDir, { recursive: true }) + await mkdir(externalDir, { recursive: true }) + await writeFile(path.join(routesDir, '__root.tsx'), ROOT_ROUTE) + await writeFile( + path.join(externalDir, 'alpha.tsx'), + makeRouteFile('/ext/alpha'), + ) + }) + + afterEach(async () => { + if (watcher) { + await watcher.close() + watcher = undefined + } + await rm(fixtureDir, { recursive: true, force: true }) + }) + + it('regenerates routeTree when a file is added to an external physical mount', async () => { + const plugin = unpluginRouterGeneratorFactory({ + routesDirectory: routesDir, + generatedRouteTree, + virtualRouteConfig: rootRoute('__root.tsx', [ + physical('/ext', externalDir), + ]), + disableLogging: true, + }) + + const viteHooks = plugin.vite as { + configResolved: (config: { root: string }) => Promise + configureServer: (server: { + watcher: chokidar.FSWatcher + }) => void | Promise + } + + await viteHooks.configResolved({ root: fixtureDir }) + await waitUntil(() => + routeTreeIncludes(generatedRouteTree, "'/ext/alpha'"), + ) + + watcher = chokidar.watch(routesDir, { ignoreInitial: true }) + await new Promise((resolve) => watcher!.once('ready', resolve)) + await viteHooks.configureServer({ watcher }) + + // Add a new route file in the external mount. + const betaPath = path.join(externalDir, 'beta.tsx') + await writeFile(betaPath, makeRouteFile('/ext/beta')) + + await waitUntil(() => routeTreeIncludes(generatedRouteTree, "'/ext/beta'")) + + // Removing the file should likewise trigger regeneration. + await rm(betaPath) + await waitUntil(async () => + !(await routeTreeIncludes(generatedRouteTree, "'/ext/beta'")), + ) + }) +}) From aebbbc02219a1513baf388baf052d06ec02b1a82 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Wed, 15 Apr 2026 21:57:43 +0000 Subject: [PATCH 3/7] ci: apply automated fixes --- .changeset/virtual-route-external-physical.md | 2 +- .../external-target/bar.tsx | 4 +++- .../external-target/foo.tsx | 4 +++- .../router-plugin/src/core/router-generator-plugin.ts | 10 ++-------- .../tests/router-generator-plugin-watcher.test.ts | 8 +++----- 5 files changed, 12 insertions(+), 16 deletions(-) diff --git a/.changeset/virtual-route-external-physical.md b/.changeset/virtual-route-external-physical.md index 66a39b2c9b..ecc1aa3b99 100644 --- a/.changeset/virtual-route-external-physical.md +++ b/.changeset/virtual-route-external-physical.md @@ -3,4 +3,4 @@ '@tanstack/router-plugin': minor --- -feat: external directories in `physical()` virtual route mounts \ No newline at end of file +feat: external directories in `physical()` virtual route mounts diff --git a/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/bar.tsx b/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/bar.tsx index 0117add41a..e542318de3 100644 --- a/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/bar.tsx +++ b/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/bar.tsx @@ -1,2 +1,4 @@ import { createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/external/bar')({ component: () => 'bar' }) +export const Route = createFileRoute('/external/bar')({ + component: () => 'bar', +}) diff --git a/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/foo.tsx b/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/foo.tsx index 71fd91d06a..a03b3d56a0 100644 --- a/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/foo.tsx +++ b/packages/router-generator/tests/generator/virtual-physical-external-abs/external-target/foo.tsx @@ -1,2 +1,4 @@ import { createFileRoute } from '@tanstack/react-router' -export const Route = createFileRoute('/external/foo')({ component: () => 'foo' }) +export const Route = createFileRoute('/external/foo')({ + component: () => 'foo', +}) diff --git a/packages/router-plugin/src/core/router-generator-plugin.ts b/packages/router-plugin/src/core/router-generator-plugin.ts index 4eeca38832..30eff51633 100644 --- a/packages/router-plugin/src/core/router-generator-plugin.ts +++ b/packages/router-plugin/src/core/router-generator-plugin.ts @@ -129,10 +129,7 @@ export const unpluginRouterGeneratorFactory: UnpluginFactory< .on('add', (file) => generate({ file, event: 'create' })) // External physical() mounts are outside rspack's file graph. - const external = getExternalPhysicalDirs( - generator, - routesDirectoryPath, - ) + const external = getExternalPhysicalDirs(generator, routesDirectoryPath) if (external.length > 0) { externalHandle = chokidar .watch(external, { ignoreInitial: true }) @@ -170,10 +167,7 @@ export const unpluginRouterGeneratorFactory: UnpluginFactory< .on('add', (file) => generate({ file, event: 'create' })) // External physical() mounts are outside webpack's file graph. - const external = getExternalPhysicalDirs( - generator, - routesDirectoryPath, - ) + const external = getExternalPhysicalDirs(generator, routesDirectoryPath) if (external.length > 0) { externalHandle = chokidar .watch(external, { ignoreInitial: true }) diff --git a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts index ba9b0381a5..4946891674 100644 --- a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts +++ b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts @@ -85,9 +85,7 @@ describe('router-generator-plugin vite watcher', () => { } await viteHooks.configResolved({ root: fixtureDir }) - await waitUntil(() => - routeTreeIncludes(generatedRouteTree, "'/ext/alpha'"), - ) + await waitUntil(() => routeTreeIncludes(generatedRouteTree, "'/ext/alpha'")) watcher = chokidar.watch(routesDir, { ignoreInitial: true }) await new Promise((resolve) => watcher!.once('ready', resolve)) @@ -101,8 +99,8 @@ describe('router-generator-plugin vite watcher', () => { // Removing the file should likewise trigger regeneration. await rm(betaPath) - await waitUntil(async () => - !(await routeTreeIncludes(generatedRouteTree, "'/ext/beta'")), + await waitUntil( + async () => !(await routeTreeIncludes(generatedRouteTree, "'/ext/beta'")), ) }) }) From 4c4f77e2f8557ac1fe8f35eaa78e4745232425e5 Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Thu, 16 Apr 2026 00:06:40 +0200 Subject: [PATCH 4/7] avoid using startsWith --- .../router-plugin/src/core/router-generator-plugin.ts | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/router-plugin/src/core/router-generator-plugin.ts b/packages/router-plugin/src/core/router-generator-plugin.ts index 30eff51633..a6aa217754 100644 --- a/packages/router-plugin/src/core/router-generator-plugin.ts +++ b/packages/router-plugin/src/core/router-generator-plugin.ts @@ -1,4 +1,4 @@ -import { isAbsolute, join, normalize } from 'node:path' +import { isAbsolute, join, normalize, relative } from 'node:path' import { Generator, resolveConfigPath } from '@tanstack/router-generator' import { getConfig } from './config' @@ -11,13 +11,17 @@ const PLUGIN_NAME = 'unplugin:router-generator' // Physical mounts that point outside `routesDirectory` — their files aren't // covered by the bundler's own watcher. +function isInside(parent: string, child: string): boolean { + const rel = relative(parent, child) + return rel === '' || (!rel.startsWith('..') && !isAbsolute(rel)) +} function getExternalPhysicalDirs( generator: Generator, routesDirectoryPath: string, ): Array { return generator .getPhysicalDirectories() - .filter((dir) => !dir.startsWith(routesDirectoryPath)) + .filter((dir) => !isInside(routesDirectoryPath, dir)) } export const unpluginRouterGeneratorFactory: UnpluginFactory< @@ -100,7 +104,7 @@ export const unpluginRouterGeneratorFactory: UnpluginFactory< } const onEvent = (event: 'create' | 'update' | 'delete') => (file: string) => { - if (!external.some((dir) => file.startsWith(dir))) return + if (!external.some((dir) => isInside(dir, file))) return void generate({ file, event }) } server.watcher.on('add', onEvent('create')) From b36e09bebce5fe1bce5887000c11e3bb8f4ef688 Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Thu, 16 Apr 2026 00:47:53 +0200 Subject: [PATCH 5/7] use vite server --- .../router-generator-plugin-watcher.test.ts | 88 +++++++++++-------- 1 file changed, 49 insertions(+), 39 deletions(-) diff --git a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts index 4946891674..a543b26921 100644 --- a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts +++ b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts @@ -1,11 +1,12 @@ import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises' import { tmpdir } from 'node:os' import path from 'node:path' -import chokidar from 'chokidar' import { afterEach, beforeEach, describe, it } from 'vitest' +import { createServer } from 'vite' +import type { ViteDevServer } from 'vite' import { physical, rootRoute } from '@tanstack/virtual-file-routes' -import { unpluginRouterGeneratorFactory } from '../src/core/router-generator-plugin' +import { tanstackRouterGenerator } from '../src/vite' const ROOT_ROUTE = `import { createRootRoute, Outlet } from '@tanstack/react-router' export const Route = createRootRoute({ component: () => null }) @@ -18,7 +19,7 @@ export const Route = createFileRoute('${routePath}')({ component: () => null }) async function waitUntil( condition: () => boolean | Promise, - { timeoutMs = 2000, intervalMs = 25 } = {}, + { timeoutMs = 10_000, intervalMs = 50 } = {}, ) { const start = Date.now() while (Date.now() - start < timeoutMs) { @@ -42,7 +43,7 @@ describe('router-generator-plugin vite watcher', () => { let externalDir = '' let routesDir = '' let generatedRouteTree = '' - let watcher: chokidar.FSWatcher | undefined + let server: ViteDevServer | undefined beforeEach(async () => { fixtureDir = await mkdtemp(path.join(tmpdir(), 'tsr-plugin-watcher-')) @@ -60,47 +61,56 @@ describe('router-generator-plugin vite watcher', () => { }) afterEach(async () => { - if (watcher) { - await watcher.close() - watcher = undefined + if (server) { + await server.close() + server = undefined } await rm(fixtureDir, { recursive: true, force: true }) }) - it('regenerates routeTree when a file is added to an external physical mount', async () => { - const plugin = unpluginRouterGeneratorFactory({ - routesDirectory: routesDir, - generatedRouteTree, - virtualRouteConfig: rootRoute('__root.tsx', [ - physical('/ext', externalDir), - ]), - disableLogging: true, - }) + it( + 'regenerates routeTree on add/remove in an external physical mount', + { timeout: 20_000 }, + async () => { + server = await createServer({ + root: fixtureDir, + configFile: false, + logLevel: 'silent', + appType: 'custom', + server: { middlewareMode: true, watch: {} }, + plugins: [ + tanstackRouterGenerator({ + routesDirectory: routesDir, + generatedRouteTree, + virtualRouteConfig: rootRoute('__root.tsx', [ + physical('/ext', externalDir), + ]), + disableLogging: true, + }), + ], + }) - const viteHooks = plugin.vite as { - configResolved: (config: { root: string }) => Promise - configureServer: (server: { - watcher: chokidar.FSWatcher - }) => void | Promise - } + await waitUntil(() => + routeTreeIncludes(generatedRouteTree, "'/ext/alpha'"), + ) - await viteHooks.configResolved({ root: fixtureDir }) - await waitUntil(() => routeTreeIncludes(generatedRouteTree, "'/ext/alpha'")) + // Short settle after each fs mutation — the plugin debounces and the + // generator may run multiple passes for a single chokidar burst. + const settle = () => new Promise((r) => setTimeout(r, 500)) - watcher = chokidar.watch(routesDir, { ignoreInitial: true }) - await new Promise((resolve) => watcher!.once('ready', resolve)) - await viteHooks.configureServer({ watcher }) + const betaPath = path.join(externalDir, 'beta.tsx') + await writeFile(betaPath, makeRouteFile('/ext/beta')) + await settle() + await waitUntil(() => + routeTreeIncludes(generatedRouteTree, "'/ext/beta'"), + ) - // Add a new route file in the external mount. - const betaPath = path.join(externalDir, 'beta.tsx') - await writeFile(betaPath, makeRouteFile('/ext/beta')) - - await waitUntil(() => routeTreeIncludes(generatedRouteTree, "'/ext/beta'")) - - // Removing the file should likewise trigger regeneration. - await rm(betaPath) - await waitUntil( - async () => !(await routeTreeIncludes(generatedRouteTree, "'/ext/beta'")), - ) - }) + await rm(betaPath) + await settle() + await waitUntil( + async () => + !(await routeTreeIncludes(generatedRouteTree, "'/ext/beta'")), + ) + }, + ) }) From c2e92320b94713bd527a49172b8c854e1fcd8568 Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Thu, 16 Apr 2026 01:38:53 +0200 Subject: [PATCH 6/7] test: increase timeout values for external physical mount tests --- .../tests/router-generator-plugin-watcher.test.ts | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts index a543b26921..ea33cedebb 100644 --- a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts +++ b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts @@ -19,7 +19,7 @@ export const Route = createFileRoute('${routePath}')({ component: () => null }) async function waitUntil( condition: () => boolean | Promise, - { timeoutMs = 10_000, intervalMs = 50 } = {}, + { timeoutMs = 20_000, intervalMs = 50 } = {}, ) { const start = Date.now() while (Date.now() - start < timeoutMs) { @@ -70,14 +70,17 @@ describe('router-generator-plugin vite watcher', () => { it( 'regenerates routeTree on add/remove in an external physical mount', - { timeout: 20_000 }, + { timeout: 30_000 }, async () => { server = await createServer({ root: fixtureDir, configFile: false, logLevel: 'silent', appType: 'custom', - server: { middlewareMode: true, watch: {} }, + server: { + middlewareMode: true, + watch: { usePolling: true, interval: 100 }, + }, plugins: [ tanstackRouterGenerator({ routesDirectory: routesDir, @@ -96,7 +99,7 @@ describe('router-generator-plugin vite watcher', () => { // Short settle after each fs mutation — the plugin debounces and the // generator may run multiple passes for a single chokidar burst. - const settle = () => new Promise((r) => setTimeout(r, 500)) + const settle = () => new Promise((r) => setTimeout(r, 1000)) const betaPath = path.join(externalDir, 'beta.tsx') await writeFile(betaPath, makeRouteFile('/ext/beta')) From c207ebbb19ffed904051b0589f6393bbf2f210ef Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Thu, 16 Apr 2026 02:05:51 +0200 Subject: [PATCH 7/7] fix: adjust timeout values and improve temporary directory handling in tests --- .../router-generator-plugin-watcher.test.ts | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts index ea33cedebb..1fce84bb63 100644 --- a/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts +++ b/packages/router-plugin/tests/router-generator-plugin-watcher.test.ts @@ -1,5 +1,5 @@ import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises' -import { tmpdir } from 'node:os' +import { fileURLToPath } from 'node:url' import path from 'node:path' import { afterEach, beforeEach, describe, it } from 'vitest' import { createServer } from 'vite' @@ -19,7 +19,7 @@ export const Route = createFileRoute('${routePath}')({ component: () => null }) async function waitUntil( condition: () => boolean | Promise, - { timeoutMs = 20_000, intervalMs = 50 } = {}, + { timeoutMs = 10_000, intervalMs = 50 } = {}, ) { const start = Date.now() while (Date.now() - start < timeoutMs) { @@ -46,7 +46,12 @@ describe('router-generator-plugin vite watcher', () => { let server: ViteDevServer | undefined beforeEach(async () => { - fixtureDir = await mkdtemp(path.join(tmpdir(), 'tsr-plugin-watcher-')) + // Use a directory within the package to avoid cross-device rename errors: + // the generator writes temp files to .tanstack/tmp/ then does an atomic + // rename(), which fails with EXDEV when tmpdir() is on another device. + fixtureDir = await mkdtemp( + path.join(path.dirname(fileURLToPath(import.meta.url)), 'tmp-watcher-'), + ) routesDir = path.join(fixtureDir, 'routes') externalDir = path.join(fixtureDir, 'external') generatedRouteTree = path.join(fixtureDir, 'routeTree.gen.ts') @@ -77,10 +82,7 @@ describe('router-generator-plugin vite watcher', () => { configFile: false, logLevel: 'silent', appType: 'custom', - server: { - middlewareMode: true, - watch: { usePolling: true, interval: 100 }, - }, + server: { middlewareMode: true, watch: {} }, plugins: [ tanstackRouterGenerator({ routesDirectory: routesDir, @@ -99,7 +101,7 @@ describe('router-generator-plugin vite watcher', () => { // Short settle after each fs mutation — the plugin debounces and the // generator may run multiple passes for a single chokidar burst. - const settle = () => new Promise((r) => setTimeout(r, 1000)) + const settle = () => new Promise((r) => setTimeout(r, 500)) const betaPath = path.join(externalDir, 'beta.tsx') await writeFile(betaPath, makeRouteFile('/ext/beta'))