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

shared.test.ts

263 lines7.0 KB

1import { beforeEach, describe, expect, it, vi } from 'vitest'
2import { fs, vol } from 'memfs'
3​
4import {
5 compareFilesRecursively,
6 createAppOptionsFromPersisted,
7 createPackageAdditions,
8 createSerializedOptionsFromPersisted,
9 readCurrentProjectOptions,
10} from '../../src/custom-add-ons/shared.js'
11import { createMemoryEnvironment } from '../../src/environment.js'
12import {
13 __testClearFrameworks,
14 __testRegisterFramework,
15} from '../../src/frameworks.js'
16​
17import type { PersistedOptions } from '../../src/config-file.js'
18​
19vi.mock('node:fs', () => fs)
20vi.mock('node:fs/promises', () => fs.promises)
21​
22beforeEach(() => {
23 vol.reset()
24​
25 const fakeFiles = {
26 'package.json': JSON.stringify({
27 name: 'test',
28 version: '1.0.0',
29 dependencies: {},
30 }),
31 }
32​
33 __testClearFrameworks()
34 __testRegisterFramework({
35 id: 'test',
36 name: 'Test',
37 description: 'Test',
38 version: '1.0.0',
39 baseDirectory: '/foo',
40 addOnsDirectories: [],
41 basePackageJSON: {},
42 optionalPackages: {},
43 supportedModes: {
44 'code-router': {
45 displayName: 'Code Router',
46 description: 'Code Router',
47 },
48 'file-router': {
49 displayName: 'File Router',
50 description: 'File Router',
51 },
52 },
53 getAddOns: () => [
54 {
55 id: 'test',
56 name: 'Test',
57 description: 'Test',
58 version: '1.0.0',
59 type: 'add-on',
60 phase: 'add-on',
61 modes: ['code-router', 'file-router'],
62 command: {
63 command: 'echo',
64 args: ['baz'],
65 },
66 packageAdditions: {
67 dependencies: {
68 'test-package': '1.0.0',
69 },
70 },
71 dependsOn: [],
72 getFiles: () => Promise.resolve(['jack.txt']),
73 getFileContents: () => Promise.resolve('foo'),
74 getDeletedFiles: () => Promise.resolve([]),
75 },
76 ],
77 getFiles: () => Promise.resolve(Object.keys(fakeFiles)),
78 getFileContents: (path) => Promise.resolve(fakeFiles[path]),
79 getDeletedFiles: () => Promise.resolve([]),
80 })
81})
82​
83describe('createAppOptionsFromPersisted', () => {
84 it('should create live options from persisted options', async () => {
85 const persistedOptions = {
86 projectName: 'test-project',
87 framework: 'test',
88 mode: 'code-router',
89 typescript: true,
90 tailwind: true,
91 git: true,
92 packageManager: 'npm',
93 targetDir: '',
94 starter: undefined,
95 chosenAddOns: [],
96 version: 1,
97 } as PersistedOptions
98 const appOptions = await createAppOptionsFromPersisted(persistedOptions)
99 expect(appOptions.framework.id).toEqual('test')
100 expect(appOptions.mode).toEqual('code-router')
101 expect(appOptions.typescript).toEqual(true)
102 expect(appOptions.tailwind).toEqual(true)
103 expect(appOptions.git).toEqual(true)
104 expect(appOptions.packageManager).toEqual('npm')
105 expect(appOptions.targetDir).toEqual('')
106 expect(appOptions.starter).toEqual(undefined)
107 expect(appOptions.chosenAddOns).toEqual([])
108 expect(appOptions.chosenAddOns).toEqual([])
109 })
110})
111​
112describe('createSerializedOptionsFromPersisted', () => {
113 it('should create serialized options from persisted options', async () => {
114 const persistedOptions = {
115 projectName: 'test-project',
116 framework: 'test',
117 mode: 'code-router',
118 typescript: true,
119 tailwind: true,
120 git: true,
121 packageManager: 'npm',
122 targetDir: '',
123 starter: undefined,
124 chosenAddOns: [],
125 version: 1,
126 } as PersistedOptions
127 const appOptions =
128 await createSerializedOptionsFromPersisted(persistedOptions)
129 expect(appOptions.framework).toEqual('test')
130 expect(appOptions.mode).toEqual('code-router')
131 expect(appOptions.typescript).toEqual(true)
132 expect(appOptions.tailwind).toEqual(true)
133 expect(appOptions.git).toEqual(true)
134 expect(appOptions.packageManager).toEqual('npm')
135 expect(appOptions.targetDir).toEqual('')
136 expect(appOptions.starter).toEqual(undefined)
137 expect(appOptions.chosenAddOns).toEqual([])
138 expect(appOptions.chosenAddOns).toEqual([])
139 })
140})
141​
142describe('createPackageAdditions', () => {
143 it('should handles scripts', () => {
144 const packageAdditions = createPackageAdditions(
145 {
146 scripts: {
147 dev: 'vinxi dev',
148 },
149 },
150 {
151 scripts: {
152 dev: 'vinxi dev',
153 foo: 'bar',
154 },
155 },
156 )
157 expect(packageAdditions).toEqual({
158 scripts: {
159 foo: 'bar',
160 },
161 })
162 })
163​
164 it('should handles dependencies', () => {
165 const packageAdditions = createPackageAdditions(
166 {
167 dependencies: {
168 react: '^18.0.0',
169 },
170 devDependencies: {
171 'foo-dev-dependency': '^18.0.0',
172 'updated-dev-dependency': '^18.0.0',
173 },
174 },
175 {
176 dependencies: {
177 react: '^18.0.0',
178 'react-dom': '^20.0.0',
179 },
180 devDependencies: {
181 'foo-dev-dependency': '^18.0.0',
182 'bar-dev-dependency': '^18.0.0',
183 'updated-dev-dependency': '^20.0.0',
184 },
185 },
186 )
187 expect(packageAdditions).toEqual({
188 dependencies: {
189 'react-dom': '^20.0.0',
190 },
191 devDependencies: {
192 'bar-dev-dependency': '^18.0.0',
193 'updated-dev-dependency': '^20.0.0',
194 },
195 })
196 })
197})
198​
199describe('readCurrentProjectOptions', () => {
200 it('should read the current project options', async () => {
201 const { environment } = createMemoryEnvironment()
202 environment.writeFile(
203 '.cta.json',
204 JSON.stringify({
205 projectName: 'test-project',
206 framework: 'test',
207 mode: 'code-router',
208 typescript: true,
209 tailwind: true,
210 git: true,
211 packageManager: 'npm',
212 targetDir: '',
213 starter: undefined,
214 chosenAddOns: [],
215 version: 1,
216 }),
217 )
218 const options = await readCurrentProjectOptions(environment)
219 expect(options).toEqual({
220 bundler: 'vite',
221 chosenAddOns: [],
222 framework: 'test',
223 git: true,
224 mode: 'code-router',
225 packageManager: 'npm',
226 projectName: 'test-project',
227 tailwind: true,
228 targetDir: '',
229 typescript: true,
230 version: 1,
231 })
232 })
233})
234​
235describe('compareFilesRecursively', () => {
236 it('should compare files recursively', async () => {
237 vol.mkdirSync('/foo')
238 vol.writeFileSync('/foo/.gitignore', 'foo')
239 vol.writeFileSync('/foo/bar.txt', 'bar')
240 vol.writeFileSync('/foo/baz.txt', 'baz')
241 vol.writeFileSync('/foo/qux.txt', 'qux')
242 vol.mkdirSync('/foo/bar')
243 vol.writeFileSync('/foo/bar/baz.txt', 'baz')
244 vol.writeFileSync('/foo/bar/qux.txt', 'qux')
245 const changedFiles = {}
246 await compareFilesRecursively(
247 '/foo',
248 () => false,
249 {
250 '/foo/.gitignore': '.gitignore',
251 '/foo/bar.txt': 'bar',
252 },
253 changedFiles,
254 )
255 expect(changedFiles).toEqual({
256 '/foo/.gitignore': 'foo',
257 '/foo/bar/baz.txt': 'baz',
258 '/foo/bar/qux.txt': 'qux',
259 '/foo/baz.txt': 'baz',
260 '/foo/qux.txt': 'qux',
261 })
262 })
263})