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

package-json.test.ts

155 lines4.0 KB

1import { describe, expect, it } from 'vitest'
2​
3import { createPackageJSON } from '../src/package-json.js'
4​
5import type { Options, Framework } from '../src/types.js'
6​
7describe('createPackageJSON', () => {
8 it('should create a package.json', () => {
9 const packageJSON = createPackageJSON({
10 chosenAddOns: [
11 {
12 packageAdditions: {
13 scripts: {
14 dev: 'file-router dev',
15 },
16 },
17 },
18 ],
19 mode: 'file-router',
20 typescript: true,
21 tailwind: true,
22 projectName: 'test',
23 framework: {
24 basePackageJSON: {},
25 optionalPackages: {
26 typescript: {
27 devDependencies: {
28 typescript: '^5.0.0',
29 },
30 },
31 tailwindcss: {
32 dependencies: {
33 tailwindcss: '^3.0.0',
34 },
35 },
36 'file-router': {
37 dependencies: {
38 'file-router': '^1.0.0',
39 },
40 },
41 },
42 } as unknown as Framework,
43 } as unknown as Options)
44​
45 const expected = {
46 name: 'test',
47 devDependencies: {
48 typescript: '^5.0.0',
49 },
50 dependencies: {
51 'file-router': '^1.0.0',
52 tailwindcss: '^3.0.0',
53 },
54 scripts: {
55 dev: 'file-router dev',
56 },
57 }
58​
59 // Use JSON.stringify to test sorting order of dependencies
60 expect(JSON.stringify(packageJSON)).toEqual(JSON.stringify(expected))
61 })
62​
63 it('should include sqlite build approval for pnpm templates', () => {
64 const packageJSON = createPackageJSON({
65 chosenAddOns: [
66 {
67 packageTemplate:
68 '{"pnpm": {<% if (addOnOption.prisma.database === "sqlite") { %>"onlyBuiltDependencies": ["better-sqlite3"]<% } %>}}',
69 },
70 ],
71 addOnOptions: {
72 prisma: {
73 database: 'sqlite',
74 },
75 },
76 mode: 'file-router',
77 typescript: true,
78 tailwind: true,
79 projectName: 'test',
80 framework: {
81 basePackageJSON: {},
82 optionalPackages: {
83 typescript: {},
84 tailwindcss: {},
85 'file-router': {},
86 },
87 } as unknown as Framework,
88 } as unknown as Options)
89​
90 expect(packageJSON.pnpm).toEqual({
91 onlyBuiltDependencies: ['better-sqlite3'],
92 })
93 })
94​
95 it('should merge pnpm onlyBuiltDependencies from base and add-ons', () => {
96 const packageJSON = createPackageJSON({
97 chosenAddOns: [
98 {
99 packageTemplate:
100 '{"pnpm": {"onlyBuiltDependencies": ["better-sqlite3"]}}',
101 },
102 ],
103 addOnOptions: {},
104 mode: 'file-router',
105 typescript: true,
106 tailwind: true,
107 projectName: 'test',
108 framework: {
109 basePackageJSON: {
110 pnpm: {
111 onlyBuiltDependencies: ['esbuild', 'lightningcss'],
112 },
113 },
114 optionalPackages: {
115 typescript: {},
116 tailwindcss: {},
117 'file-router': {},
118 },
119 } as unknown as Framework,
120 } as unknown as Options)
121​
122 expect(packageJSON.pnpm).toEqual({
123 onlyBuiltDependencies: ['esbuild', 'lightningcss', 'better-sqlite3'],
124 })
125 })
126​
127 it('should provide execute command helper in package templates', () => {
128 const packageJSON = createPackageJSON({
129 chosenAddOns: [
130 {
131 packageTemplate:
132 '{"scripts":{"post-cta-init":"<%- getPackageManagerExecuteScript(\'create-db@latest\', [\'--user-agent\', \'tanstack/tsrouter\']) %>"}}',
133 },
134 ],
135 packageManager: 'npm',
136 addOnOptions: {},
137 mode: 'file-router',
138 typescript: true,
139 tailwind: true,
140 projectName: 'test',
141 framework: {
142 basePackageJSON: {},
143 optionalPackages: {
144 typescript: {},
145 tailwindcss: {},
146 'file-router': {},
147 },
148 } as unknown as Framework,
149 } as unknown as Options)
150​
151 expect(packageJSON.scripts['post-cta-init']).toBe(
152 'npx -y create-db@latest --user-agent tanstack/tsrouter',
153 )
154 })
155})