chore(start-plugin-core): reorganize and centralize the plugin orchestration (#4266)

Author: SeanCassiere

packages/start-plugin-core/src/constants.ts

@@ -4,3 +4,6 @@ export const VITE_ENVIRONMENT_NAMES = {
   server: 'ssr',
   client: 'client',
 } as const
+
+export const CLIENT_DIST_DIR = '.tanstack-start/build/client-dist'
+export const SSR_ENTRY_FILE = 'ssr.mjs'

packages/start-plugin-core/src/extractHtmlScripts.ts renamed to packages/start-plugin-core/src/dev-server-plugin/extract-html-scripts.ts

@@ -1,7 +1,7 @@
 import { createEvent, getHeader, sendWebResponse } from 'h3'
 import { isRunnableDevEnvironment } from 'vite'
-import { extractHtmlScripts } from '../extractHtmlScripts'
 import { VITE_ENVIRONMENT_NAMES } from '../constants'
+import { extractHtmlScripts } from './extract-html-scripts'
 import type { Connect, DevEnvironment, Plugin, ViteDevServer } from 'vite'
 
 declare global {

packages/start-plugin-core/src/nitro/dev-server-plugin.ts renamed to packages/start-plugin-core/src/dev-server-plugin/plugin.ts

@@ -0,0 +1,17 @@
+import * as vite from 'vite'
+import type { TanStackStartOutputConfig } from '../plugin'
+
+export function loadEnvPlugin(
+  startOpts: TanStackStartOutputConfig,
+): vite.Plugin {
+  return {
+    name: 'tanstack-vite-plugin-nitro-load-env',
+    enforce: 'pre',
+    config(userConfig, envConfig) {
+      Object.assign(
+        process.env,
+        vite.loadEnv(envConfig.mode, userConfig.root ?? startOpts.root, ''),
+      )
+    },
+  }
+}

packages/start-plugin-core/src/load-env-plugin/plugin.ts

@@ -1,8 +1,8 @@
 import { writeFileSync } from 'node:fs'
 import path from 'node:path'
 import { create } from 'xmlbuilder2'
-import { createLogger } from './utils'
-import type { TanStackStartOutputConfig } from './plugin'
+import { createLogger } from '../utils'
+import type { TanStackStartOutputConfig } from '../plugin'
 import type { XMLBuilder } from 'xmlbuilder2/lib/interfaces'
 
 export type SitemapUrl = {

packages/start-plugin-core/src/build-sitemap.ts renamed to packages/start-plugin-core/src/nitro-plugin/build-sitemap.ts

@@ -2,12 +2,13 @@ import path from 'node:path'
 import { rmSync } from 'node:fs'
 import { build, copyPublicAssets, createNitro, prepare } from 'nitropack'
 import { dirname, resolve } from 'pathe'
-import { loadEnv } from 'vite'
-import { clientDistDir, ssrEntryFile } from '../plugin'
-import { prerender } from '../prerender'
-import { VITE_ENVIRONMENT_NAMES } from '../constants'
-import { buildSitemap } from '../build-sitemap'
-import { devServerPlugin } from './dev-server-plugin'
+import {
+  CLIENT_DIST_DIR,
+  SSR_ENTRY_FILE,
+  VITE_ENVIRONMENT_NAMES,
+} from '../constants'
+import { buildSitemap } from './build-sitemap'
+import { prerender } from './prerender'
 import type {
   EnvironmentOptions,
   PluginOption,
@@ -17,28 +18,13 @@ import type {
 import type { Nitro, NitroConfig } from 'nitropack'
 import type { TanStackStartOutputConfig } from '../plugin'
 
-function setupLoadEnv(startOpts: TanStackStartOutputConfig): PluginOption {
-  return {
-    name: 'tanstack-vite-plugin-nitro-load-env',
-    enforce: 'pre',
-    config(userConfig, envConfig) {
-      Object.assign(
-        process.env,
-        loadEnv(envConfig.mode, userConfig.root ?? startOpts.root, ''),
-      )
-    },
-  }
-}
-
 export function nitroPlugin(
   options: TanStackStartOutputConfig,
   getSsrBundle: () => Rollup.OutputBundle,
 ): Array<PluginOption> {
   const buildPreset =
     process.env['START_TARGET'] ?? (options.target as string | undefined)
   return [
-    setupLoadEnv(options),
-    devServerPlugin(),
     {
       name: 'tanstack-vite-plugin-nitro',
       configEnvironment(name) {
@@ -77,7 +63,7 @@ export function nitroPlugin(
 
               // Build the client bundle
               // i.e client entry file with `hydrateRoot(...)`
-              const clientOutputDir = resolve(options.root, clientDistDir)
+              const clientOutputDir = resolve(options.root, CLIENT_DIST_DIR)
               rmSync(clientOutputDir, { recursive: true, force: true })
               await builder.build(client)
 
@@ -93,7 +79,7 @@ export function nitroPlugin(
                 baseURL: globalThis.TSS_APP_BASE,
                 publicAssets: [
                   {
-                    dir: path.resolve(options.root, clientDistDir),
+                    dir: path.resolve(options.root, CLIENT_DIST_DIR),
                     baseURL: '/',
                     maxAge: 31536000, // 1 year
                   },
@@ -102,7 +88,7 @@ export function nitroPlugin(
                   generateTsConfig: false,
                 },
                 prerender: undefined,
-                renderer: ssrEntryFile,
+                renderer: SSR_ENTRY_FILE,
                 plugins: [], // Nitro's plugins
                 appConfigFiles: [],
                 scanDirs: [],

packages/start-plugin-core/src/nitro/nitro-plugin.ts renamed to packages/start-plugin-core/src/nitro-plugin/plugin.ts

@@ -4,13 +4,13 @@ import path from 'node:path'
 import { getRollupConfig } from 'nitropack/rollup'
 import { build as buildNitro, createNitro } from 'nitropack'
 import { joinURL, withBase, withoutBase } from 'ufo'
+import { VITE_ENVIRONMENT_NAMES } from '../constants'
+import { createLogger } from '../utils'
 import { Queue } from './queue'
-import { VITE_ENVIRONMENT_NAMES } from './constants'
-import { createLogger } from './utils'
 import type { ViteBuilder } from 'vite'
 import type { $Fetch, Nitro } from 'nitropack'
-import type { TanStackStartOutputConfig } from './plugin'
-import type { Page } from './schema'
+import type { TanStackStartOutputConfig } from '../plugin'
+import type { Page } from '../schema'
 
 export async function prerender({
   options,

packages/start-plugin-core/src/prerender.ts renamed to packages/start-plugin-core/src/nitro-plugin/prerender.ts

@@ -5,11 +5,18 @@ import { tanstackRouter } from '@tanstack/router-plugin/vite'
 import { TanStackServerFnPluginEnv } from '@tanstack/server-functions-plugin'
 import * as vite from 'vite'
 import { createTanStackConfig } from './schema'
-import { nitroPlugin } from './nitro/nitro-plugin'
-import { startManifestPlugin } from './routesManifestPlugin'
-import { TanStackStartCompilerPlugin } from './start-compiler-plugin'
-import { VITE_ENVIRONMENT_NAMES } from './constants'
+import { nitroPlugin } from './nitro-plugin/plugin'
+import { startRoutesManifestPlugin } from './start-routes-manifest-plugin/plugin'
+import { startCompilerPlugin } from './start-compiler-plugin'
+import {
+  CLIENT_DIST_DIR,
+  SSR_ENTRY_FILE,
+  VITE_ENVIRONMENT_NAMES,
+} from './constants'
 import { TanStackStartServerRoutesVite } from './start-server-routes-plugin/plugin'
+import { loadEnvPlugin } from './load-env-plugin/plugin'
+import { devServerPlugin } from './dev-server-plugin/plugin'
+import { resolveVirtualEntriesPlugin } from './resolve-virtual-entries-plugin/plugin'
 import type { createTanStackStartOptionsSchema } from './schema'
 import type { PluginOption, Rollup } from 'vite'
 import type { z } from 'zod'
@@ -33,9 +40,6 @@ declare global {
   var TSS_APP_BASE: string
 }
 
-export const clientDistDir = '.tanstack-start/build/client-dist'
-export const ssrEntryFile = 'ssr.mjs'
-
 export interface TanStackStartVitePluginCoreOptions {
   framework: CompileStartFrameworkOptions
   getVirtualServerRootHandler: (ctx: {
@@ -111,7 +115,7 @@ export function TanStackStartVitePluginCore(
                     main: getClientEntryPath(startConfig),
                   },
                   output: {
-                    dir: path.resolve(startConfig.root, clientDistDir),
+                    dir: path.resolve(startConfig.root, CLIENT_DIST_DIR),
                   },
                   // TODO: this should be removed
                   external: ['node:fs', 'node:path', 'node:os', 'node:crypto'],
@@ -128,7 +132,7 @@ export function TanStackStartVitePluginCore(
                 copyPublicDir: false,
                 rollupOptions: {
                   output: {
-                    entryFileNames: ssrEntryFile,
+                    entryFileNames: SSR_ENTRY_FILE,
                   },
                   plugins: [
                     {
@@ -179,7 +183,7 @@ export function TanStackStartVitePluginCore(
       },
     },
     // N.B. TanStackStartCompilerPlugin must be before the TanStackServerFnPluginEnv
-    TanStackStartCompilerPlugin(opts.framework, {
+    startCompilerPlugin(opts.framework, {
       client: { envName: VITE_ENVIRONMENT_NAMES.client },
       server: { envName: VITE_ENVIRONMENT_NAMES.server },
     }),
@@ -213,7 +217,9 @@ export function TanStackStartVitePluginCore(
         return serverEnv.runner.import(fn.extractedFilename)
       },
     }),
-    startManifestPlugin(startConfig),
+    loadEnvPlugin(startConfig),
+    startRoutesManifestPlugin(startConfig),
+    devServerPlugin(),
     nitroPlugin(startConfig, () => ssrBundle),
     TanStackStartServerRoutesVite({
       ...startConfig.tsr,
@@ -222,63 +228,6 @@ export function TanStackStartVitePluginCore(
   ]
 }
 
-function resolveVirtualEntriesPlugin(
-  opts: TanStackStartVitePluginCoreOptions,
-  startConfig: TanStackStartOutputConfig,
-): PluginOption {
-  let resolvedConfig: vite.ResolvedConfig
-
-  const modules = new Set<string>([
-    '/~start/server-entry',
-    '/~start/default-server-entry',
-    '/~start/default-client-entry',
-  ])
-
-  return {
-    name: 'tanstack-start-core:resolve-virtual-entries',
-    configResolved(config) {
-      resolvedConfig = config
-    },
-    resolveId(id) {
-      if (modules.has(id)) {
-        return `${id}.tsx`
-      }
-
-      return undefined
-    },
-    load(id) {
-      const routerFilepath = vite.normalizePath(
-        path.resolve(startConfig.root, startConfig.tsr.srcDirectory, 'router'),
-      )
-
-      if (id === '/~start/server-entry.tsx') {
-        const ssrEntryFilepath = startConfig.serverEntryPath.startsWith(
-          '/~start/default-server-entry',
-        )
-          ? startConfig.serverEntryPath
-          : vite.normalizePath(
-              path.resolve(resolvedConfig.root, startConfig.serverEntryPath),
-            )
-
-        return opts.getVirtualServerRootHandler({
-          routerFilepath,
-          serverEntryFilepath: ssrEntryFilepath,
-        })
-      }
-
-      if (id === '/~start/default-client-entry.tsx') {
-        return opts.getVirtualClientEntry({ routerFilepath })
-      }
-
-      if (id === '/~start/default-server-entry.tsx') {
-        return opts.getVirtualServerEntry({ routerFilepath })
-      }
-
-      return undefined
-    },
-  }
-}
-
 function defineReplaceEnv<TKey extends string, TValue extends string>(
   key: TKey,
   value: TValue,

packages/start-plugin-core/src/queue.ts renamed to packages/start-plugin-core/src/nitro-plugin/queue.ts

@@ -0,0 +1,63 @@
+import path from 'node:path'
+import * as vite from 'vite'
+import type {
+  TanStackStartOutputConfig,
+  TanStackStartVitePluginCoreOptions,
+} from '../plugin'
+
+export function resolveVirtualEntriesPlugin(
+  opts: TanStackStartVitePluginCoreOptions,
+  startConfig: TanStackStartOutputConfig,
+): vite.Plugin {
+  let resolvedConfig: vite.ResolvedConfig
+
+  const modules = new Set<string>([
+    '/~start/server-entry',
+    '/~start/default-server-entry',
+    '/~start/default-client-entry',
+  ])
+
+  return {
+    name: 'tanstack-start-core:resolve-virtual-entries',
+    configResolved(config) {
+      resolvedConfig = config
+    },
+    resolveId(id) {
+      if (modules.has(id)) {
+        return `${id}.tsx`
+      }
+
+      return undefined
+    },
+    load(id) {
+      const routerFilepath = vite.normalizePath(
+        path.resolve(startConfig.root, startConfig.tsr.srcDirectory, 'router'),
+      )
+
+      if (id === '/~start/server-entry.tsx') {
+        const ssrEntryFilepath = startConfig.serverEntryPath.startsWith(
+          '/~start/default-server-entry',
+        )
+          ? startConfig.serverEntryPath
+          : vite.normalizePath(
+              path.resolve(resolvedConfig.root, startConfig.serverEntryPath),
+            )
+
+        return opts.getVirtualServerRootHandler({
+          routerFilepath,
+          serverEntryFilepath: ssrEntryFilepath,
+        })
+      }
+
+      if (id === '/~start/default-client-entry.tsx') {
+        return opts.getVirtualClientEntry({ routerFilepath })
+      }
+
+      if (id === '/~start/default-server-entry.tsx') {
+        return opts.getVirtualServerEntry({ routerFilepath })
+      }
+
+      return undefined
+    },
+  }
+}

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

@@ -24,7 +24,7 @@ const transformFuncs = [
 
 const tokenRegex = new RegExp(transformFuncs.join('|'))
 
-export function TanStackStartCompilerPlugin(
+export function startCompilerPlugin(
   framework: CompileStartFrameworkOptions,
   inputOpts?: {
     client?: {

packages/start-plugin-core/src/resolve-virtual-entries-plugin/plugin.ts

@@ -2,15 +2,15 @@ import { mkdirSync, readFileSync, rmSync, writeFile } from 'node:fs'
 import path from 'node:path'
 import { joinURL } from 'ufo'
 import { rootRouteId } from '@tanstack/router-core'
-import { resolveViteId } from './utils'
+import { resolveViteId } from '../utils'
 import type {
   PluginOption,
   ResolvedConfig,
   Manifest as ViteManifest,
   ManifestChunk as ViteManifestChunk,
 } from 'vite'
 import type { Manifest, RouterManagedTag } from '@tanstack/router-core'
-import type { TanStackStartOutputConfig } from './plugin'
+import type { TanStackStartOutputConfig } from '../plugin'
 
 const getCSSRecursively = (
   file: ViteManifestChunk,
@@ -44,7 +44,7 @@ const getCSSRecursively = (
   return result
 }
 
-export function startManifestPlugin(
+export function startRoutesManifestPlugin(
   opts: TanStackStartOutputConfig,
 ): PluginOption {
   let config: ResolvedConfig