forked from feature-sliced/steiger
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.spec.ts
More file actions
258 lines (232 loc) · 7.9 KB
/
Copy pathindex.spec.ts
File metadata and controls
258 lines (232 loc) · 7.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
import { expect, it } from 'vitest'
import { joinFromRoot, parseIntoFolder as parseIntoFsdRoot } from '@steiger/toolkit/test'
import type { Folder, File } from '@steiger/toolkit'
import noWildcardExports from './index.js'
type FileWithContent = File & { content?: string }
it('reports no errors on a project with valid exports', () => {
const root = parseIntoFsdRoot(`
📂 shared
📂 ui
📄 Button.tsx
📄 index.ts
📂 entities
📂 user
📂 ui
📄 UserCard.tsx
📄 index.ts
📄 index.ts
📂 features
📂 auth
📂 ui
📄 LoginForm.tsx
📄 index.ts
`)
function addContentToFiles(folder: Folder): void {
for (const child of folder.children) {
if (child.type === 'file') {
const fileWithContent = child as FileWithContent
if (child.path === joinFromRoot('shared', 'ui', 'index.ts')) {
fileWithContent.content = "export { Button } from './Button'"
} else if (child.path === joinFromRoot('entities', 'user', 'ui', 'index.ts')) {
fileWithContent.content = "export { UserCard } from './UserCard'"
} else if (child.path === joinFromRoot('entities', 'user', 'index.ts')) {
fileWithContent.content = "export * as userModel from './model'"
} else if (child.path === joinFromRoot('features', 'auth', 'ui', 'index.ts')) {
fileWithContent.content = "export { LoginForm } from './LoginForm'"
} else {
fileWithContent.content = ''
}
} else if (child.type === 'folder') {
addContentToFiles(child)
}
}
}
addContentToFiles(root)
expect(noWildcardExports.check(root)).toEqual({ diagnostics: [] })
})
it('reports errors on a project with wildcard exports', () => {
const root = parseIntoFsdRoot(`
📂 shared
📂 ui
📄 Button.tsx
📄 index.ts
📂 entities
📂 user
📂 ui
📄 UserCard.tsx
📄 index.ts
📄 index.ts
`)
function addContentToFiles(folder: Folder): void {
for (const child of folder.children) {
if (child.type === 'file') {
const fileWithContent = child as FileWithContent
if (child.path === joinFromRoot('shared', 'ui', 'index.ts')) {
fileWithContent.content = "export * from './Button'"
} else if (child.path === joinFromRoot('entities', 'user', 'ui', 'index.ts')) {
fileWithContent.content = "export * from './UserCard'"
} else {
fileWithContent.content = ''
}
} else if (child.type === 'folder') {
addContentToFiles(child)
}
}
}
addContentToFiles(root)
const diagnostics = noWildcardExports.check(root).diagnostics
expect(diagnostics).toEqual([
{
message: 'Wildcard exports are not allowed in public APIs. Use named exports instead.',
location: { path: joinFromRoot('entities', 'user', 'ui', 'index.ts') },
fixes: [
{
type: 'modify-file',
path: joinFromRoot('entities', 'user', 'ui', 'index.ts'),
content: '// Replace with named exports\n// Example: export { ComponentA, ComponentB } from "./components"',
},
],
},
])
})
it('allows export * as namespace pattern', () => {
const root = parseIntoFsdRoot(`
📂 shared
📂 ui
📄 positions.ts
📄 index.ts
📂 entities
📂 user
📄 model.ts
📄 index.ts
`)
function addContentToFiles(folder: Folder): void {
for (const child of folder.children) {
if (child.type === 'file') {
const fileWithContent = child as FileWithContent
if (child.path === joinFromRoot('shared', 'ui', 'index.ts')) {
fileWithContent.content = "export * as positions from './positions'"
} else if (child.path === joinFromRoot('entities', 'user', 'index.ts')) {
fileWithContent.content = "export * as userModel from './model'"
} else {
fileWithContent.content = ''
}
} else if (child.type === 'folder') {
addContentToFiles(child)
}
}
}
addContentToFiles(root)
expect(noWildcardExports.check(root)).toEqual({ diagnostics: [] })
})
it('ignores wildcard exports in non-public files', () => {
const root = parseIntoFsdRoot(`
📂 shared
📂 ui
📄 internal.ts
📄 index.ts
📂 entities
📂 user
📂 ui
📄 internal-utils.ts
📄 index.ts
`)
function addContentToFiles(folder: Folder): void {
for (const child of folder.children) {
if (child.type === 'file') {
const fileWithContent = child as FileWithContent
if (child.path.endsWith('internal.ts')) {
fileWithContent.content = "export * from './components'"
} else if (child.path.endsWith('internal-utils.ts')) {
fileWithContent.content = "export * from './utils'"
} else {
fileWithContent.content = ''
}
} else if (child.type === 'folder') {
addContentToFiles(child)
}
}
}
addContentToFiles(root)
expect(noWildcardExports.check(root)).toEqual({ diagnostics: [] })
})
it('ignores wildcard exports in test files', () => {
const root = parseIntoFsdRoot(`
📂 shared
📂 ui
📄 Button.test.ts
📄 index.ts
📂 entities
📂 user
📂 ui
📄 UserCard.spec.ts
📄 index.ts
`)
function addContentToFiles(folder: Folder): void {
for (const child of folder.children) {
if (child.type === 'file') {
const fileWithContent = child as FileWithContent
if (child.path.endsWith('Button.test.ts')) {
fileWithContent.content = "export * from './test-utils'"
} else if (child.path.endsWith('UserCard.spec.ts')) {
fileWithContent.content = "export * from './test-utils'"
} else {
fileWithContent.content = ''
}
} else if (child.type === 'folder') {
addContentToFiles(child)
}
}
}
addContentToFiles(root)
expect(noWildcardExports.check(root)).toEqual({ diagnostics: [] })
})
it('allows wildcard exports in unsliced layers (shared and app)', () => {
const root = parseIntoFsdRoot(`
📂 shared
📂 ui
📄 Button.tsx
📄 Modal.tsx
📄 index.ts
📂 api
📄 client.ts
📄 endpoints.ts
📄 index.ts
📂 app
📂 providers
📄 AuthProvider.tsx
📄 ThemeProvider.tsx
📄 index.ts
📂 routes
📄 index.ts
📂 entities
📂 user
📂 ui
📄 UserCard.tsx
📄 index.ts
`)
function addContentToFiles(folder: Folder): void {
for (const child of folder.children) {
if (child.type === 'file') {
const fileWithContent = child as FileWithContent
if (child.path === joinFromRoot('shared', 'ui', 'index.ts')) {
fileWithContent.content = "export * from './Button'\nexport * from './Modal'"
} else if (child.path === joinFromRoot('shared', 'api', 'index.ts')) {
fileWithContent.content = "export * from './client'\nexport * from './endpoints'"
} else if (child.path === joinFromRoot('app', 'providers', 'index.ts')) {
fileWithContent.content = "export * from './AuthProvider'\nexport * from './ThemeProvider'"
} else if (child.path === joinFromRoot('app', 'routes', 'index.ts')) {
fileWithContent.content = "export * from './home'\nexport * from './auth'"
} else if (child.path === joinFromRoot('entities', 'user', 'ui', 'index.ts')) {
fileWithContent.content = "export { UserCard } from './UserCard'"
} else {
fileWithContent.content = ''
}
} else if (child.type === 'folder') {
addContentToFiles(child)
}
}
}
addContentToFiles(root)
expect(noWildcardExports.check(root)).toEqual({ diagnostics: [] })
})