forked from nuxt/cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
add.ts
220 lines (202 loc) · 5.8 KB
/
add.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
import { resolve } from 'pathe'
import { defineCommand } from 'citty'
import { sharedArgs } from '../_shared'
import { existsSync } from 'node:fs'
import { loadFile, writeFile, parseModule, ProxifiedModule } from 'magicast'
import consola from 'consola'
import { addDependency } from 'nypm'
import {
NuxtModule,
checkNuxtCompatibility,
fetchModules,
getNuxtVersion,
} from './_utils'
import { satisfies } from 'semver'
import { colors } from 'consola/utils'
export default defineCommand({
meta: {
name: 'add',
description: 'Add Nuxt modules',
},
args: {
...sharedArgs,
moduleName: {
type: 'positional',
description: 'Module name',
},
skipInstall: {
type: 'boolean',
description: 'Skip npm install',
},
skipConfig: {
type: 'boolean',
description: 'Skip nuxt.config.ts update',
},
},
async setup(ctx) {
const cwd = resolve(ctx.args.cwd || '.')
const r = await resolveModule(ctx.args.moduleName, cwd)
if (r === false) {
return
}
// Add npm dependency
if (!ctx.args.skipInstall) {
consola.info(`Installing dev dependency \`${r.pkg}\``)
const res = await addDependency(r.pkg, { cwd, dev: true }).catch(
(error) => {
consola.error(error)
return consola.prompt(
`Install failed for ${colors.cyan(
r.pkg,
)}. Do you want to continue adding the module to ${colors.cyan(
'nuxt.config',
)}?`,
{
type: 'confirm',
initial: false,
},
)
},
)
if (res === false) {
return
}
}
// Update nuxt.config.ts
if (!ctx.args.skipConfig) {
await updateNuxtConfig(cwd, (config) => {
if (!config.modules) {
config.modules = []
}
if (config.modules.includes(r.pkgName)) {
consola.info(`\`${r.pkgName}\` is already in the \`modules\``)
return
}
consola.info(`Adding \`${r.pkgName}\` to the \`modules\``)
config.modules.push(r.pkgName)
}).catch((err) => {
consola.error(err)
consola.error(
`Please manually add \`${r.pkgName}\` to the \`modules\` in \`nuxt.config.ts\``,
)
})
}
},
})
// -- Internal Utils --
async function updateNuxtConfig(
rootDir: string,
update: (config: any) => void,
) {
let _module: ProxifiedModule
const nuxtConfigFile = resolve(rootDir, 'nuxt.config.ts')
if (existsSync(nuxtConfigFile)) {
consola.info('Updating `nuxt.config.ts`')
_module = await loadFile(nuxtConfigFile)
} else {
consola.info('Creating `nuxt.config.ts`')
_module = parseModule(getDefaultNuxtConfig())
}
const defaultExport = _module.exports.default
if (!defaultExport) {
throw new Error('`nuxt.config.ts` does not have a default export!')
}
if (defaultExport.$type === 'function-call') {
update(defaultExport.$args[0])
} else {
update(defaultExport)
}
await writeFile(_module as any, nuxtConfigFile)
consola.success('`nuxt.config.ts` updated')
}
function getDefaultNuxtConfig() {
return `
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
modules: []
})`
}
// Based on https://github.com/dword-design/package-name-regex
const packageRegex =
/^(@[a-z0-9-~][a-z0-9-._~]*\/)?([a-z0-9-~][a-z0-9-._~]*)(@[^@]+)?$/
async function resolveModule(
moduleName: string,
cwd: string,
): Promise<
| false
| {
nuxtModule?: NuxtModule
pkg: string
pkgName: string
pkgVersion: string
}
> {
let pkgName = moduleName
let pkgVersion: string | undefined
const reMatch = moduleName.match(packageRegex)
if (reMatch) {
if (reMatch[3]) {
pkgName = `${reMatch[1] || ''}${reMatch[2] || ''}`
pkgVersion = reMatch[3].slice(1)
}
} else {
consola.error(`Invalid package name \`${pkgName}\`.`)
return false
}
const modulesDB = await fetchModules().catch((err) => {
consola.warn('Cannot search in the Nuxt Modules database: ' + err)
return []
})
const matchedModule = modulesDB.find(
(module) => module.name === moduleName || module.npm === pkgName,
)
if (matchedModule?.npm) {
pkgName = matchedModule.npm
}
if (matchedModule && matchedModule.compatibility.nuxt) {
// Get local Nuxt version
const nuxtVersion = await getNuxtVersion(cwd)
// Check for Module Compatibility
if (!checkNuxtCompatibility(matchedModule, nuxtVersion)) {
consola.warn(
`The module \`${pkgName}\` is not compatible with Nuxt \`${nuxtVersion}\` (requires \`${matchedModule.compatibility.nuxt}\`)`,
)
const shouldContinue = await consola.prompt(
'Do you want to continue installing incompatible version?',
{
type: 'confirm',
initial: false,
},
)
if (shouldContinue !== true) {
return false
}
}
// Match corresponding version of module for local Nuxt version
const versionMap = matchedModule.compatibility.versionMap
if (versionMap) {
for (const [_nuxtVersion, _moduleVersion] of Object.entries(versionMap)) {
if (satisfies(nuxtVersion, _nuxtVersion)) {
if (!pkgVersion) {
pkgVersion = _moduleVersion
} else {
consola.warn(
`Recommended version of \`${pkgName}\` for Nuxt \`${nuxtVersion}\` is \`${_moduleVersion}\` but you have requested \`${pkgVersion}\``,
)
pkgVersion = await consola.prompt('Choose a version:', {
type: 'select',
options: [_moduleVersion, pkgVersion],
})
}
break
}
}
}
}
return {
nuxtModule: matchedModule,
pkg: `${pkgName}@${pkgVersion || 'latest'}`,
pkgName,
pkgVersion: pkgVersion || 'latest',
}
}