Open History to see the last commit
1import { createRouterPluginContext } from '@tanstack/router-plugin/context'
2import {
3 tanStackRouterCodeSplitter,
4 tanstackRouterGenerator,
5} from '@tanstack/router-plugin/vite'
6import path from 'pathe'
7import { normalizePath } from 'vite'
8import { VITE_ENVIRONMENT_NAMES } from '../../constants'
9import { routesManifestPlugin } from '../../start-router-plugin/generator-plugins/routes-manifest-plugin'
10import { prerenderRoutesPlugin } from '../../start-router-plugin/generator-plugins/prerender-routes-plugin'
11import { buildRouteTreeFileFooterFromConfig } from '../../start-router-plugin/route-tree-footer'
12import { pruneServerOnlySubtrees } from '../../start-router-plugin/pruneServerOnlySubtrees'
13import { SERVER_PROP } from '../../start-router-plugin/constants'
14import type { GetConfigFn } from '../../types'
15import type { TanStackStartVitePluginCoreOptions } from '../types'
16import type {
17 Generator,
18 GeneratorPlugin,
19 RouteNode,
20} from '@tanstack/router-generator'
21import type { DevEnvironment, Plugin, PluginOption } from 'vite'
22import type { TanStackStartInputConfig } from '../../schema'
23β
24function isServerOnlyNode(node: RouteNode | undefined) {
25 if (!node?.createFileRouteProps) {
26 return false
27 }
28 return (
29 node.createFileRouteProps.has(SERVER_PROP) &&
30 node.createFileRouteProps.size === 1
31 )
32}
33β
34export function tanStackStartRouter(
35 startPluginOpts: TanStackStartInputConfig,
36 getConfig: GetConfigFn,
37 corePluginOpts: TanStackStartVitePluginCoreOptions,
38): Array<PluginOption> {
39 const routerPluginContext = createRouterPluginContext()
40β
41 const getGeneratedRouteTreePath = () => {
42 const { startConfig } = getConfig()
43 return path.resolve(startConfig.router.generatedRouteTree)
44 }
45β
46 let clientEnvironment: DevEnvironment | null = null
47 function invalidate() {
48 if (!clientEnvironment) {
49 return
50 }
51β
52 const mod = clientEnvironment.moduleGraph.getModuleById(
53 getGeneratedRouteTreePath(),
54 )
55 if (mod) {
56 clientEnvironment.moduleGraph.invalidateModule(mod)
57 }
58 clientEnvironment.hot.send({ type: 'full-reload', path: '*' })
59 }
60β
61 let generatorInstance: Generator | null = null
62β
63 const clientTreeGeneratorPlugin: GeneratorPlugin = {
64 name: 'start-client-tree-plugin',
65 init({ generator }) {
66 generatorInstance = generator
67 },
68 afterTransform({ node, prevNode }) {
69 if (isServerOnlyNode(node) !== isServerOnlyNode(prevNode)) {
70 invalidate()
71 }
72 },
73 }
74β
75 let routeTreeFileFooter: Array<string> | null = null
76β
77 function getRouteTreeFileFooter() {
78 if (routeTreeFileFooter) {
79 return routeTreeFileFooter
80 }
81 routeTreeFileFooter = [
82 ...buildRouteTreeFileFooterFromConfig({
83 generatedRouteTreePath: getGeneratedRouteTreePath(),
84 getConfig,
85 corePluginOpts,
86 }),
87 ]
88 return routeTreeFileFooter
89 }
90β
91 let resolvedGeneratedRouteTreePath: string | null = null
92 const clientTreePlugin: Plugin = {
93 name: 'tanstack-start:route-tree-client-plugin',
94 enforce: 'pre',
95 applyToEnvironment: (env) => env.name === VITE_ENVIRONMENT_NAMES.client,
96 configureServer(server) {
97 clientEnvironment = server.environments[VITE_ENVIRONMENT_NAMES.client]
98 },
99 config() {
100 type LoadObjectHook = Extract<
101 typeof clientTreePlugin.load,
102 { filter?: unknown }
103 >
104 resolvedGeneratedRouteTreePath = normalizePath(
105 getGeneratedRouteTreePath(),
106 )
107 ;(clientTreePlugin.load as LoadObjectHook).filter = {
108 id: { include: new RegExp(resolvedGeneratedRouteTreePath) },
109 }
110 },
111β
112 load: {
113 filter: {
114 // this will be set in the config hook above since it relies on `config` hook being called first
115 },
116 async handler() {
117 if (!generatorInstance) {
118 throw new Error('Generator instance not initialized')
119 }
120 const crawlingResult = await generatorInstance.getCrawlingResult()
121 if (!crawlingResult) {
122 throw new Error('Crawling result not available')
123 }
124 const prunedAcc = pruneServerOnlySubtrees(crawlingResult)
125 const acc = {
126 ...crawlingResult.acc,
127 ...prunedAcc,
128 }
129 const buildResult = generatorInstance.buildRouteTree({
130 ...crawlingResult,
131 acc,
132 config: {
133 // importRoutesUsingAbsolutePaths: true,
134 // addExtensions: true,
135 disableTypes: true,
136 enableRouteTreeFormatting: false,
137 routeTreeFileHeader: [],
138 routeTreeFileFooter: [],
139 },
140 })
141 return { code: buildResult.routeTreeContent, map: null }
142 },
143 },
144 }
145 return [
146 clientTreePlugin,
147 tanstackRouterGenerator(() => {
148 const routerConfig = getConfig().startConfig.router
149 const plugins = [clientTreeGeneratorPlugin, routesManifestPlugin()]
150 if (startPluginOpts.prerender?.enabled === true) {
151 plugins.push(prerenderRoutesPlugin())
152 }
153 return {
154 ...routerConfig,
155 target: corePluginOpts.framework,
156 routeTreeFileFooter: getRouteTreeFileFooter,
157 plugins,
158 }
159 }, routerPluginContext),
160 tanStackRouterCodeSplitter(() => {
161 const routerConfig = getConfig().startConfig.router
162 return {
163 ...routerConfig,
164 codeSplittingOptions: {
165 ...routerConfig.codeSplittingOptions,
166 deleteNodes: ['ssr', 'server', 'headers'],
167 addHmr: true,
168 },
169 plugin: {
170 vite: { environmentName: VITE_ENVIRONMENT_NAMES.client },
171 },
172 }
173 }, routerPluginContext),
174 tanStackRouterCodeSplitter(() => {
175 const routerConfig = getConfig().startConfig.router
176 return {
177 ...routerConfig,
178 codeSplittingOptions: {
179 ...routerConfig.codeSplittingOptions,
180 addHmr: false,
181 },
182 plugin: {
183 vite: { environmentName: VITE_ENVIRONMENT_NAMES.server },
184 },
185 }
186 }, routerPluginContext),
187 ]
188}