Skip to content
Source
Sign inSign up
TanStack/router

Prerender ignores Vite's root: `vite build <dir>` and `createBuilder({ root })` fail from another folder #8825

Send to my agent
Openloriensleafs(GitHub profile, opens in a new tab) opened this issue 0 comments

Which project does this relate to?

Start

Describe the bug

When Vite's root is not the working directory, the prerender step after vite build fails. The client and SSR builds succeed.

Prerender resolves paths against process.cwd() instead of the build's resolved root, in three places (@tanstack/start-plugin-core 1.171.55, same code on main):

  1. src/vite/prerender.ts L68-74: vite.preview() gets only configFile, so the preview config takes its root from process.cwd(). The Start plugin then looks for srcDirectory under the working directory, and the preview server fails to start.
  2. src/vite/preview-server-plugin/plugin.ts L39-43: getServerOutputDirectory(server.config) returns the relative build.outDir (dist/server), and pathToFileURL() resolves it against process.cwd(). The prerender request for / returns 500.
  3. src/vite/prerender.ts L29 and src/vite/post-server-build.ts L18: the client output directory stays relative. src/prerender.ts L194-195 (path.resolve(outputDir, …)) and the sitemap step then write index.html, pages.json and sitemap.xml to <cwd>/dist/client. The build exits 0, so this one is silent.

Vite keeps build.outDir relative in the resolved config and resolves it with path.resolve(config.root, outDir) itself.

Complete minimal reproducer

Reproduction repository: https://github.com/loriensleafs/tanstack-start-prerender-root-repro

The files, all in repro/project/:

package.json

{
  "name": "start-prerender-root-repro",
  "private": true,
  "type": "module",
  "scripts": { "build": "vite build" },
  "dependencies": {
    "@tanstack/react-router": "1.170.46",
    "@tanstack/react-start": "1.169.4",
    "react": "19.3.1",
    "react-dom": "19.3.1"
  },
  "devDependencies": {
    "@vitejs/plugin-react": "6.1.2",
    "vite": "8.3.5"
  }
}

vite.config.ts

import { tanstackStart } from '@tanstack/react-start/plugin/vite'
import viteReact from '@vitejs/plugin-react'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    tanstackStart({
      srcDirectory: 'app',
      prerender: { enabled: true },
    }),
    viteReact(),
  ],
})

build.ts (the programmatic form)

import { createBuilder } from 'vite'

const builder = await createBuilder({ root: import.meta.dirname })
await builder.buildApp()

app/router.tsx

import { createRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'

export function getRouter() {
  return createRouter({ routeTree })
}

app/routes/__root.tsx

import { HeadContent, Outlet, Scripts, createRootRoute } from '@tanstack/react-router'

export const Route = createRootRoute({
  head: () => ({ meta: [{ charSet: 'utf-8' }, { title: 'Repro' }] }),
  component: () => (
    <html>
      <head>
        <HeadContent />
      </head>
      <body>
        <Outlet />
        <Scripts />
      </body>
    </html>
  ),
})

app/routes/index.tsx

import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/')({
  component: () => <h1>Hello from the prerender</h1>,
})

Steps to Reproduce the Bug

  1. cd repro/project && bun install

  2. bun --bun vite build: passes, and dist/client/index.html is written.

  3. rm -rf dist && cd .. (now in repro/)

  4. bun --bun project/node_modules/.bin/vite build project: fails after the client and SSR builds:

    error during build:
    Error: Failed to start the Vite preview server for prerendering
      [cause]: Error: Could not resolve entry for router entry: router in /path/to/repro/app
  5. bun --bun project/build.ts: the same error (createBuilder({ root })).

Each of the following runs starts from repro/:

vite.config.ts changeResult
noneFails: router in /path/to/repro/app (step 4)
none, default src/ and no srcDirectoryFails: router in /path/to/repro/src
root: import.meta.dirnamePreview starts, prerender fails: Failed to fetch /: Internal Server Error, from Cannot find module '/path/to/repro/dist/server/server.js'
root + absolute environments.ssr.build.outDir (and sitemap.enabled)Exit 0, but index.html, pages.json and sitemap.xml go to /path/to/repro/dist/client/, and project/dist/client/ holds only assets/
root + absolute build.outDirPasses
nitro() added (nitro 3.0.260903-beta), no rootFails: router in /path/to/repro/app
nitro() added + root: import.meta.dirnamePasses

Expected behavior

As a user, I expected vite build project and createBuilder({ root }) to prerender the same as vite build from inside project/, with all output under project/dist/. Instead, the prerender looks for the source and the build output under the working directory, and fails or writes the pages there.

Screenshots or Videos

N/A (build time).

Platform

  • Router / Start Version: @tanstack/react-start 1.169.4 (@tanstack/start-plugin-core 1.171.55, the latest on npm), @tanstack/react-router 1.170.46
  • OS: macOS (arm64)
  • Browser: N/A (build time)
  • Browser Version: N/A
  • Bundler: vite (@vitejs/plugin-react 6.1.2, React 19.3.1)
  • Bundler Version: 8.3.5
  • Runtime: Bun 1.4.4 (bun --bun). Not tried with Node.

Additional context

Workaround. With Nitro, set root: import.meta.dirname in vite.config.ts. Without Nitro, also set an absolute build.outDir:

import { join } from 'node:path'

export default defineConfig({
  root: import.meta.dirname,
  build: { outDir: join(import.meta.dirname, 'dist') },
  // plugins as above
})

Suggested fix. Pass the resolved root to the preview server, and resolve both output directories against it:

// src/vite/prerender.ts
-  const outputDir = clientEnv.config.build.outDir
+  const outputDir = path.resolve(clientEnv.config.root, clientEnv.config.build.outDir)
 …
     return await vite.preview({
       configFile: viteConfig.configFile,
+      root: viteConfig.root,
       preview: { port: 0, open: false },
     })

// src/vite/preview-server-plugin/plugin.ts
-  const serverOutputDir = getServerOutputDirectory(server.config)
+  const serverOutputDir = path.resolve(server.config.root, getServerOutputDirectory(server.config))

// src/vite/post-server-build.ts
-  return getClientOutputDirectory(builder.config)
+  return path.resolve(builder.config.root, getClientOutputDirectory(builder.config))

I patched these edits into dist/esm of 1.171.55. With them, steps 4 and 5 pass with the config above plus sitemap: { enabled: true, host }, all output lands in project/dist/client/, and nothing is written to repro/. Step 2 still passes, and the Nitro variant passes without root.

Related. #7593 and #8615 forward configLoader in the same vite.preview() call. #8430 moves that call into a worker, and it still passes only configFile. Neither passes root.

Separately, @tanstack/router-generator (src/config.ts, resolveTmpDir) resolves tmpDir against process.cwd(), so an empty .tanstack/tmp folder appears in the working directory. It does not break the build.

This report was drafted with AI assistance. Each run above was made on the versions listed.

Sign in to join this conversation.