fix: not all pages are pre-rendered

docs/start/framework/react/guide/static-prerendering.md

@@ -25,6 +25,9 @@ export default defineConfig({
         // Enable if you need pages to be at `/page/index.html` instead of `/page.html`
         autoSubfolderIndex: true,
 
+        // If disabled, only the root path or the paths defined in the pages config will be prerendered
+        autoStaticPathsDiscovery: true,
+
         // How many prerender jobs to run at once
         concurrency: 14,
 
@@ -40,13 +43,20 @@ export default defineConfig({
         // Delay between retries in milliseconds
         retryDelay: 1000,
 
+        // Maximum number of redirects to follow during prerendering
+        maxRedirects: 5,
+
+        // Fail if an error occurs during prerendering
+        failOnError: true,
+
         // Callback when page is successfully rendered
         onSuccess: ({ page }) => {
           console.log(`Rendered ${page.path}!`)
         },
       },
-      // Optional configuration for specific pages (without this it will still automatically
-      // prerender all routes)
+      // Optional configuration for specific pages
+      // Note: When autoStaticPathsDiscovery is enabled (default), discovered static
+      // routes will be merged with the pages specified below
       pages: [
         {
           path: '/my-page',
@@ -58,3 +68,21 @@ export default defineConfig({
   ],
 })
 ```
+
+## Automatic Static Route Discovery
+
+All static paths will be automatically discovered and seamlessly merged with the specified `pages` config
+
+Routes are excluded from automatic discovery in the following cases:
+
+- Routes with path parameters (e.g., `/users/$userId`) since they require specific parameter values
+- Layout routes (prefixed with `_`) since they don't render standalone pages
+- Routes without components (e.g., API routes)
+
+Note: Dynamic routes can still be prerendered if they are linked from other pages when `crawlLinks` is enabled.
+
+## Crawling Links
+
+When `crawlLinks` is enabled (default: `true`), TanStack Start will extract links from prerendered pages and prerender those linked pages as well.
+
+For example, if `/` contains a link to `/posts`, then `/posts` will also be automatically prerendered.

docs/start/framework/solid/guide/static-prerendering.md

@@ -25,6 +25,9 @@ export default defineConfig({
         // Enable if you need pages to be at `/page/index.html` instead of `/page.html`
         autoSubfolderIndex: true,
 
+        // If disabled, only the root path or the paths defined in the pages config will be prerendered
+        autoStaticPathsDiscovery: true,
+
         // How many prerender jobs to run at once
         concurrency: 14,
 
@@ -40,13 +43,20 @@ export default defineConfig({
         // Delay between retries in milliseconds
         retryDelay: 1000,
 
+        // Maximum number of redirects to follow during prerendering
+        maxRedirects: 5,
+
+        // Fail if an error occurs during prerendering
+        failOnError: true,
+
         // Callback when page is successfully rendered
         onSuccess: ({ page }) => {
           console.log(`Rendered ${page.path}!`)
         },
       },
-      // Optional configuration for specific pages (without this it will still automatically
-      // prerender all routes)
+      // Optional configuration for specific pages
+      // Note: When autoStaticPathsDiscovery is enabled (default), discovered static
+      // routes will be merged with the pages specified below
       pages: [
         {
           path: '/my-page',
@@ -58,3 +68,21 @@ export default defineConfig({
   ],
 })
 ```
+
+## Automatic Static Route Discovery
+
+All static paths will be automatically discovered and seamlessly merged with the specified `pages` config
+
+Routes are excluded from automatic discovery in the following cases:
+
+- Routes with path parameters (e.g., `/users/$userId`) since they require specific parameter values
+- Layout routes (prefixed with `_`) since they don't render standalone pages
+- Routes without components (e.g., API routes)
+
+Note: Dynamic routes can still be prerendered if they are linked from other pages when `crawlLinks` is enabled.
+
+## Crawling Links
+
+When `crawlLinks` is enabled (default: `true`), TanStack Start will extract links from prerendered pages and prerender those linked pages as well.
+
+For example, if `/` contains a link to `/posts`, then `/posts` will also be automatically prerendered.

e2e/react-start/basic/package.json

@@ -8,11 +8,15 @@
     "dev:e2e": "vite dev",
     "build": "vite build && tsc --noEmit",
     "build:spa": "MODE=spa vite build && tsc --noEmit",
+    "build:prerender": "MODE=prerender vite build && tsc --noEmit",
     "start": "pnpx srvx --prod -s ../client  dist/server/server.js",
     "start:spa": "node server.js",
+    "test:e2e:startDummyServer": "node -e 'import(\"./tests/setup/global.setup.ts\").then(m => m.default())' &",
+    "test:e2e:stopDummyServer": "node -e 'import(\"./tests/setup/global.teardown.ts\").then(m => m.default())'",
     "test:e2e:spaMode": "rm -rf port*.txt; MODE=spa playwright test --project=chromium",
     "test:e2e:ssrMode": "rm -rf port*.txt; playwright test --project=chromium",
-    "test:e2e": "pnpm run test:e2e:spaMode && pnpm run test:e2e:ssrMode"
+    "test:e2e:prerender": "rm -rf port*.txt; MODE=prerender playwright test --project=chromium",
+    "test:e2e": "pnpm run test:e2e:spaMode && pnpm run test:e2e:ssrMode && pnpm run test:e2e:prerender"
   },
   "dependencies": {
     "@tanstack/react-router": "workspace:^",

e2e/react-start/basic/playwright.config.ts

@@ -4,6 +4,7 @@ import {
   getTestServerPort,
 } from '@tanstack/router-e2e-utils'
 import { isSpaMode } from './tests/utils/isSpaMode'
+import { isPrerender } from './tests/utils/isPrerender'
 import packageJson from './package.json' with { type: 'json' }
 
 const PORT = await getTestServerPort(
@@ -16,8 +17,15 @@ const EXTERNAL_PORT = await getDummyServerPort(packageJson.name)
 const baseURL = `http://localhost:${PORT}`
 const spaModeCommand = `pnpm build:spa && pnpm start:spa`
 const ssrModeCommand = `pnpm build && pnpm start`
+const prerenderModeCommand = `pnpm run test:e2e:startDummyServer && pnpm build:prerender && pnpm run test:e2e:stopDummyServer && pnpm start`
 
+const getCommand = () => {
+  if (isSpaMode) return spaModeCommand
+  if (isPrerender) return prerenderModeCommand
+  return ssrModeCommand
+}
 console.log('running in spa mode: ', isSpaMode.toString())
+console.log('running in prerender mode: ', isPrerender.toString())
 /**
  * See https://playwright.dev/docs/test-configuration.
  */
@@ -35,7 +43,7 @@ export default defineConfig({
   },
 
   webServer: {
-    command: isSpaMode ? spaModeCommand : ssrModeCommand,
+    command: getCommand(),
     url: baseURL,
     reuseExistingServer: !process.env.CI,
     stdout: 'pipe',

e2e/react-start/basic/tests/prerendering.spec.ts

@@ -0,0 +1,53 @@
+import { existsSync, readFileSync } from 'node:fs'
+import { join } from 'node:path'
+import { expect } from '@playwright/test'
+import { test } from '@tanstack/router-e2e-utils'
+import { isPrerender } from './utils/isPrerender'
+
+test.describe('Prerender Static Path Discovery', () => {
+  test.skip(!isPrerender, 'Skipping since not in prerender mode')
+  test.describe('Build Output Verification', () => {
+    test('should automatically discover and prerender static routes', () => {
+      // Check that static routes were automatically discovered and prerendered
+      const distDir = join(process.cwd(), 'dist', 'client')
+
+      // These static routes should be automatically discovered and prerendered
+      expect(existsSync(join(distDir, 'index.html'))).toBe(true)
+      expect(existsSync(join(distDir, 'posts.html'))).toBe(true)
+      expect(existsSync(join(distDir, 'users.html'))).toBe(true)
+      expect(existsSync(join(distDir, 'deferred.html'))).toBe(true)
+      expect(existsSync(join(distDir, 'scripts.html'))).toBe(true)
+      expect(existsSync(join(distDir, 'inline-scripts.html'))).toBe(true)
+      expect(existsSync(join(distDir, '대한민국.html'))).toBe(true)
+
+      // Pathless layouts should NOT be prerendered (they start with _)
+      expect(existsSync(join(distDir, '_layout', 'index.html'))).toBe(false) // /_layout
+
+      // API routes should NOT be prerendered
+
+      expect(existsSync(join(distDir, 'api', 'users', 'index.html'))).toBe(
+        false,
+      ) // /api/users
+    })
+  })
+
+  test.describe('Static Files Verification', () => {
+    test('should contain prerendered content in posts.html', () => {
+      const distDir = join(process.cwd(), 'dist', 'client')
+      expect(existsSync(join(distDir, 'posts.html'))).toBe(true)
+
+      // "Select a post." should be in the prerendered HTML
+      const html = readFileSync(join(distDir, 'posts.html'), 'utf-8')
+      expect(html).toContain('Select a post.')
+    })
+
+    test('should contain prerendered content in users.html', () => {
+      const distDir = join(process.cwd(), 'dist', 'client')
+      expect(existsSync(join(distDir, 'users.html'))).toBe(true)
+
+      // "Select a user." should be in the prerendered HTML
+      const html = readFileSync(join(distDir, 'users.html'), 'utf-8')
+      expect(html).toContain('Select a user.')
+    })
+  })
+})

e2e/react-start/basic/tests/search-params.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from '@playwright/test'
 import { test } from '@tanstack/router-e2e-utils'
 import { isSpaMode } from 'tests/utils/isSpaMode'
+import { isPrerender } from './utils/isPrerender'
 import type { Response } from '@playwright/test'
 
 function expectRedirect(response: Response | null, endsWith: string) {
@@ -27,7 +28,7 @@ test.describe('/search-params/loader-throws-redirect', () => {
   }) => {
     const response = await page.goto('/search-params/loader-throws-redirect')
 
-    if (!isSpaMode) {
+    if (!isSpaMode && !isPrerender) {
       expectRedirect(response, '/search-params/loader-throws-redirect?step=a')
     }
 
@@ -52,7 +53,7 @@ test.describe('/search-params/default', () => {
     page,
   }) => {
     const response = await page.goto('/search-params/default')
-    if (!isSpaMode) {
+    if (!isSpaMode && !isPrerender) {
       expectRedirect(response, '/search-params/default?default=d1')
     }
     await expect(page.getByTestId('search-default')).toContainText('d1')
@@ -65,7 +66,7 @@ test.describe('/search-params/default', () => {
   test('Directly visiting the route with search param set', async ({
     page,
   }) => {
-    const response = await page.goto('/search-params/default/?default=d2')
+    const response = await page.goto('/search-params/default?default=d2')
     expectNoRedirect(response)
 
     await expect(page.getByTestId('search-default')).toContainText('d2')

e2e/react-start/basic/tests/utils/isPrerender.ts

@@ -0,0 +1 @@
+export const isPrerender: boolean = process.env.MODE === 'prerender'

e2e/react-start/basic/vite.config.ts

@@ -3,6 +3,7 @@ import tsConfigPaths from 'vite-tsconfig-paths'
 import { tanstackStart } from '@tanstack/react-start/plugin/vite'
 import viteReact from '@vitejs/plugin-react'
 import { isSpaMode } from './tests/utils/isSpaMode'
+import { isPrerender } from './tests/utils/isPrerender'
 
 const spaModeConfiguration = {
   enabled: true,
@@ -11,6 +12,19 @@ const spaModeConfiguration = {
   },
 }
 
+const prerenderConfiguration = {
+  enabled: true,
+  filter: (page: { path: string }) =>
+    ![
+      '/this-route-does-not-exist',
+      '/redirect',
+      '/i-do-not-exist',
+      '/not-found/via-beforeLoad',
+      '/not-found/via-loader',
+    ].some((p) => page.path.includes(p)),
+  maxRedirects: 100,
+}
+
 export default defineConfig({
   server: {
     port: 3000,
@@ -22,6 +36,7 @@ export default defineConfig({
     // @ts-ignore we want to keep one test with verboseFileRoutes off even though the option is hidden
     tanstackStart({
       spa: isSpaMode ? spaModeConfiguration : undefined,
+      prerender: isPrerender ? prerenderConfiguration : undefined,
     }),
     viteReact(),
   ],

packages/router-generator/src/index.ts

@@ -27,6 +27,7 @@ export {
   format,
   removeExt,
   checkRouteFullPathUniqueness,
+  inferFullPath,
 } from './utils'
 
 export type {

packages/start-plugin-core/src/global.d.ts

@@ -3,5 +3,6 @@ import type { Manifest } from '@tanstack/router-core'
 /* eslint-disable no-var */
 declare global {
   var TSS_ROUTES_MANIFEST: Manifest
+  var TSS_PRERENDABLE_PATHS: Array<{ path: string }> | undefined
 }
 export {}