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

frameworks.test.ts

125 lines3.2 KB

1import { beforeEach, describe, expect, it, vi } from 'vitest'
2import { fs, vol } from 'memfs'
3​
4import {
5 __testClearFrameworks,
6 getFrameworks,
7 getFrameworkById,
8 getFrameworkByName,
9 registerFramework,
10} from '../src/frameworks.js'
11​
12vi.mock('node:fs', () => fs)
13vi.mock('node:fs/promises', () => fs.promises)
14​
15beforeEach(() => {
16 vol.reset()
17 __testClearFrameworks()
18})
19​
20describe('registerFramework', () => {
21 const definition = {
22 id: 'watched',
23 name: 'Watched framework',
24 description: 'Framework refresh fixture',
25 version: '1.0.0',
26 addOns: [],
27 base: { 'marker.txt': 'first' },
28 basePackageJSON: {},
29 optionalPackages: {},
30 supportedModes: {},
31 }
32​
33 it('replaces a watched framework without growing the registry', async () => {
34 registerFramework({ ...definition, id: 'unrelated' })
35 for (let index = 0; index < 20; index++) {
36 registerFramework(
37 { ...definition, base: { 'marker.txt': String(index) } },
38 { replace: true },
39 )
40 expect(
41 await getFrameworkById('watched')!.getFileContents('marker.txt'),
42 ).toBe(String(index))
43 expect(getFrameworks()).toHaveLength(2)
44 }
45 expect(
46 await getFrameworkById('unrelated')!.getFileContents('marker.txt'),
47 ).toBe('first')
48 })
49​
50 it('preserves the first registration unless replacement is requested', async () => {
51 registerFramework(definition)
52 registerFramework({ ...definition, base: { 'marker.txt': 'second' } })
53 expect(
54 await getFrameworkById('watched')!.getFileContents('marker.txt'),
55 ).toBe('first')
56 expect(getFrameworks()).toHaveLength(2)
57 })
58​
59 it('should register a framework', async () => {
60 const addOnPackageJSON = {
61 id: 'test',
62 name: 'Test',
63 description: 'Test',
64 version: '1.0.0',
65 }
66 const basePackageJSON = {
67 name: 'Test',
68 version: '1.0.0',
69 }
70​
71 registerFramework({
72 id: 'test',
73 name: 'Test',
74 addOns: [],
75 description: 'Test',
76 version: '1.0.0',
77 base: {
78 'package.json': JSON.stringify(basePackageJSON),
79 },
80 basePackageJSON,
81 optionalPackages: {},
82 supportedModes: {
83 'code-router': {
84 displayName: 'Code Router',
85 description: 'Code Router',
86 forceTypescript: false,
87 },
88 },
89 })
90​
91 const f = getFrameworkById('test')!
92​
93 const baseFiles = await f.getFiles()
94 expect(baseFiles).toEqual(['package.json'])
95​
96 const fileContents = await f.getFileContents('package.json')
97 expect(fileContents).toEqual(JSON.stringify(basePackageJSON))
98​
99 expect(getFrameworkByName('Test')).not.toBeUndefined()
100 expect(getFrameworkByName('test')).not.toBeUndefined()
101 expect(getFrameworks().length).toEqual(1)
102 })
103​
104 it('should resolve legacy react-cra framework id', () => {
105 registerFramework({
106 id: 'react',
107 name: 'React',
108 addOns: [],
109 description: 'React',
110 version: '1.0.0',
111 base: {},
112 basePackageJSON: {},
113 optionalPackages: {},
114 supportedModes: {
115 'file-router': {
116 displayName: 'File Router',
117 description: 'File Router',
118 forceTypescript: true,
119 },
120 },
121 })
122​
123 expect(getFrameworkById('react-cra')?.id).toBe('react')
124 })
125})