/
module.ts
177 lines (165 loc) 路 6.25 KB
/
module.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
import { defineNuxtModule, installModule, checkNuxtCompatibility, logger, writeTypes, addTemplate } from '@nuxt/kit'
import type { NuxtModule, NuxtCompatibility } from '@nuxt/schema'
import type { NodeMiddleware } from 'h3'
import { fromNodeMiddleware } from 'h3'
import type { BridgeConfig } from '../types'
import { setupNitroBridge } from './nitro'
import { setupAppBridge } from './app'
import { setupCAPIBridge } from './capi'
import { setupBetterResolve } from './resolve'
import importsModule from './imports/module'
import { setupTypescript } from './typescript'
import { setupMeta } from './meta'
import { setupTranspile } from './transpile'
import { generateWebpackBuildManifest } from './webpack/manifest'
import pageMetaModule from './page-meta/module'
export default defineNuxtModule({
meta: {
name: 'nuxt-bridge',
configKey: 'bridge'
},
defaults: {
nitro: true,
nitroGenerator: true,
vite: false,
app: {},
capi: {},
transpile: true,
imports: true,
compatibility: true,
meta: null,
typescript: true,
resolve: true,
macros: false
} as BridgeConfig,
async setup (opts, nuxt) {
// Disable if users explicitly set to false
if ((nuxt.options as any).bridge === false) { return }
if (!(nuxt.options as any).bridge._version) {
throw new Error('[bridge] Bridge must be enabled by using `defineNuxtConfig` to wrap your Nuxt configuration.')
}
if (opts.vite && !opts.nitro && !nuxt.options.dev) {
throw new Error('[bridge] Vite build will not work unless Nitro is enabled.')
}
if (opts.nitro) {
if (!await import('./features').then(r => r.ensurePackageInstalled(nuxt.options.rootDir, 'nuxi', nuxt.options.modulesDir))) {
logger.warn('Failed to install `nuxi`, please install it manually, or change the `nitro` option to false in `nuxt.config`')
}
// @ts-ignore router.base is legacy
nuxt.options.router.base = nuxt.options.app.baseURL || '/'
nuxt.hook('modules:done', async () => {
await setupNitroBridge()
})
if (!opts.vite) {
nuxt.hook('build:compile' as any, () => {
nuxt.hook('server:devMiddleware' as any, async (devMiddleware: NodeMiddleware) => {
await nuxt.callHook('server:devHandler', fromNodeMiddleware(devMiddleware))
})
})
}
}
if (opts.app) {
await setupAppBridge(opts.app)
}
if (opts.capi) {
if (!opts.app) {
throw new Error('[bridge] Cannot enable composition-api with app disabled!')
}
await setupCAPIBridge(opts.capi === true ? {} : opts.capi)
}
if (opts.macros && opts.macros.pageMeta) {
// @ts-expect-error TODO: legacy module container usage
nuxt.hook('modules:done', moduleContainer =>
installModule(
pageMetaModule.bind(moduleContainer)
)
)
}
// Deprecate hooks
nuxt.hooks.deprecateHooks({
// @ts-expect-error
'autoImports:sources': {
to: 'imports:sources',
message: '`autoImports:sources` hook is deprecated. Use `addImportsSources()` from `@nuxt/kit` or `imports:dirs` with latest Nuxt Bridge.'
},
'autoImports:dirs': {
to: 'imports:dirs',
message: '`autoImports:dirs` hook is deprecated. Use `addImportsDir()` from `@nuxt/kit` or `imports:dirs` with latest Nuxt Bridge.'
},
'autoImports:extend': {
to: 'imports:extend',
message: '`autoImports:extend` hook is deprecated. Use `addImports()` from `@nuxt/kit` or `imports:extend` with latest Nuxt Bridge.'
}
})
if (opts.imports === false || opts.autoImports === false) {
logger.warn(
'`bridge.imports` and `bridge.autoImports` are deprecated. Use `imports.autoImport` instead.',
'Please see https://nuxt.com/docs/guide/concepts/auto-imports#disabling-auto-imports for more information.')
}
if (opts.imports ?? opts.autoImports) {
// @ts-expect-error TODO: legacy module container usage
nuxt.hook('modules:done', moduleContainer =>
installModule(
importsModule.bind(moduleContainer, {
autoImport: nuxt.options.imports?.autoImport ?? opts.imports ?? opts.autoImports
})
)
)
}
if (opts.vite) {
const viteModule = await import('./vite/module').then(r => r.default || r) as NuxtModule
// @ts-expect-error TODO: legacy module container usage
nuxt.hook('modules:done', moduleContainer => installModule(viteModule.bind(moduleContainer)))
} else {
// with webpack, we need to transpile vue to handle the default/named exports in Vue 2.7
nuxt.options.build.transpile.push('vue')
nuxt.hook('build:done', async () => {
if (opts.nitro && !nuxt.options.dev && !nuxt.options._prepare) {
await generateWebpackBuildManifest()
}
})
}
if (opts.typescript) {
await setupTypescript({
isTSX: typeof opts.typescript === 'object' && opts.typescript.isTSX,
esbuild: typeof opts.typescript === 'object' && opts.typescript.esbuild
})
// support generating tsconfig by `nuxt dev` (for nuxt 2)
if (!opts.nitro) {
nuxt.hook('modules:done', async () => {
await writeTypes(nuxt)
})
}
}
if (opts.resolve) {
setupBetterResolve()
}
if (opts.transpile) {
setupTranspile()
}
if (opts.compatibility) {
// @ts-expect-error TODO: update legacy types
nuxt.hook('modules:done', async (moduleContainer: any) => {
for (const [name, m] of Object.entries(moduleContainer.requiredModules || {})) {
const compat = ((m as any)?.handler?.meta?.compatibility || {}) as NuxtCompatibility
if (compat) {
const issues = await checkNuxtCompatibility(compat, nuxt)
if (issues.length) {
console.warn(`[bridge] Detected module incompatibility issues for \`${name}\`:\n` + issues.toString())
}
}
}
})
}
if (opts.meta !== false && opts.capi) {
await setupMeta({ needsExplicitEnable: opts.meta === null })
}
if (!opts.meta) {
// Add stub to allow tree-shaking out unhead utils in renderer
addTemplate({
filename: 'meta.config.mjs',
getContents: () => 'export default false'
})
}
}
})