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

framework-template.test.ts

124 lines4.0 KB

1import { describe, expect, it } from 'vitest'
2​
3import { createMemoryEnvironment } from '../src/environment.js'
4import { createFrameworkDefinition as createReactFrameworkDefinition } from '../src/frameworks/react/index.js'
5import { createFrameworkDefinition as createSolidFrameworkDefinition } from '../src/frameworks/solid/index.js'
6import { createTemplateFile } from '../src/template-file.js'
7​
8import type { FrameworkDefinition, Options } from '../src/types.js'
9​
10async function renderRouterOnlyEntries(
11 framework: FrameworkDefinition,
12 query = false,
13) {
14 const { environment, output } = createMemoryEnvironment()
15 const { base, addOns, ...definition } = framework
16 const options: Options = {
17 projectName: 'test',
18 targetDir: '/test',
19 framework: {
20 ...definition,
21 getFiles: async () => Object.keys(base),
22 getFileContents: async (path) => base[path],
23 getDeletedFiles: async () => [],
24 getAddOns: () => addOns,
25 },
26 chosenAddOns: query
27 ? addOns.filter((addOn) => addOn.id === 'tanstack-query')
28 : [],
29 addOnOptions: {},
30 packageManager: 'pnpm',
31 typescript: true,
32 tailwind: true,
33 mode: 'file-router',
34 routerOnly: true,
35 git: false,
36 install: false,
37 intent: false,
38 }
39 const templateFile = createTemplateFile(environment, options)
40​
41 environment.startRun()
42 await templateFile('src/main.tsx.ejs', framework.base['src/main.tsx.ejs'])
43 await templateFile('src/router.tsx.ejs', framework.base['src/router.tsx.ejs'])
44 environment.finishRun()
45​
46 return {
47 main: output.files['/test/src/main.tsx'],
48 router: output.files['/test/src/router.tsx'],
49 }
51​
52describe('framework templates', () => {
53 it.each([
54 ['React', createReactFrameworkDefinition],
55 ['Solid', createSolidFrameworkDefinition],
56 ])(
57 '%s gitignore does not exclude the generated route tree',
58 (_, createDefinition) => {
59 const framework = createDefinition()
60​
61 expect(framework.base._dot_gitignore).not.toContain(
62 'src/routeTree.gen.ts',
63 )
64 },
65 )
66​
67 it.each([
68 ['React', createReactFrameworkDefinition],
69 ['Solid', createSolidFrameworkDefinition],
70 ])('%s defaults to Vite and offers Rsbuild', (_, createDefinition) => {
71 const framework = createDefinition()
72​
73 expect(framework.defaultBundler).toBe('vite')
74 expect(framework.bundlers?.map((bundler) => bundler.id)).toEqual([
75 'vite',
76 'rsbuild',
77 ])
78 })
79​
80 it.each([
81 [
82 'React',
83 createReactFrameworkDefinition,
84 '@tanstack/react-router',
85 "import { getRouter } from './router'",
86 ],
87 [
88 'Solid',
89 createSolidFrameworkDefinition,
90 '@tanstack/solid-router',
91 "import { getRouter } from './router'",
92 ],
93 ])(
94 '%s router-only main uses the shared router factory',
95 async (_, createDefinition, routerPackage, getRouterImport) => {
96 const { main, router } = await renderRouterOnlyEntries(createDefinition())
97​
98 expect(main).toContain(getRouterImport)
99 expect(main).toContain(
100 `import { RouterProvider } from '${routerPackage}'`,
101 )
102 expect(main).toContain('const router = getRouter()')
103 expect(main).toContain(`<RouterProvider router={router} />`)
104 expect(main).not.toContain('createRouter')
105 expect(main).not.toContain(`declare module '${routerPackage}'`)
106 expect(router).toContain('export function getRouter()')
107 expect(router).toContain(`declare module '${routerPackage}'`)
108 expect(router).toContain('router: ReturnType<typeof getRouter>')
109 },
110 )
111 it.each([
112 ['React', createReactFrameworkDefinition],
113 ['Solid', createSolidFrameworkDefinition],
114 ])(
115 '%s router-only Query uses a browser provider without an SSR dependency',
116 async (_, createDefinition) => {
117 const { router } = await renderRouterOnlyEntries(createDefinition(), true)
118 expect(router).toContain('QueryClientProvider')
119 expect(router).toContain('client={context.queryClient}')
120 expect(router).not.toContain('react-router-ssr-query')
121 expect(router).not.toContain('setupRouterSsrQueryIntegration')
122 },
123 )
124})