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

edge-manifest.test.ts

218 lines6.9 KB

1import { describe, expect, it, vi } from 'vitest'
2​
3import {
4 createApp,
5 createMemoryEnvironment,
6 finalizeAddOns,
7 getAllAddOns,
8 getFrameworkById,
9 populateAddOnOptionsDefaults,
10} from '../src/edge.js'
11import { getAllAddOns as getAllNodeAddOns } from '../src/add-ons.js'
12import { createFrameworkDefinition as createReactFrameworkDefinition } from '../src/frameworks/react/index.js'
13import { createFrameworkDefinition as createSolidFrameworkDefinition } from '../src/frameworks/solid/index.js'
14​
15import type {
16 AddOn,
17 Framework,
18 FrameworkDefinition,
19 Options,
20} from '../src/types.js'
21​
22function frameworkFromDefinition(definition: FrameworkDefinition): Framework {
23 const { addOns, base, ...rest } = definition
24​
25 return {
26 ...rest,
27 getFiles: () => Promise.resolve(Object.keys(base)),
28 getFileContents: (path: string) => Promise.resolve(base[path]),
29 getDeletedFiles: () => Promise.resolve([]),
30 getAddOns: () => addOns,
31 }
33​
34async function materializeFiles(bundle: {
35 getFiles: () => Promise<Array<string>>
36 getFileContents: (path: string) => Promise<string>
37}) {
38 const files: Record<string, string> = {}
39 for (const file of (await bundle.getFiles()).sort()) {
40 files[file] = await bundle.getFileContents(file)
41 }
42 return files
44​
45async function materializeAddOn(addOn: AddOn) {
46 const {
47 getFiles: _getFiles,
48 getFileContents: _getFileContents,
49 getDeletedFiles: _getDeletedFiles,
50 files: _files,
51 deletedFiles: _deletedFiles,
52 ...metadata
53 } = addOn
54​
55 return JSON.parse(
56 JSON.stringify({
57 ...metadata,
58 files: await materializeFiles(addOn),
59 deletedFiles: (await addOn.getDeletedFiles()).sort(),
60 }),
61 )
63​
64async function materializeAddOns(addOns: Array<AddOn>) {
65 const materialized = await Promise.all(addOns.map(materializeAddOn))
66 return materialized.sort((a, b) => a.id.localeCompare(b.id))
68​
69describe('@tanstack/create/edge manifest', () => {
70 it.each([
71 ['react', createReactFrameworkDefinition],
72 ['solid', createSolidFrameworkDefinition],
73 ])('matches the Node-scanned %s framework catalog', async (frameworkId, scan) => {
74 const nodeDefinition = scan()
75 const nodeFramework = frameworkFromDefinition(nodeDefinition)
76 const edgeFramework = getFrameworkById(frameworkId)
77​
78 expect(edgeFramework).toBeDefined()
79 expect(edgeFramework?.id).toBe(nodeDefinition.id)
80 expect(edgeFramework?.name).toBe(nodeDefinition.name)
81 expect(edgeFramework?.description).toBe(nodeDefinition.description)
82 expect(edgeFramework?.version).toBe(nodeDefinition.version)
83 expect(edgeFramework?.bundlers).toEqual(nodeDefinition.bundlers)
84 expect(edgeFramework?.defaultBundler).toBe(nodeDefinition.defaultBundler)
85 expect(edgeFramework?.supportedModes).toEqual(nodeDefinition.supportedModes)
86 expect(edgeFramework?.basePackageJSON).toEqual(
87 nodeDefinition.basePackageJSON,
88 )
89 expect(edgeFramework?.optionalPackages).toEqual(
90 nodeDefinition.optionalPackages,
91 )
92 expect(await materializeFiles(edgeFramework!)).toEqual(nodeDefinition.base)
93 expect(await materializeAddOns(edgeFramework!.getAddOns())).toEqual(
94 await materializeAddOns(nodeFramework.getAddOns()),
95 )
96 })
97​
98 it('renders an Rsbuild app from the edge manifest', async () => {
99 try {
100 vi.stubGlobal(
101 'fetch',
102 vi.fn(
103 async () =>
104 new Response(JSON.stringify({ version: '1.0.0' }), {
105 status: 200,
106 }),
107 ),
108 )
109​
110 const framework = getFrameworkById('solid')
111 const { environment, output } = createMemoryEnvironment()
112​
113 await createApp(environment, {
114 projectName: 'rsbuild-app',
115 targetDir: '/rsbuild-app',
116 framework: framework!,
117 mode: 'file-router',
118 bundler: 'rsbuild',
119 typescript: true,
120 tailwind: true,
121 packageManager: 'pnpm',
122 git: false,
123 install: false,
124 intent: false,
125 chosenAddOns: [],
126 addOnOptions: {},
127 includeExamples: false,
128 } satisfies Options)
129​
130 expect(output.files).toHaveProperty('/rsbuild-app/rsbuild.config.ts')
131 expect(output.files).not.toHaveProperty('/rsbuild-app/vite.config.ts')
132 expect(JSON.parse(output.files['/rsbuild-app/.cta.json']).bundler).toBe(
133 'rsbuild',
134 )
135 } finally {
136 vi.unstubAllGlobals()
137 }
138 })
139​
140 it('returns the same React add-ons as the Node filesystem-backed path', () => {
141 const nodeFramework = frameworkFromDefinition(createReactFrameworkDefinition())
142 const edgeFramework = getFrameworkById('react')
143​
144 expect(edgeFramework).toBeDefined()
145 expect(getAllAddOns(edgeFramework!, 'file-router').map((addOn) => addOn.id))
146 .toEqual(
147 getAllNodeAddOns(nodeFramework, 'file-router').map((addOn) => addOn.id),
148 )
149 })
150​
151 it('generates a React app from the manifest-backed catalog', async () => {
152 try {
153 vi.stubGlobal(
154 'fetch',
155 vi.fn(async () => {
156 return new Response(JSON.stringify({ version: '1.0.0' }), {
157 status: 200,
158 })
159 }),
160 )
161​
162 const framework = getFrameworkById('react')
163 expect(framework).toBeDefined()
164​
165 const featureIds = getAllAddOns(framework!, 'file-router').map(
166 (addOn) => addOn.id,
167 )
168 expect(featureIds).toContain('tanstack-query')
169 expect(featureIds).toContain('clerk')
170 expect(featureIds).toContain('cloudflare')
171​
172 const chosenAddOns = await finalizeAddOns(framework!, 'file-router', [
173 'tanstack-query',
174 'clerk',
175 'cloudflare',
176 'biome',
177 ])
178 const addOnOptions = populateAddOnOptionsDefaults(chosenAddOns)
179 const { environment, output } = createMemoryEnvironment('/worker-app')
180​
181 await createApp(environment, {
182 projectName: 'worker-app',
183 targetDir: '/worker-app',
184 framework: framework!,
185 mode: 'file-router',
186 typescript: true,
187 tailwind: true,
188 packageManager: 'pnpm',
189 git: false,
190 install: false,
191 intent: false,
192 chosenAddOns,
193 addOnOptions,
194 includeExamples: false,
195 } satisfies Options)
196​
197 const packageJSON = JSON.parse(output.files['package.json'])
198​
199 expect(packageJSON.scripts.dev).toBe('vite dev --port 3000')
200 expect(packageJSON.scripts.deploy).toBe(
201 'pnpm run build && wrangler deploy',
202 )
203 expect(packageJSON.dependencies).toHaveProperty('@tanstack/react-start')
204 expect(packageJSON.dependencies).toHaveProperty('@tanstack/react-query')
205 expect(packageJSON.dependencies).toHaveProperty(
206 '@clerk/tanstack-react-start',
207 )
208 expect(packageJSON.devDependencies).toHaveProperty('wrangler')
209 expect(output.files['wrangler.jsonc']).toContain('tanstack-start-app')
210 expect(output.files['.env.example']).toContain(
211 'VITE_CLERK_PUBLISHABLE_KEY=',
212 )
213 expect(output.files['src/routes/index.tsx']).toContain('createFileRoute')
214 } finally {
215 vi.unstubAllGlobals()
216 }
217 })
218})