Open History to see the last commit
1import { describe, expect, it } from 'vitest'
2
3import { createPackageJSON, mergePackageJSON } from '../src/package-json.js'
4import type { Options, Framework } from '../src/types.js'
5
6describe('Conditional Package Dependencies', () => {
7 const baseFramework = {
8 basePackageJSON: {
9 version: '1.0.0',
10 type: 'module'
11 },
12 optionalPackages: {}
13 } as unknown as Framework
14
15 const baseOptions = {
16 projectName: 'test-app',
17 framework: baseFramework,
18 mode: 'file-router',
19 typescript: true,
20 tailwind: false,
21 packageManager: 'pnpm',
22 chosenAddOns: [],
23 addOnOptions: {}
24 } as unknown as Options
25
26 describe('EJS Template Processing', () => {
27 it('should process packageTemplate with conditional dependencies', () => {
28 const options = {
29 ...baseOptions,
30 chosenAddOns: [
31 {
32 id: 'testAddon',
33 name: 'Drizzle ORM',
34 packageTemplate: `{
35 "dependencies": {
36 "testAddon-orm": "^0.29.0"<% if (addOnOption.testAddon.database === 'postgres') { %>,
37 "postgres": "^3.4.0"<% } %><% if (addOnOption.testAddon.database === 'mysql') { %>,
38 "mysql2": "^3.6.0"<% } %><% if (addOnOption.testAddon.database === 'sqlite') { %>,
39 "better-sqlite3": "^8.7.0"<% } %>
40 },
41 "devDependencies": {<% if (addOnOption.testAddon.database === 'postgres') { %>
42 "@types/postgres": "^3.0.0"<% } %><% if (addOnOption.testAddon.database === 'mysql') { %>
43 "@types/mysql2": "^3.0.0"<% } %><% if (addOnOption.testAddon.database === 'sqlite') { %>
44 "@types/better-sqlite3": "^7.6.0"<% } %>
45 }
46 }`
47 }
48 ],
49 addOnOptions: {
50 testAddon: {
51 database: 'postgres'
52 }
53 }
54 }
55
56 const packageJSON = createPackageJSON(options)
57
58 expect(packageJSON.dependencies).toEqual({
59 'testAddon-orm': '^0.29.0',
60 'postgres': '^3.4.0'
61 })
62 expect(packageJSON.devDependencies).toEqual({
63 '@types/postgres': '^3.0.0'
64 })
65 // MySQL and SQLite dependencies should not be included
66 expect(packageJSON.dependencies).not.toHaveProperty('mysql2')
67 expect(packageJSON.dependencies).not.toHaveProperty('better-sqlite3')
68 expect(packageJSON.devDependencies).not.toHaveProperty('@types/mysql2')
69 expect(packageJSON.devDependencies).not.toHaveProperty('@types/better-sqlite3')
70 })
71
72 it('should handle different database options correctly', () => {
73 const options = {
74 ...baseOptions,
75 chosenAddOns: [
76 {
77 id: 'testAddon',
78 name: 'Drizzle ORM',
79 packageTemplate: `{
80 "dependencies": {
81 "testAddon-orm": "^0.29.0"<% if (addOnOption.testAddon.database === 'postgres') { %>,
82 "postgres": "^3.4.0"<% } %><% if (addOnOption.testAddon.database === 'mysql') { %>,
83 "mysql2": "^3.6.0"<% } %><% if (addOnOption.testAddon.database === 'sqlite') { %>,
84 "better-sqlite3": "^8.7.0"<% } %>
85 }
86 }`
87 }
88 ],
89 addOnOptions: {
90 testAddon: {
91 database: 'mysql'
92 }
93 }
94 }
95
96 const packageJSON = createPackageJSON(options)
97
98 expect(packageJSON.dependencies).toEqual({
99 'testAddon-orm': '^0.29.0',
100 'mysql2': '^3.6.0'
101 })
102 // PostgreSQL and SQLite dependencies should not be included
103 expect(packageJSON.dependencies).not.toHaveProperty('postgres')
104 expect(packageJSON.dependencies).not.toHaveProperty('better-sqlite3')
105 })
106
107 it('should handle SQLite option correctly', () => {
108 const options = {
109 ...baseOptions,
110 chosenAddOns: [
111 {
112 id: 'testAddon',
113 name: 'Drizzle ORM',
114 packageTemplate: `{
115 "dependencies": {
116 "testAddon-orm": "^0.29.0"<% if (addOnOption.testAddon.database === 'postgres') { %>,
117 "postgres": "^3.4.0"<% } %><% if (addOnOption.testAddon.database === 'mysql') { %>,
118 "mysql2": "^3.6.0"<% } %><% if (addOnOption.testAddon.database === 'sqlite') { %>,
119 "better-sqlite3": "^8.7.0"<% } %>
120 },
121 "devDependencies": {<% if (addOnOption.testAddon.database === 'sqlite') { %>
122 "@types/better-sqlite3": "^7.6.0"<% } %>
123 }
124 }`
125 }
126 ],
127 addOnOptions: {
128 testAddon: {
129 database: 'sqlite'
130 }
131 }
132 }
133
134 const packageJSON = createPackageJSON(options)
135
136 expect(packageJSON.dependencies).toEqual({
137 'testAddon-orm': '^0.29.0',
138 'better-sqlite3': '^8.7.0'
139 })
140 expect(packageJSON.devDependencies).toEqual({
141 '@types/better-sqlite3': '^7.6.0'
142 })
143 })
144
145 it('should handle multiple add-ons with options', () => {
146 const options = {
147 ...baseOptions,
148 chosenAddOns: [
149 {
150 id: 'testAddon',
151 name: 'Drizzle ORM',
152 packageTemplate: `{
153 "dependencies": {
154 "testAddon-orm": "^0.29.0"<% if (addOnOption.testAddon.database === 'postgres') { %>,
155 "postgres": "^3.4.0"<% } %>
156 }
157 }`
158 },
159 {
160 id: 'auth',
161 name: 'Authentication',
162 packageTemplate: `{
163 "dependencies": {<% if (addOnOption.auth.provider === 'auth0') { %>
164 "@auth0/nextjs-auth0": "^3.0.0"<% } %><% if (addOnOption.auth.provider === 'supabase') { %>
165 "@supabase/supabase-js": "^2.0.0"<% } %>
166 }
167 }`
168 }
169 ],
170 addOnOptions: {
171 testAddon: {
172 database: 'postgres'
173 },
174 auth: {
175 provider: 'auth0'
176 }
177 }
178 }
179
180 const packageJSON = createPackageJSON(options)
181
182 expect(packageJSON.dependencies).toEqual({
183 'testAddon-orm': '^0.29.0',
184 'postgres': '^3.4.0',
185 '@auth0/nextjs-auth0': '^3.0.0'
186 })
187 expect(packageJSON.dependencies).not.toHaveProperty('@supabase/supabase-js')
188 })
189
190 it('should handle complex conditional logic', () => {
191 const options = {
192 ...baseOptions,
193 chosenAddOns: [
194 {
195 id: 'ui',
196 name: 'UI Library',
197 packageTemplate: `{
198 "dependencies": {<% if (addOnOption.ui.library === 'chakra') { %>
199 "@chakra-ui/react": "^2.0.0",
200 "@emotion/react": "^11.0.0",
201 "@emotion/styled": "^11.0.0"<% } else if (addOnOption.ui.library === 'mui') { %>
202 "@mui/material": "^5.0.0",
203 "@emotion/react": "^11.0.0",
204 "@emotion/styled": "^11.0.0"<% } else if (addOnOption.ui.library === 'mantine') { %>
205 "@mantine/core": "^7.0.0",
206 "@mantine/hooks": "^7.0.0"<% } %>
207 }
208 }`
209 }
210 ],
211 addOnOptions: {
212 ui: {
213 library: 'mantine'
214 }
215 }
216 }
217
218 const packageJSON = createPackageJSON(options)
219
220 expect(packageJSON.dependencies).toEqual({
221 '@mantine/core': '^7.0.0',
222 '@mantine/hooks': '^7.0.0'
223 })
224 // Other UI library dependencies should not be included
225 expect(packageJSON.dependencies).not.toHaveProperty('@chakra-ui/react')
226 expect(packageJSON.dependencies).not.toHaveProperty('@mui/material')
227 })
228
229 it('should handle scripts conditionally', () => {
230 const options = {
231 ...baseOptions,
232 chosenAddOns: [
233 {
234 id: 'testing',
235 name: 'Testing Setup',
236 packageTemplate: `{
237 "scripts": {<% if (addOnOption.testing.framework === 'jest') { %>
238 "test": "jest",
239 "test:watch": "jest --watch"<% } else if (addOnOption.testing.framework === 'vitest') { %>
240 "test": "vitest",
241 "test:ui": "vitest --ui"<% } %>
242 },
243 "devDependencies": {<% if (addOnOption.testing.framework === 'jest') { %>
244 "jest": "^29.0.0",
245 "@types/jest": "^29.0.0"<% } else if (addOnOption.testing.framework === 'vitest') { %>
246 "vitest": "^1.0.0",
247 "@vitest/ui": "^1.0.0"<% } %>
248 }
249 }`
250 }
251 ],
252 addOnOptions: {
253 testing: {
254 framework: 'vitest'
255 }
256 }
257 }
258
259 const packageJSON = createPackageJSON(options)
260
261 expect(packageJSON.scripts).toEqual({
262 'test': 'vitest',
263 'test:ui': 'vitest --ui'
264 })
265 expect(packageJSON.devDependencies).toEqual({
266 'vitest': '^1.0.0',
267 '@vitest/ui': '^1.0.0'
268 })
269 // Jest-specific scripts and dependencies should not be included
270 expect(packageJSON.scripts).not.toHaveProperty('test:watch')
271 expect(packageJSON.devDependencies).not.toHaveProperty('jest')
272 expect(packageJSON.devDependencies).not.toHaveProperty('@types/jest')
273 })
274
275 it('should fallback to packageAdditions on template error', () => {
276 const options = {
277 ...baseOptions,
278 chosenAddOns: [
279 {
280 id: 'broken',
281 name: 'Broken Template',
282 packageTemplate: `{
283 "dependencies": {
284 "valid-package": "^1.0.0"
285 <% this will cause a syntax error %>
286 }
287 }`,
288 packageAdditions: {
289 dependencies: {
290 'fallback-package': '^1.0.0'
291 }
292 }
293 }
294 ],
295 addOnOptions: {}
296 }
297
298 const packageJSON = createPackageJSON(options)
299
300 // Should use fallback packageAdditions
301 expect(packageJSON.dependencies).toEqual({
302 'fallback-package': '^1.0.0'
303 })
304 expect(packageJSON.dependencies).not.toHaveProperty('valid-package')
305 })
306
307 it('should handle empty or missing addOnOptions', () => {
308 const options = {
309 ...baseOptions,
310 chosenAddOns: [
311 {
312 id: 'simple',
313 name: 'Simple Add-on',
314 packageTemplate: `{
315 "dependencies": {
316 "always-included": "^1.0.0"<% if (addOnOption.simple && addOnOption.simple.feature) { %>,
317 "conditional-package": "^1.0.0"<% } %>
318 }
319 }`
320 }
321 ],
322 addOnOptions: {} // No options for this add-on
323 }
324
325 const packageJSON = createPackageJSON(options)
326
327 expect(packageJSON.dependencies).toEqual({
328 'always-included': '^1.0.0'
329 })
330 expect(packageJSON.dependencies).not.toHaveProperty('conditional-package')
331 })
332
333 it('should preserve dependency sorting after template processing', () => {
334 const options = {
335 ...baseOptions,
336 chosenAddOns: [
337 {
338 id: 'sorting-test',
339 name: 'Sorting Test',
340 packageTemplate: `{
341 "dependencies": {
342 "z-package": "^1.0.0",
343 "a-package": "^1.0.0",
344 "m-package": "^1.0.0"
345 }
346 }`
347 }
348 ],
349 addOnOptions: {}
350 }
351
352 const packageJSON = createPackageJSON(options)
353 const dependencyKeys = Object.keys(packageJSON.dependencies)
354
355 // Dependencies should be sorted alphabetically
356 expect(dependencyKeys).toEqual(['a-package', 'm-package', 'z-package'])
357 })
358 })
359
360 describe('mergePackageJSON', () => {
361 it('should merge dependencies correctly', () => {
362 const base = {
363 dependencies: {
364 'react': '^18.0.0',
365 'lodash': '^4.0.0'
366 },
367 devDependencies: {
368 'typescript': '^5.0.0'
369 }
370 }
371
372 const overlay = {
373 dependencies: {
374 'axios': '^1.0.0',
375 'lodash': '^4.17.0' // Should override
376 },
377 devDependencies: {
378 'jest': '^29.0.0'
379 }
380 }
381
382 const result = mergePackageJSON(base, overlay)
383
384 expect(result.dependencies).toEqual({
385 'react': '^18.0.0',
386 'lodash': '^4.17.0', // Overridden version
387 'axios': '^1.0.0'
388 })
389 expect(result.devDependencies).toEqual({
390 'typescript': '^5.0.0',
391 'jest': '^29.0.0'
392 })
393 })
394
395 it('should handle missing sections gracefully', () => {
396 const base = {
397 dependencies: {
398 'react': '^18.0.0'
399 }
400 }
401
402 const overlay = {
403 devDependencies: {
404 'jest': '^29.0.0'
405 }
406 }
407
408 const result = mergePackageJSON(base, overlay)
409
410 expect(result.dependencies).toEqual({
411 'react': '^18.0.0'
412 })
413 expect(result.devDependencies).toEqual({
414 'jest': '^29.0.0'
415 })
416 })
417 })
418})