mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-15 02:14:44 +00:00
261 lines
9.3 KiB
TypeScript
261 lines
9.3 KiB
TypeScript
import { join, normalize, resolve } from 'pathe'
|
|
import { createHooks, createDebugger } from 'hookable'
|
|
import type { Nuxt, NuxtOptions, NuxtConfig, ModuleContainer, NuxtHooks } from '@nuxt/schema'
|
|
import { loadNuxtConfig, LoadNuxtOptions, nuxtCtx, installModule, addComponent, addVitePlugin, addWebpackPlugin, tryResolveModule, addPlugin } from '@nuxt/kit'
|
|
// Temporary until finding better placement
|
|
/* eslint-disable import/no-restricted-paths */
|
|
import escapeRE from 'escape-string-regexp'
|
|
import fse from 'fs-extra'
|
|
import { withoutLeadingSlash } from 'ufo'
|
|
import pagesModule from '../pages/module'
|
|
import metaModule from '../head/module'
|
|
import componentsModule from '../components/module'
|
|
import importsModule from '../imports/module'
|
|
/* eslint-enable */
|
|
import { distDir, pkgDir } from '../dirs'
|
|
import { version } from '../../package.json'
|
|
import { ImportProtectionPlugin, vueAppPatterns } from './plugins/import-protection'
|
|
import { UnctxTransformPlugin } from './plugins/unctx'
|
|
import { TreeShakePlugin } from './plugins/tree-shake'
|
|
import { addModuleTranspiles } from './modules'
|
|
import { initNitro } from './nitro'
|
|
|
|
export function createNuxt (options: NuxtOptions): Nuxt {
|
|
const hooks = createHooks<NuxtHooks>()
|
|
|
|
const nuxt: Nuxt = {
|
|
_version: version,
|
|
options,
|
|
hooks,
|
|
callHook: hooks.callHook,
|
|
addHooks: hooks.addHooks,
|
|
hook: hooks.hook,
|
|
ready: () => initNuxt(nuxt),
|
|
close: () => Promise.resolve(hooks.callHook('close', nuxt)),
|
|
vfs: {}
|
|
}
|
|
|
|
return nuxt
|
|
}
|
|
|
|
async function initNuxt (nuxt: Nuxt) {
|
|
// Register user hooks
|
|
nuxt.hooks.addHooks(nuxt.options.hooks)
|
|
|
|
// Set nuxt instance for useNuxt
|
|
nuxtCtx.set(nuxt)
|
|
nuxt.hook('close', () => nuxtCtx.unset())
|
|
|
|
// Add nuxt types
|
|
nuxt.hook('prepare:types', (opts) => {
|
|
opts.references.push({ types: 'nuxt' })
|
|
opts.references.push({ path: resolve(nuxt.options.buildDir, 'types/plugins.d.ts') })
|
|
// Add vue shim
|
|
if (nuxt.options.typescript.shim) {
|
|
opts.references.push({ path: resolve(nuxt.options.buildDir, 'types/vue-shim.d.ts') })
|
|
}
|
|
// Add module augmentations directly to NuxtConfig
|
|
opts.references.push({ path: resolve(nuxt.options.buildDir, 'types/schema.d.ts') })
|
|
opts.references.push({ path: resolve(nuxt.options.buildDir, 'types/app.config.d.ts') })
|
|
|
|
for (const layer of nuxt.options._layers) {
|
|
const declaration = join(layer.cwd, 'index.d.ts')
|
|
if (fse.existsSync(declaration)) {
|
|
opts.references.push({ path: declaration })
|
|
}
|
|
}
|
|
})
|
|
|
|
// Add import protection
|
|
const config = {
|
|
rootDir: nuxt.options.rootDir,
|
|
// Exclude top-level resolutions by plugins
|
|
exclude: [join(nuxt.options.rootDir, 'index.html')],
|
|
patterns: vueAppPatterns(nuxt)
|
|
}
|
|
addVitePlugin(ImportProtectionPlugin.vite(config))
|
|
addWebpackPlugin(ImportProtectionPlugin.webpack(config))
|
|
|
|
// Add unctx transform
|
|
addVitePlugin(UnctxTransformPlugin(nuxt).vite({ sourcemap: nuxt.options.sourcemap.server || nuxt.options.sourcemap.client }))
|
|
addWebpackPlugin(UnctxTransformPlugin(nuxt).webpack({ sourcemap: nuxt.options.sourcemap.server || nuxt.options.sourcemap.client }))
|
|
|
|
if (!nuxt.options.dev) {
|
|
const removeFromServer = ['onBeforeMount', 'onMounted', 'onBeforeUpdate', 'onRenderTracked', 'onRenderTriggered', 'onActivated', 'onDeactivated', 'onBeforeUnmount']
|
|
const removeFromClient = ['onServerPrefetch', 'onRenderTracked', 'onRenderTriggered']
|
|
|
|
// Add tree-shaking optimisations for SSR - build time only
|
|
addVitePlugin(TreeShakePlugin.vite({ sourcemap: nuxt.options.sourcemap.server, treeShake: removeFromServer }), { client: false })
|
|
addVitePlugin(TreeShakePlugin.vite({ sourcemap: nuxt.options.sourcemap.client, treeShake: removeFromClient }), { server: false })
|
|
addWebpackPlugin(TreeShakePlugin.webpack({ sourcemap: nuxt.options.sourcemap.server, treeShake: removeFromServer }), { client: false })
|
|
addWebpackPlugin(TreeShakePlugin.webpack({ sourcemap: nuxt.options.sourcemap.client, treeShake: removeFromClient }), { server: false })
|
|
}
|
|
|
|
// TODO: [Experimental] Avoid emitting assets when flag is enabled
|
|
if (nuxt.options.experimental.noScripts && !nuxt.options.dev) {
|
|
nuxt.hook('build:manifest', async (manifest) => {
|
|
for (const file in manifest) {
|
|
if (manifest[file].resourceType === 'script') {
|
|
await fse.rm(resolve(nuxt.options.buildDir, 'dist/client', withoutLeadingSlash(nuxt.options.app.buildAssetsDir), manifest[file].file), { force: true })
|
|
manifest[file].file = ''
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
// Transpile layers within node_modules
|
|
nuxt.options.build.transpile.push(
|
|
...nuxt.options._layers.filter(i => i.cwd.includes('node_modules')).map(i => i.cwd as string)
|
|
)
|
|
|
|
// Init user modules
|
|
await nuxt.callHook('modules:before', { nuxt } as ModuleContainer)
|
|
const modulesToInstall = [
|
|
...nuxt.options.buildModules,
|
|
...nuxt.options.modules,
|
|
...nuxt.options._modules
|
|
]
|
|
|
|
// Add <NuxtWelcome>
|
|
addComponent({
|
|
name: 'NuxtWelcome',
|
|
filePath: tryResolveModule('@nuxt/ui-templates/templates/welcome.vue')!
|
|
})
|
|
|
|
addComponent({
|
|
name: 'NuxtLayout',
|
|
filePath: resolve(nuxt.options.appDir, 'components/layout')
|
|
})
|
|
|
|
// Add <NuxtErrorBoundary>
|
|
addComponent({
|
|
name: 'NuxtErrorBoundary',
|
|
filePath: resolve(nuxt.options.appDir, 'components/nuxt-error-boundary')
|
|
})
|
|
|
|
// Add <ClientOnly>
|
|
addComponent({
|
|
name: 'ClientOnly',
|
|
filePath: resolve(nuxt.options.appDir, 'components/client-only')
|
|
})
|
|
|
|
// Add <ServerPlaceholder>
|
|
addComponent({
|
|
name: 'ServerPlaceholder',
|
|
filePath: resolve(nuxt.options.appDir, 'components/server-placeholder')
|
|
})
|
|
|
|
// Add <NuxtLink>
|
|
addComponent({
|
|
name: 'NuxtLink',
|
|
filePath: resolve(nuxt.options.appDir, 'components/nuxt-link')
|
|
})
|
|
|
|
// Add <NuxtLoadingIndicator>
|
|
addComponent({
|
|
name: 'NuxtLoadingIndicator',
|
|
filePath: resolve(nuxt.options.appDir, 'components/nuxt-loading-indicator')
|
|
})
|
|
|
|
// Deprecate hooks
|
|
nuxt.hooks.deprecateHooks({
|
|
'autoImports:sources': {
|
|
to: 'imports:sources',
|
|
message: '`autoImports:sources` hook is deprecated. Use `addImportsSources()` from `@nuxt/kit` or `imports:dirs` with `nuxt>=3.0.0-rc.10`.'
|
|
},
|
|
'autoImports:dirs': {
|
|
to: 'imports:dirs',
|
|
message: '`autoImports:dirs` hook is deprecated. Use `addImportsDir()` from `@nuxt/kit` or `imports:dirs` with `nuxt>=3.0.0-rc.9`.'
|
|
},
|
|
'autoImports:extend': {
|
|
to: 'imports:extend',
|
|
message: '`autoImports:extend` hook is deprecated. Use `addImports()` from `@nuxt/kit` or `imports:extend` with `nuxt>=3.0.0-rc.9`.'
|
|
}
|
|
})
|
|
|
|
// Add prerender payload support
|
|
if (!nuxt.options.dev && nuxt.options.experimental.payloadExtraction) {
|
|
addPlugin(resolve(nuxt.options.appDir, 'plugins/payload.client'))
|
|
}
|
|
|
|
// Add experimental cross-origin prefetch support using Speculation Rules API
|
|
if (nuxt.options.experimental.crossOriginPrefetch) {
|
|
addPlugin(resolve(nuxt.options.appDir, 'plugins/cross-origin-prefetch.client'))
|
|
}
|
|
|
|
// Track components used to render for webpack
|
|
if (nuxt.options.builder === '@nuxt/webpack-builder') {
|
|
addPlugin(resolve(nuxt.options.appDir, 'plugins/preload.server'))
|
|
}
|
|
|
|
// Add nuxt app debugger
|
|
if (nuxt.options.debug) {
|
|
addPlugin(resolve(nuxt.options.appDir, 'plugins/debug'))
|
|
}
|
|
|
|
for (const m of modulesToInstall) {
|
|
if (Array.isArray(m)) {
|
|
await installModule(m[0], m[1])
|
|
} else {
|
|
await installModule(m, {})
|
|
}
|
|
}
|
|
|
|
await nuxt.callHook('modules:done', { nuxt } as ModuleContainer)
|
|
|
|
// Normalize windows transpile paths added by modules
|
|
nuxt.options.build.transpile = nuxt.options.build.transpile.map(t => typeof t === 'string' ? normalize(t) : t)
|
|
|
|
addModuleTranspiles()
|
|
|
|
// Init nitro
|
|
await initNitro(nuxt)
|
|
|
|
await nuxt.callHook('ready', nuxt)
|
|
}
|
|
|
|
export async function loadNuxt (opts: LoadNuxtOptions): Promise<Nuxt> {
|
|
const options = await loadNuxtConfig(opts)
|
|
|
|
// Temporary until finding better placement for each
|
|
options.appDir = options.alias['#app'] = resolve(distDir, 'app')
|
|
options._majorVersion = 3
|
|
options._modules.push(pagesModule, metaModule, componentsModule)
|
|
options._modules.push([importsModule, {
|
|
transform: {
|
|
include: options._layers
|
|
.filter(i => i.cwd && i.cwd.includes('node_modules'))
|
|
.map(i => new RegExp(`(^|\\/)${escapeRE(i.cwd!.split('node_modules/').pop()!)}(\\/|$)(?!node_modules\\/)`))
|
|
}
|
|
}])
|
|
options.modulesDir.push(resolve(options.workspaceDir, 'node_modules'))
|
|
options.modulesDir.push(resolve(pkgDir, 'node_modules'))
|
|
options.build.transpile.push('@nuxt/ui-templates')
|
|
options.alias['vue-demi'] = resolve(options.appDir, 'compat/vue-demi')
|
|
options.alias['@vue/composition-api'] = resolve(options.appDir, 'compat/capi')
|
|
if (options.telemetry !== false && !process.env.NUXT_TELEMETRY_DISABLED) {
|
|
options._modules.push('@nuxt/telemetry')
|
|
}
|
|
|
|
const nuxt = createNuxt(options)
|
|
|
|
if (nuxt.options.debug) {
|
|
createDebugger(nuxt.hooks, { tag: 'nuxt' })
|
|
}
|
|
|
|
if (opts.ready !== false) {
|
|
await nuxt.ready()
|
|
}
|
|
|
|
return nuxt
|
|
}
|
|
|
|
/** @deprecated `defineNuxtConfig` is auto imported. Remove import or alternatively use `import { defineNuxtConfig } from 'nuxt/config'`. */
|
|
export function defineNuxtConfig (config: NuxtConfig): NuxtConfig {
|
|
return config
|
|
}
|
|
|
|
/** @deprecated Use `import type { NuxtConfig } from 'nuxt/config'`. */
|
|
type _NuxtConfig = NuxtConfig
|
|
export type { _NuxtConfig as NuxtConfig }
|