Skip to content
Source
Sign inSign up
TanStack/cli
Open History to see the last commit

bundlers.test.ts

276 lines8.9 KB

1import { afterEach, describe, expect, it, vi } from 'vitest'
2​
3import { finalizeAddOns, getAllAddOns } from '../src/add-ons.js'
4import { getBundlers, resolveBundler } from '../src/build-tools.js'
5import { createApp } from '../src/create-app.js'
6import { createMemoryEnvironment } from '../src/environment.js'
7import { createFrameworkDefinition as createReactFrameworkDefinition } from '../src/frameworks/react/index.js'
8import { createFrameworkDefinition as createSolidFrameworkDefinition } from '../src/frameworks/solid/index.js'
9​
10import type {
11 Framework,
12 FrameworkDefinition,
13 Options,
14 Starter,
15} from '../src/types.js'
16​
17function frameworkFromDefinition(definition: FrameworkDefinition): Framework {
18 const { addOns, base, ...framework } = definition
19​
20 return {
21 ...framework,
22 getFiles: () => Promise.resolve(Object.keys(base)),
23 getFileContents: (path: string) => Promise.resolve(base[path]),
24 getDeletedFiles: () => Promise.resolve([]),
25 getAddOns: () => addOns,
26 }
28​
29function createOptions(
30 framework: Framework,
31 bundler: string,
32 routerOnly: boolean,
33 blank: boolean,
34): Options {
35 return {
36 projectName: 'bundler-app',
37 targetDir: '/bundler-app',
38 framework,
39 mode: 'file-router',
40 bundler,
41 typescript: true,
42 tailwind: !blank,
43 packageManager: 'npm',
44 git: false,
45 install: false,
46 intent: false,
47 chosenAddOns: [],
48 addOnOptions: {},
49 projectPreset: blank ? 'blank' : 'default',
50 routerOnly,
51 includeExamples: !blank,
52 }
54​
55afterEach(() => {
56 vi.unstubAllGlobals()
57})
58​
59describe('bundler project generation', () => {
60 it.each([
61 ['react', createReactFrameworkDefinition],
62 ['solid', createSolidFrameworkDefinition],
63 ])(
64 '%s exposes Vite as the default and Rsbuild as a supported bundler',
65 (_, createDefinition) => {
66 const framework = frameworkFromDefinition(createDefinition())
67​
68 expect(getBundlers(framework).map((bundler) => bundler.id)).toEqual([
69 'vite',
70 'rsbuild',
71 ])
72 expect(resolveBundler(framework).id).toBe('vite')
73 },
74 )
75​
76 it('treats custom frameworks without bundler metadata as Vite-only', () => {
77 const framework = {
78 id: 'custom',
79 name: 'Custom',
80 } as Framework
81​
82 expect(getBundlers(framework).map((bundler) => bundler.id)).toEqual([
83 'vite',
84 ])
85 expect(() => resolveBundler(framework, 'rsbuild')).toThrow(
86 'Build tool "rsbuild" is not supported by Custom',
87 )
88 })
89​
90 it('aligns the Solid Biome schema with the pinned package version', async () => {
91 const definition = createSolidFrameworkDefinition()
92 const biome = definition.addOns.find((addOn) => addOn.id === 'biome')!
93 const version = biome.packageAdditions!.devDependencies?.['@biomejs/biome']
94​
95 expect(version).toBe('2.4.5')
96 await expect(biome.getFileContents('biome.json.ejs')).resolves.toContain(
97 `/schemas/${version}/schema.json`,
98 )
99 })
100​
101 it.each([
102 ['react', createReactFrameworkDefinition, 'shadcn'],
103 ['solid', createSolidFrameworkDefinition, 'solid-ui'],
104 ])(
105 '%s filters the Rsbuild catalog to toolchains',
106 async (_, createDefinition, incompatibleAddOn) => {
107 const framework = frameworkFromDefinition(createDefinition())
108 const addOns = getAllAddOns(framework, 'file-router', 'rsbuild')
109​
110 expect(addOns.length).toBeGreaterThan(0)
111 expect(addOns.every((addOn) => addOn.type === 'toolchain')).toBe(true)
112 await expect(
113 finalizeAddOns(framework, 'file-router', ['eslint'], 'rsbuild'),
114 ).resolves.toEqual(
115 expect.arrayContaining([expect.objectContaining({ id: 'eslint' })]),
116 )
117 await expect(
118 finalizeAddOns(
119 framework,
120 'file-router',
121 [incompatibleAddOn],
122 'rsbuild',
123 ),
124 ).rejects.toThrow('Rsbuild currently supports toolchain add-ons only')
125 },
126 )
127​
128 it.each([
129 ['react', createReactFrameworkDefinition],
130 ['solid', createSolidFrameworkDefinition],
131 ])(
132 '%s rejects Rsbuild templates before starting a run',
133 async (_, createDefinition) => {
134 const framework = frameworkFromDefinition(createDefinition())
135 const options = {
136 ...createOptions(framework, 'rsbuild', false, false),
137 starter: { id: 'starter' } as Starter,
138 }
139 const { environment, output } = createMemoryEnvironment()
140​
141 await expect(createApp(environment, options)).rejects.toThrow(
142 'Rsbuild does not currently support templates',
143 )
144 expect(output.files).toEqual({})
145 },
146 )
147​
148 it.each(
149 [
150 ['react', createReactFrameworkDefinition],
151 ['solid', createSolidFrameworkDefinition],
152 ].flatMap(([frameworkId, createDefinition]) =>
153 ['vite', 'rsbuild'].flatMap((bundler) =>
154 [false, true].flatMap((routerOnly) =>
155 [false, true].map((blank) => [
156 frameworkId,
157 createDefinition,
158 bundler,
159 routerOnly,
160 blank,
161 ]),
162 ),
163 ),
164 ),
165 )(
166 '%s generates %s config (routerOnly=%s, blank=%s)',
167 async (frameworkId, createDefinition, bundler, routerOnly, blank) => {
168 vi.stubGlobal(
169 'fetch',
170 vi.fn(
171 async () =>
172 new Response(JSON.stringify({ version: '1.0.0' }), {
173 status: 200,
174 }),
175 ),
176 )
177​
178 const framework = frameworkFromDefinition(
179 (createDefinition as () => FrameworkDefinition)(),
180 )
181 const options = createOptions(
182 framework,
183 bundler as string,
184 routerOnly as boolean,
185 blank as boolean,
186 )
187 const { environment, output } = createMemoryEnvironment()
188​
189 await createApp(environment, options)
190​
191 const files = Object.fromEntries(
192 Object.entries(output.files).map(([path, contents]) => [
193 path.slice(`${options.targetDir}/`.length),
194 contents,
195 ]),
196 )
197 const packageJSON = JSON.parse(files['package.json'])
198 const config = JSON.parse(files['.cta.json'])
199 const configFile = `${bundler}.config.ts`
200 const otherConfig = `${bundler === 'vite' ? 'rsbuild' : 'vite'}.config.ts`
201​
202 expect(files).toHaveProperty(configFile)
203 expect(files).not.toHaveProperty(otherConfig)
204 expect(config.bundler).toBe(bundler)
205 expect(packageJSON.scripts.dev).toBe(`${bundler} dev --port 3000`)
206 expect(packageJSON.scripts.build).toBe(`${bundler} build`)
207 expect(packageJSON.scripts.preview).toBe(`${bundler} preview`)
208 expect(packageJSON.scripts['generate-routes']).toBe(
209 bundler === 'rsbuild'
210 ? 'rsbuild build'
211 : routerOnly
212 ? 'tsr generate'
213 : 'vite build',
214 )
215​
216 if (bundler === 'vite') {
217 expect(packageJSON.devDependencies).toHaveProperty('vite')
218 expect(packageJSON.devDependencies).not.toHaveProperty('@rsbuild/core')
219 expect(files['tsconfig.json']).toContain('vite/client')
220 } else {
221 expect(packageJSON.devDependencies).toHaveProperty('@rsbuild/core')
222 expect(packageJSON.devDependencies).not.toHaveProperty('vite')
223 expect(packageJSON.devDependencies).not.toHaveProperty(
224 '@tanstack/devtools-vite',
225 )
226 expect(files['tsconfig.json']).toContain('@rsbuild/core/types')
227 expect(files).not.toHaveProperty('index.html')
228 }
229​
230 if (blank) {
231 expect(packageJSON.dependencies).not.toHaveProperty('tailwindcss')
232 expect(packageJSON.devDependencies).not.toHaveProperty(
233 bundler === 'vite'
234 ? '@tailwindcss/vite'
235 : '@rsbuild/plugin-tailwindcss',
236 )
237 } else {
238 expect(packageJSON.dependencies).toHaveProperty('tailwindcss')
239 const tailwindPackage =
240 bundler === 'vite'
241 ? packageJSON.dependencies['@tailwindcss/vite']
242 : packageJSON.devDependencies['@rsbuild/plugin-tailwindcss']
243 expect(tailwindPackage).toBeTruthy()
244 }
245​
246 const startPackage =
247 frameworkId === 'react'
248 ? '@tanstack/react-start'
249 : '@tanstack/solid-start'
250 if (routerOnly) {
251 expect(packageJSON.dependencies).not.toHaveProperty(startPackage)
252 expect(packageJSON.devDependencies).toHaveProperty(
253 '@tanstack/router-plugin',
254 )
255 expect(packageJSON.scripts).not.toHaveProperty('start')
256 expect(packageJSON.dependencies).not.toHaveProperty('srvx')
257 expect(files[configFile]).toContain('@tanstack/router-plugin')
258 if (bundler === 'vite') {
259 expect(packageJSON.devDependencies).toHaveProperty(
260 '@tanstack/router-cli',
261 )
262 }
263 } else {
264 expect(packageJSON.dependencies).toHaveProperty(startPackage)
265 expect(packageJSON.devDependencies).not.toHaveProperty(
266 '@tanstack/router-cli',
267 )
268 if (bundler === 'rsbuild') {
269 expect(packageJSON.scripts.start).toContain('srvx')
270 expect(packageJSON.dependencies).toHaveProperty('srvx')
271 expect(files[configFile]).toContain(`${startPackage}/plugin/rsbuild`)
272 }
273 }
274 },
275 )
276})