This repository was archived by the owner on Dec 10, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathsetupModules.ts
332 lines (278 loc) · 11 KB
/
setupModules.ts
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
import { join } from 'node:path'
import type { Nuxt } from '@nuxt/schema'
import { camelCase } from 'scule'
import consola from 'consola'
import { generatePergelTemplate } from './utils/generatePergelTemplate'
import { generateProjectReadme } from './utils/generateYaml'
import type { PergelModule } from './types/module'
import type { PergelModuleNames, ResolvedPergelOptions } from './types/nuxtModule'
const logger = consola.create({
defaults: {
tag: 'pergel',
},
})
type PrepareModules = {
[project: string]: {
[module: string]: {
defineModule: PergelModule
waitModule?: string[]
}
}
}
class CircularDependencyError extends Error {
constructor(message: string) {
super(message)
this.name = 'CircularDependencyError'
}
}
async function initModules(nuxt: Nuxt) {
const projects = nuxt._pergel.rootOptions.projects
const prepareModules: PrepareModules = {}
try {
for await (const [projectName, modules] of Object.entries(projects)) {
for await (const [moduleName, moduleValue] of Object.entries(modules)) {
if (typeof moduleValue === 'boolean' && moduleValue === false)
continue
if (
(typeof moduleValue === 'object' && moduleValue === null)
|| (typeof moduleValue === 'object' && !moduleValue)
) {
continue
}
if (typeof moduleValue === 'string' && moduleValue === '')
continue
nuxt._pergel.projects[projectName] ??= {} as any
(nuxt._pergel.projects[projectName] as any)[moduleName] = {
...(nuxt._pergel.projects[projectName] as any)[moduleName],
dir: {
project: join(projectName),
module: join(projectName, moduleName),
},
} satisfies ResolvedPergelOptions['projects']['']
let pergelModule: PergelModule
const module = (nuxt._pergel.projects[projectName as any] as any)[moduleName as any]
try {
const modulePath = nuxt._pergel.resolveModules.find(
module => module.name === moduleName,
)
if (!modulePath)
throw new Error(`Module ${moduleName} does not exist`)
pergelModule = await import(modulePath.path).then(m => m.default).catch((res) => {
logger.error(`Module ${moduleName} failed to import`)
logger.error(res)
})
}
catch (error) {
logger.error(`Module ${moduleName} failed to import`)
throw error
}
// Throw error if input is not a function
if (typeof pergelModule !== 'function')
throw new TypeError(`Nuxt module should be a function: ${pergelModule}`)
const serverFrom = join(camelCase(projectName), 'server', camelCase(moduleName))
const clientFrom = join(camelCase(projectName), 'client', camelCase(moduleName))
const rootModuleDir = join(nuxt._pergel.pergelDir, `${moduleName}-${projectName}`)
const serverDir = join(nuxt._pergel.serverDir, `${moduleName}-${projectName}`)
const resolvedModule = await pergelModule.call({
prepare: true,
} as any, {
nuxt,
options: {
_dir: {
module: join(camelCase(projectName), camelCase(moduleName)),
server: join(nuxt._pergel.dir.server, `${moduleName}-${projectName}`),
build: join('.nuxt', 'pergel', projectName, moduleName),
},
moduleName: moduleName as PergelModuleNames,
projectName,
rootModuleDir,
serverDir,
projectNameCamelCase: camelCase(projectName, { normalize: true }),
projectNameCamelCaseWithPergel: camelCase(`pergel-${projectName}`, { normalize: true }),
folderName: `${camelCase(moduleName)}-${camelCase(projectName)}`,
buildDir: join(nuxt.options.buildDir, 'pergel', projectName, moduleName),
},
rootOptions: module,
})
nuxt.options.alias[`#${serverFrom}`] = join(serverDir)
nuxt.options.nitro.alias ??= {}
nuxt.options.nitro.alias[`#${serverFrom}`] = join(serverDir)
nuxt.options.alias[`#${clientFrom}`] = join(rootModuleDir)
nuxt.options.nitro.alias ??= {}
nuxt.options.nitro.alias[`#${clientFrom}`] = join(rootModuleDir)
if (resolvedModule === false /* setup aborted */
|| resolvedModule === undefined /* setup failed */
|| typeof resolvedModule === 'string' /* setup failed */
) {
logger.error(`Module ${moduleName} failed to setup`)
continue
}
prepareModules[projectName] ??= {}
prepareModules[projectName as any][moduleName as any] ??= {} as any
prepareModules[projectName][moduleName].defineModule = pergelModule
prepareModules[projectName][moduleName].waitModule = await waitModule({
defineModule: pergelModule,
nuxt,
moduleName,
projectName,
})
}
}
}
catch (error) {
logger.error(error)
}
return prepareModules
}
async function waitModule(
data: {
defineModule: PergelModule
nuxt: Nuxt
moduleName: string
projectName: string
},
) {
const { defineModule, nuxt, moduleName, projectName } = data
const rootOptions = (nuxt._pergel.rootOptions.projects[projectName] as any)[moduleName as any]
const _module = await defineModule
const getMeta = await _module.getMeta?.()
if (!getMeta)
throw new Error(`Module ${moduleName} does not have meta`)
const _waitModule = typeof getMeta?.waitModule === 'function'
? await getMeta.waitModule?.(rootOptions)
: getMeta?.waitModule
if (_waitModule)
return _waitModule
}
function smartSortModules(projectName: string, modules: PrepareModules): string[] {
const sortedModules: string[] = []
const visited: Set<string> = new Set()
const visiting: Set<string> = new Set()
const visitModule = (moduleName: string) => {
if (visiting.has(moduleName))
throw new CircularDependencyError(`Circular dependency detected involving module: ${moduleName}`)
if (!visited.has(moduleName)) {
visiting.add(moduleName)
const module = modules[projectName][moduleName]
if (module && module.waitModule) {
for (const dependency of module.waitModule)
visitModule(dependency)
}
sortedModules.push(moduleName)
visited.add(moduleName)
visiting.delete(moduleName)
}
}
for (const moduleName in modules[projectName])
visitModule(moduleName)
return sortedModules
}
export async function setupModules(data: {
nuxt: Nuxt
}) {
const projects = data.nuxt._pergel.rootOptions.projects
const _projects = projects && Object.values(projects).map(project => Object.keys(project)).flat()
if (!projects || !(_projects.length > 0))
return
const prepareModules = await initModules(data.nuxt)
for await (const [projectName, _modules] of Object.entries(projects)) {
const sortedModules = smartSortModules(projectName, prepareModules)
if (data.nuxt._pergel.debug) {
logger.info(`Project ${projectName} modules:`)
logger.info(sortedModules)
}
for await (const moduleName of sortedModules) {
if (!(data.nuxt._pergel.projects[projectName as any] as any)[moduleName]) {
logger.error(`Module ${moduleName} does not exist in project ${projectName}. Please check your nuxt.config.ts and add ${moduleName} to ${projectName} project`)
process.exit(1)
}
const module = (data.nuxt._pergel.projects[projectName as any] as any)[moduleName as any]
const moduleSetup = prepareModules[projectName][moduleName]
const getMeta = typeof moduleSetup.defineModule.getMeta === 'function'
? await moduleSetup.defineModule.getMeta()
: await moduleSetup.defineModule.getMeta
if (!getMeta)
throw new Error(`Module ${moduleName} does not have meta`)
const dependencies = getMeta.dependencies instanceof Function
? getMeta.dependencies(module, data.nuxt)
: getMeta.dependencies ?? {}
const devDependencies = getMeta.devDependencies instanceof Function
? getMeta.devDependencies(module, data.nuxt)
: getMeta.devDependencies ?? {}
const patches = getMeta.patches instanceof Function
? getMeta.patches(module, data.nuxt)
: getMeta.patches ?? {}
if (Object.keys(dependencies).length > 0 || Object.keys(devDependencies).length > 0) {
generateProjectReadme({
data: ({ addCommentBlock }) => ({
...addCommentBlock('If pergel cli is installed, you can run `pergel install` automatically to install'),
packageJson: {
dependencies: {
...dependencies,
},
devDependencies: {
...devDependencies,
},
patches: {
pnpm: {
patchedDependencies: {
...patches.pnpm?.patchedDependencies,
},
},
},
},
}),
moduleName,
nuxt: data.nuxt,
projectName,
})
}
if (process.env.PERGEL_SETUP === 'true') {
logger.info(`Creating packages ${moduleName} for project ${projectName}`)
continue
}
// Throw error if input is not a function
if (typeof moduleSetup.defineModule !== 'function')
throw new TypeError(`Nuxt module should be a function: ${moduleSetup.defineModule}`)
const resolvedModule = await moduleSetup.defineModule({
nuxt: data.nuxt,
options: {
_dir: {
module: join(projectName, moduleName),
server: join(data.nuxt._pergel.serverDir, `${moduleName}-${projectName}`),
build: join('.nuxt', 'pergel', projectName, moduleName),
},
moduleName: moduleName as PergelModuleNames,
projectName,
rootModuleDir: join(data.nuxt._pergel.pergelDir, `${moduleName}-${projectName}`),
serverDir: join(data.nuxt._pergel.serverDir, `${moduleName}-${projectName}`),
projectNameCamelCase: camelCase(projectName, { normalize: true }),
projectNameCamelCaseWithPergel: camelCase(`pergel-${projectName}`, { normalize: true }),
folderName: `${camelCase(moduleName)}-${camelCase(projectName)}`,
buildDir: join(data.nuxt.options.buildDir, 'pergel', projectName, moduleName),
},
rootOptions: module,
})
if (
resolvedModule === false /* setup aborted */
|| resolvedModule === undefined /* setup failed */
|| typeof resolvedModule === 'string' /* setup failed */
) {
logger.error(`Module ${
moduleName
} failed to setup`)
return 'continue'
}
}
}
for (const item of data.nuxt._pergel.contents) {
if (!item.projectName || !item.moduleName) {
throw new Error(`Project name or module name is missing in
${JSON.stringify(item).replace(/"/g, '')}
`)
}
}
generatePergelTemplate({
nuxt: data.nuxt,
})
}