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

starter.test.ts

119 lines3.0 KB

1import { beforeEach, describe, expect, it, vi } from 'vitest'
2import { fs, vol } from 'memfs'
3​
4import {
5 loadStarter,
6 readOrGenerateStarterInfo,
7} from '../../src/custom-add-ons/starter.js'
8​
9vi.mock('node:fs', () => fs)
10vi.mock('node:fs/promises', () => fs.promises)
11​
12beforeEach(() => {
13 vol.reset()
14})
15​
16describe('readOrGenerateStarterInfo', () => {
17 it('should read the starter info', async () => {
18 const starterInfo = await readOrGenerateStarterInfo({
19 framework: 'test',
20 version: 1,
21 starter: undefined,
22 projectName: 'test',
23 mode: 'code-router',
24 typescript: true,
25 tailwind: true,
26 git: true,
27 chosenAddOns: [],
28 })
29 expect(starterInfo.id).toEqual('test-template')
30 })
31​
32 it('should read the starter info', async () => {
33 fs.mkdirSync(process.cwd(), { recursive: true })
34 fs.writeFileSync(
35 'starter-info.json',
36 JSON.stringify({
37 framework: 'test',
38 version: 1,
39 chosenAddOns: [],
40 starter: undefined,
41 name: 'test-starter',
42 mode: 'code-router',
43 typescript: true,
44 tailwind: true,
45 git: true,
46 }),
47 )
48 const starterInfo = await readOrGenerateStarterInfo({
49 framework: 'test',
50 version: 1,
51 chosenAddOns: [],
52 starter: undefined,
53 projectName: 'test',
54 mode: 'code-router',
55 typescript: true,
56 tailwind: true,
57 git: true,
58 })
59 expect(starterInfo.name).toEqual('test-starter')
60 })
61​
62 it('should backfill version when missing', async () => {
63 fs.mkdirSync(process.cwd(), { recursive: true })
64 fs.writeFileSync(
65 'starter-info.json',
66 JSON.stringify({
67 framework: 'test',
68 chosenAddOns: [],
69 starter: undefined,
70 name: 'test-starter',
71 mode: 'code-router',
72 typescript: true,
73 tailwind: true,
74 git: true,
75 }),
76 )
77 const starterInfo = await readOrGenerateStarterInfo({
78 framework: 'test',
79 version: 1,
80 chosenAddOns: [],
81 starter: undefined,
82 projectName: 'test',
83 mode: 'code-router',
84 typescript: true,
85 tailwind: true,
86 git: true,
87 })
88 expect(starterInfo.version).toEqual('0.0.1')
89 })
90​
91 it('should load a local template/starter file path', async () => {
92 fs.mkdirSync(process.cwd(), { recursive: true })
93 fs.writeFileSync(
94 './template.json',
95 JSON.stringify({
96 id: 'template-id',
97 name: 'Template Name',
98 version: '0.0.1',
99 description: 'template description',
100 author: 'Test Author',
101 license: 'MIT',
102 link: 'https://example.com/template',
103 type: 'starter',
104 framework: 'react',
105 mode: 'file-router',
106 typescript: true,
107 files: {
108 './package.json': '{}',
109 },
110 deletedFiles: [],
111 }),
112 )
113​
114 const starter = await loadStarter('./template.json')
115​
116 expect(starter.id).toEqual('./template.json')
117 await expect(starter.getFiles()).resolves.toEqual(['./package.json'])
118 })
119})