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

blank-preset.test.ts

317 lines9.8 KB

1import { afterEach, describe, expect, it, vi } from 'vitest'
2​
3import {
4 finalizeAddOns,
5 populateAddOnOptionsDefaults,
6} from '../src/add-ons.js'
7import { createApp } from '../src/create-app.js'
8import { createMemoryEnvironment } from '../src/environment.js'
9import { createPackageJSON as createEdgePackageJSON } from '../src/edge-package-json.js'
10import { createFrameworkDefinition as createReactFrameworkDefinition } from '../src/frameworks/react/index.js'
11import { createFrameworkDefinition as createSolidFrameworkDefinition } from '../src/frameworks/solid/index.js'
12import { createPackageJSON as createNodePackageJSON } from '../src/package-json.js'
13​
14import type { Framework, FrameworkDefinition, Options } from '../src/types.js'
15​
16const BLANK_FILE_ALLOWLIST = [
17 '.cta.json',
18 '.gitignore',
19 '.vscode/settings.json',
20 'README.md',
21 'package.json',
22 'src/router.tsx',
23 'src/routes/__root.tsx',
24 'src/routes/index.tsx',
25 'src/styles.css',
26 'tsconfig.json',
27 'tsr.config.json',
28 'vite.config.ts',
30​
31const BLANK_DEPENDENCY_ALLOWLIST = [
32 '@tanstack/react-router',
33 '@tanstack/react-start',
34 'react',
35 'react-dom',
37​
38const BLANK_DEV_DEPENDENCY_ALLOWLIST = [
39 '@types/node',
40 '@types/react',
41 '@types/react-dom',
42 '@vitejs/plugin-react',
43 'typescript',
44 'vite',
46​
47function frameworkFromDefinition(definition: FrameworkDefinition): Framework {
48 const { addOns, base, ...framework } = definition
49​
50 return {
51 ...framework,
52 getFiles: () => Promise.resolve(Object.keys(base)),
53 getFileContents: (path: string) => Promise.resolve(base[path]),
54 getDeletedFiles: () => Promise.resolve([]),
55 getAddOns: () => addOns,
56 }
58​
59function createBlankOptions(framework: Framework): Options {
60 return {
61 projectName: 'blank-app',
62 targetDir: '/blank-app',
63 framework,
64 mode: 'file-router',
65 typescript: true,
66 tailwind: false,
67 packageManager: 'npm',
68 git: false,
69 install: false,
70 intent: false,
71 chosenAddOns: [],
72 addOnOptions: {},
73 projectPreset: 'blank',
74 }
76​
77afterEach(() => {
78 vi.unstubAllGlobals()
79})
80​
81describe('blank project preset', () => {
82 it('renders only the blank file allowlist', async () => {
83 vi.stubGlobal(
84 'fetch',
85 vi.fn(
86 async () =>
87 new Response(JSON.stringify({ version: '1.0.0' }), { status: 200 }),
88 ),
89 )
90​
91 const framework = frameworkFromDefinition(createReactFrameworkDefinition())
92 const options = createBlankOptions(framework)
93 const { environment, output } = createMemoryEnvironment()
94​
95 await createApp(environment, options)
96​
97 const files = Object.fromEntries(
98 Object.entries(output.files).map(([path, contents]) => [
99 path.slice(`${options.targetDir}/`.length),
100 contents,
101 ]),
102 )
103​
104 expect(Object.keys(files).sort()).toEqual(BLANK_FILE_ALLOWLIST)
105​
106 const config = JSON.parse(files['.cta.json'])
107 expect(config.projectPreset).toBe('blank')
108 expect(config.tailwind).toBe(false)
109​
110 expect(files['src/routes/__root.tsx']).not.toMatch(
111 /TanStack(?:Router)?Devtools/,
112 )
113 expect(files['src/router.tsx']).not.toContain(
114 'setupRouterSsrQueryIntegration',
115 )
116 expect(files['src/styles.css']).not.toContain('tailwindcss')
117 expect(files['vite.config.ts']).not.toMatch(/devtools|tailwindcss/)
118 expect(files['README.md']).not.toMatch(/Tailwind CSS|Vitest/)
119 expect(files['README.md']).toContain('plain CSS')
120 })
121​
122 it('uses only blank dependencies and keeps Node and edge composition equal', () => {
123 const framework = frameworkFromDefinition(createReactFrameworkDefinition())
124 const options = createBlankOptions(framework)
125​
126 const nodePackageJSON = createNodePackageJSON(options)
127 const edgePackageJSON = createEdgePackageJSON(options)
128​
129 expect(edgePackageJSON).toEqual(nodePackageJSON)
130 expect(Object.keys(nodePackageJSON.scripts).sort()).toEqual([
131 'build',
132 'dev',
133 'generate-routes',
134 'preview',
135 ])
136 expect(Object.keys(nodePackageJSON.dependencies).sort()).toEqual(
137 BLANK_DEPENDENCY_ALLOWLIST,
138 )
139 expect(Object.keys(nodePackageJSON.devDependencies).sort()).toEqual(
140 BLANK_DEV_DEPENDENCY_ALLOWLIST,
141 )
142 })
143​
144 it('keeps the Solid blank preset equally lean', async () => {
145 vi.stubGlobal(
146 'fetch',
147 vi.fn(
148 async () =>
149 new Response(JSON.stringify({ version: '1.0.0' }), { status: 200 }),
150 ),
151 )
152​
153 const framework = frameworkFromDefinition(createSolidFrameworkDefinition())
154 const options = createBlankOptions(framework)
155 const { environment, output } = createMemoryEnvironment()
156​
157 await createApp(environment, options)
158​
159 const files = Object.keys(output.files)
160 .map((path) => path.slice(`${options.targetDir}/`.length))
161 .sort()
162 const packageJSON = createNodePackageJSON(options)
163​
164 expect(files).toEqual(BLANK_FILE_ALLOWLIST)
165 expect(Object.keys(packageJSON.dependencies).sort()).toEqual([
166 '@tanstack/solid-router',
167 '@tanstack/solid-start',
168 'solid-js',
169 ])
170 expect(Object.keys(packageJSON.devDependencies).sort()).toEqual([
171 'typescript',
172 'vite',
173 'vite-plugin-solid',
174 ])
175 expect(output.files['/blank-app/README.md']).toContain('plain CSS')
176 })
177​
178 it('lets an explicit styling add-on opt back into Tailwind', async () => {
179 vi.stubGlobal(
180 'fetch',
181 vi.fn(
182 async () =>
183 new Response(JSON.stringify({ version: '1.0.0' }), { status: 200 }),
184 ),
185 )
186​
187 const framework = frameworkFromDefinition(createReactFrameworkDefinition())
188 const chosenAddOns = await finalizeAddOns(framework, 'file-router', [
189 'shadcn',
190 ])
191 const options = {
192 ...createBlankOptions(framework),
193 tailwind: chosenAddOns.some((addOn) => addOn.tailwind === true),
194 chosenAddOns,
195 addOnOptions: populateAddOnOptionsDefaults(chosenAddOns),
196 }
197 const { environment, output } = createMemoryEnvironment()
198​
199 await createApp(environment, options)
200​
201 const packageJSON = createNodePackageJSON(options)
202 expect(options.tailwind).toBe(true)
203 expect(packageJSON.dependencies).toMatchObject({
204 '@tailwindcss/vite': '^4.1.18',
205 tailwindcss: '^4.1.18',
206 })
207 expect(packageJSON.devDependencies).toMatchObject({
208 '@tailwindcss/typography': '^0.5.16',
209 })
210 expect(output.files['/blank-app/src/styles.css']).toContain(
211 "@plugin '@tailwindcss/typography'",
212 )
213 expect(output.files['/blank-app/vite.config.ts']).toContain('tailwindcss()')
214 expect(output.files['/blank-app/README.md']).toContain('Tailwind CSS')
215 expect(output.files['/blank-app/README.md']).not.toContain('plain CSS')
216 })
217​
218 it('describes Tailwind accurately for a Solid styling add-on', async () => {
219 vi.stubGlobal(
220 'fetch',
221 vi.fn(
222 async () =>
223 new Response(JSON.stringify({ version: '1.0.0' }), { status: 200 }),
224 ),
225 )
226​
227 const framework = frameworkFromDefinition(createSolidFrameworkDefinition())
228 const chosenAddOns = await finalizeAddOns(framework, 'file-router', [
229 'solid-ui',
230 ])
231 const options = {
232 ...createBlankOptions(framework),
233 tailwind: chosenAddOns.some((addOn) => addOn.tailwind === true),
234 chosenAddOns,
235 addOnOptions: populateAddOnOptionsDefaults(chosenAddOns),
236 }
237 const { environment, output } = createMemoryEnvironment()
238​
239 await createApp(environment, options)
240​
241 expect(options.tailwind).toBe(true)
242 expect(output.files['/blank-app/README.md']).toContain('Tailwind CSS')
243 expect(output.files['/blank-app/README.md']).not.toContain('plain CSS')
244 })
245​
246 it('keeps Shopify storefront styling in the blank preset', async () => {
247 vi.stubGlobal(
248 'fetch',
249 vi.fn(
250 async () =>
251 new Response(JSON.stringify({ version: '1.0.0' }), { status: 200 }),
252 ),
253 )
254​
255 const framework = frameworkFromDefinition(createReactFrameworkDefinition())
256 const chosenAddOns = await finalizeAddOns(framework, 'file-router', [
257 'shopify',
258 ])
259 const options = {
260 ...createBlankOptions(framework),
261 tailwind: chosenAddOns.some((addOn) => addOn.tailwind === true),
262 chosenAddOns,
263 addOnOptions: populateAddOnOptionsDefaults(chosenAddOns),
264 }
265 const { environment, output } = createMemoryEnvironment()
266​
267 await createApp(environment, options)
268​
269 const packageJSON = createNodePackageJSON(options)
270 expect(options.tailwind).toBe(true)
271 expect(packageJSON.dependencies).toMatchObject({
272 '@tailwindcss/vite': '^4.1.18',
273 tailwindcss: '^4.1.18',
274 })
275 expect(output.files['/blank-app/src/styles.css']).toContain(
276 '@import "tailwindcss"',
277 )
278 expect(output.files['/blank-app/vite.config.ts']).toContain('tailwindcss()')
279 expect(output.files['/blank-app/src/routes/shop.index.tsx']).toContain(
280 'tracking-tight',
281 )
282 })
283​
284 it('does not keep Tailwind for a stripped add-on demo', async () => {
285 vi.stubGlobal(
286 'fetch',
287 vi.fn(
288 async () =>
289 new Response(JSON.stringify({ version: '1.0.0' }), { status: 200 }),
290 ),
291 )
292​
293 const framework = frameworkFromDefinition(createReactFrameworkDefinition())
294 const chosenAddOns = await finalizeAddOns(framework, 'file-router', [
295 'posthog',
296 ])
297 const options = {
298 ...createBlankOptions(framework),
299 tailwind: chosenAddOns.some((addOn) => addOn.tailwind === true),
300 chosenAddOns,
301 }
302 const { environment, output } = createMemoryEnvironment()
303​
304 await createApp(environment, options)
305​
306 const packageJSON = createNodePackageJSON(options)
307 expect(options.tailwind).toBe(false)
308 expect(packageJSON.dependencies).not.toHaveProperty('@tailwindcss/vite')
309 expect(packageJSON.dependencies).not.toHaveProperty('tailwindcss')
310 expect(output.files['/blank-app/src/styles.css']).not.toContain(
311 'tailwindcss',
312 )
313 expect(output.files).not.toHaveProperty(
314 '/blank-app/src/routes/demo/posthog.tsx',
315 )
316 })
317})