Open History to see the last commit
1import { describe, expect, it } from 'vitest'
2
3import { createPackageJSON as createEdgePackageJSON } from '../src/edge-package-json.js'
4import { createPackageJSON } from '../src/package-json.js'
5
6import type { Options, Framework } from '../src/types.js'
7
8describe('createPackageJSON', () => {
9 it.each([
10 ['react', '@tanstack/react-start'],
11 ['solid', '@tanstack/solid-start'],
12 ])(
13 'keeps the router plugin scoped to %s router-only projects',
14 (frameworkId, startPackage) => {
15 const framework = {
16 id: frameworkId,
17 basePackageJSON: {
18 dependencies: {
19 [startPackage]: 'latest',
20 },
21 },
22 optionalPackages: {
23 typescript: {},
24 devtools: {},
25 examples: {},
26 tailwindcss: {},
27 'file-router': {
28 devDependencies: {
29 '@tanstack/router-cli': 'latest',
30 },
31 },
32 },
33 } as unknown as Framework
34 const options = {
35 chosenAddOns: [],
36 addOnOptions: {},
37 mode: 'file-router',
38 typescript: true,
39 tailwind: false,
40 projectName: 'test',
41 packageManager: 'pnpm',
42 framework,
43 } as unknown as Options
44
45 const startPackageJSON = createPackageJSON(options)
46 expect(startPackageJSON.dependencies).toHaveProperty(startPackage, 'latest')
47 expect(startPackageJSON.devDependencies).not.toHaveProperty(
48 '@tanstack/router-plugin',
49 )
50
51 const routerOnlyOptions = {
52 ...options,
53 routerOnly: true,
54 }
55 const routerOnlyPackageJSON = createPackageJSON(routerOnlyOptions)
56
57 expect(routerOnlyPackageJSON.dependencies).not.toHaveProperty(startPackage)
58 expect(routerOnlyPackageJSON.devDependencies).toHaveProperty(
59 '@tanstack/router-plugin',
60 'latest',
61 )
62 expect(createEdgePackageJSON(routerOnlyOptions)).toEqual(
63 routerOnlyPackageJSON,
64 )
65 },
66 )
67
68 it.each([false, true])(
69 'applies a custom framework bundlerFileRouter to file-router apps (routerOnly=%s)',
70 (routerOnly) => {
71 const framework = {
72 id: 'custom',
73 basePackageJSON: {},
74 optionalPackages: {
75 bundlerFileRouter: {
76 vite: {
77 scripts: { routes: 'custom-routes' },
78 devDependencies: { 'custom-routes': '^1.0.0' },
79 },
80 },
81 },
82 } as unknown as Framework
83 const options = {
84 chosenAddOns: [],
85 addOnOptions: {},
86 mode: 'file-router',
87 routerOnly,
88 typescript: true,
89 tailwind: false,
90 projectName: 'test',
91 packageManager: 'pnpm',
92 framework,
93 } as unknown as Options
94
95 const packageJSON = createPackageJSON(options)
96
97 expect(packageJSON.scripts).toHaveProperty('routes', 'custom-routes')
98 expect(packageJSON.devDependencies).toHaveProperty(
99 'custom-routes',
100 '^1.0.0',
101 )
102 expect(createEdgePackageJSON(options)).toEqual(packageJSON)
103 },
104 )
105
106 it('should create a package.json', () => {
107 const packageJSON = createPackageJSON({
108 chosenAddOns: [
109 {
110 packageAdditions: {
111 scripts: {
112 dev: 'file-router dev',
113 },
114 },
115 },
116 ],
117 mode: 'file-router',
118 typescript: true,
119 tailwind: true,
120 projectName: 'test',
121 framework: {
122 basePackageJSON: {},
123 optionalPackages: {
124 typescript: {
125 devDependencies: {
126 typescript: '^5.0.0',
127 },
128 },
129 tailwindcss: {
130 dependencies: {
131 tailwindcss: '^3.0.0',
132 },
133 },
134 'file-router': {
135 dependencies: {
136 'file-router': '^1.0.0',
137 },
138 },
139 },
140 } as unknown as Framework,
141 } as unknown as Options)
142
143 const expected = {
144 name: 'test',
145 devDependencies: {
146 typescript: '^5.0.0',
147 },
148 dependencies: {
149 'file-router': '^1.0.0',
150 tailwindcss: '^3.0.0',
151 },
152 scripts: {
153 dev: 'file-router dev',
154 },
155 }
156
157 // Use JSON.stringify to test sorting order of dependencies
158 expect(JSON.stringify(packageJSON)).toEqual(JSON.stringify(expected))
159 })
160
161 it('should include sqlite build approval for pnpm templates', () => {
162 const packageJSON = createPackageJSON({
163 chosenAddOns: [
164 {
165 packageTemplate:
166 '{"pnpm": {<% if (addOnOption.prisma.database === "sqlite") { %>"onlyBuiltDependencies": ["better-sqlite3"]<% } %>}}',
167 },
168 ],
169 addOnOptions: {
170 prisma: {
171 database: 'sqlite',
172 },
173 },
174 mode: 'file-router',
175 typescript: true,
176 tailwind: true,
177 projectName: 'test',
178 framework: {
179 basePackageJSON: {},
180 optionalPackages: {
181 typescript: {},
182 tailwindcss: {},
183 'file-router': {},
184 },
185 } as unknown as Framework,
186 } as unknown as Options)
187
188 expect(packageJSON.pnpm).toEqual({
189 onlyBuiltDependencies: ['better-sqlite3'],
190 })
191 })
192
193 it('should merge pnpm onlyBuiltDependencies from base and add-ons', () => {
194 const packageJSON = createPackageJSON({
195 chosenAddOns: [
196 {
197 packageTemplate:
198 '{"pnpm": {"onlyBuiltDependencies": ["better-sqlite3"]}}',
199 },
200 ],
201 addOnOptions: {},
202 mode: 'file-router',
203 typescript: true,
204 tailwind: true,
205 projectName: 'test',
206 framework: {
207 basePackageJSON: {
208 pnpm: {
209 onlyBuiltDependencies: ['esbuild', 'lightningcss'],
210 },
211 },
212 optionalPackages: {
213 typescript: {},
214 tailwindcss: {},
215 'file-router': {},
216 },
217 } as unknown as Framework,
218 } as unknown as Options)
219
220 expect(packageJSON.pnpm).toEqual({
221 onlyBuiltDependencies: ['esbuild', 'lightningcss', 'better-sqlite3'],
222 })
223 })
224
225 it('should provide execute command helper in package templates', () => {
226 const packageJSON = createPackageJSON({
227 chosenAddOns: [
228 {
229 packageTemplate:
230 '{"scripts":{"post-cta-init":"<%- getPackageManagerExecuteScript(\'create-db@latest\', [\'--user-agent\', \'tanstack/tsrouter\']) %>"}}',
231 },
232 ],
233 packageManager: 'npm',
234 addOnOptions: {},
235 mode: 'file-router',
236 typescript: true,
237 tailwind: true,
238 projectName: 'test',
239 framework: {
240 basePackageJSON: {},
241 optionalPackages: {
242 typescript: {},
243 tailwindcss: {},
244 'file-router': {},
245 },
246 } as unknown as Framework,
247 } as unknown as Options)
248
249 expect(packageJSON.scripts['post-cta-init']).toBe(
250 'npx -y create-db@latest --user-agent tanstack/tsrouter',
251 )
252 })
253})