mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-25 15:15:19 +00:00
initial builder refactor
Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>
This commit is contained in:
pooya parsa
parent
e266992fac
commit
2c91d39fd8
34
packages/nuxt3/src/builder/app.ts
Normal file
34
packages/nuxt3/src/builder/app.ts
Normal file
@ -0,0 +1,34 @@
|
||||
import { resolve } from 'path'
|
||||
|
||||
export interface NuxtRoute {
|
||||
path: ''
|
||||
}
|
||||
|
||||
export interface NuxtApp {
|
||||
srcDir: string
|
||||
main?: string
|
||||
routes: NuxtRoute[]
|
||||
}
|
||||
|
||||
// Scan project structure
|
||||
export function resolveApp (nuxt, srcDir: string): NuxtApp {
|
||||
// resolve App.vue
|
||||
const main = nuxt.resolver.tryResolvePath('~/App') ||
|
||||
nuxt.resolver.tryResolvePath('~/app') ||
|
||||
resolve(nuxt.options.appDir, 'app.vue')
|
||||
|
||||
// TODO: Read pages/ and create routes
|
||||
// TODO: Detect store
|
||||
// Use hooks?
|
||||
// routes can be resolved with @nuxt/pages module to scan pages/ using a hook
|
||||
// Import plugins
|
||||
// Middleware
|
||||
// Layouts
|
||||
// etc.
|
||||
|
||||
return {
|
||||
srcDir,
|
||||
main,
|
||||
routes: []
|
||||
}
|
||||
}
|
||||
@ -1,888 +1,39 @@
|
||||
import path from 'path'
|
||||
import chalk from 'chalk'
|
||||
import chokidar from 'chokidar'
|
||||
import consola from 'consola'
|
||||
import fsExtra from 'fs-extra'
|
||||
import Glob from 'glob'
|
||||
import globby from 'globby'
|
||||
import hash from 'hash-sum'
|
||||
import pify from 'pify'
|
||||
import upath from 'upath'
|
||||
import semver from 'semver'
|
||||
import type { RouteLocationRaw } from 'vue-router'
|
||||
|
||||
import debounce from 'lodash/debounce'
|
||||
import omit from 'lodash/omit'
|
||||
import template from 'lodash/template'
|
||||
import uniq from 'lodash/uniq'
|
||||
import uniqBy from 'lodash/uniqBy'
|
||||
|
||||
import { BundleBuilder } from 'src/webpack'
|
||||
import type { Nuxt } from 'src/core'
|
||||
import { Nuxt } from '../core'
|
||||
import { copyTemplates } from './template'
|
||||
import { resolveApp, NuxtApp } from './app'
|
||||
|
||||
import {
|
||||
r,
|
||||
createRoutes,
|
||||
relativeTo,
|
||||
waitFor,
|
||||
determineGlobals,
|
||||
stripWhitespace,
|
||||
isIndexFileAndFolder,
|
||||
DeterminedGlobals,
|
||||
scanRequireTree,
|
||||
TARGETS,
|
||||
isFullStatic
|
||||
} from 'src/utils'
|
||||
|
||||
import Ignore from './ignore'
|
||||
import BuildContext from './context/build'
|
||||
import TemplateContext from './context/template'
|
||||
|
||||
const glob = pify(Glob)
|
||||
export default class Builder {
|
||||
__closed?: boolean
|
||||
_buildStatus: typeof STATUS[keyof typeof STATUS]
|
||||
_defaultPage?: boolean
|
||||
_nuxtPages?: boolean
|
||||
|
||||
appFiles: string[]
|
||||
bundleBuilder: BundleBuilder
|
||||
globals: DeterminedGlobals
|
||||
ignore: Ignore
|
||||
export class Builder {
|
||||
nuxt: Nuxt
|
||||
options: Nuxt['options']
|
||||
plugins: Array<{
|
||||
src: string
|
||||
}>
|
||||
app: NuxtApp
|
||||
|
||||
relativeToBuild: (...args: string[]) => string
|
||||
routes: RouteLocationRaw[]
|
||||
supportedExtensions: string[]
|
||||
template: typeof vueAppTemplate
|
||||
watchers: {
|
||||
files: null
|
||||
custom: null
|
||||
restart: null
|
||||
}
|
||||
|
||||
constructor (nuxt: Nuxt) {
|
||||
constructor (nuxt) {
|
||||
this.nuxt = nuxt
|
||||
this.plugins = []
|
||||
this.options = nuxt.options
|
||||
this.globals = determineGlobals(nuxt.options.globalName, nuxt.options.globals)
|
||||
this.watchers = {
|
||||
files: null,
|
||||
custom: null,
|
||||
restart: null
|
||||
}
|
||||
|
||||
this.supportedExtensions = ['vue', 'js', ...(this.options.build.additionalExtensions || [])]
|
||||
|
||||
// Helper to resolve build paths
|
||||
this.relativeToBuild = (...args: string[]) => relativeTo(this.options.buildDir, ...args)
|
||||
|
||||
this._buildStatus = STATUS.INITIAL
|
||||
|
||||
// Hooks for watch lifecycle
|
||||
if (this.options.dev) {
|
||||
// Start watching after initial render
|
||||
this.nuxt.hook('build:done', () => {
|
||||
consola.info('Waiting for file changes')
|
||||
this.watchClient()
|
||||
this.watchRestart()
|
||||
})
|
||||
|
||||
// Enable HMR for serverMiddleware
|
||||
this.serverMiddlewareHMR()
|
||||
|
||||
// Close hook
|
||||
this.nuxt.hook('close', () => this.close())
|
||||
}
|
||||
|
||||
if (this.options.build.analyze) {
|
||||
this.nuxt.hook('build:done', () => {
|
||||
consola.warn('Notice: Please do not deploy bundles built with "analyze" mode, they\'re for analysis purposes only.')
|
||||
})
|
||||
}
|
||||
|
||||
this.resolveAppTemplate()
|
||||
|
||||
// Create a new bundle builder
|
||||
this.bundleBuilder = this.getBundleBuilder()
|
||||
|
||||
this.ignore = new Ignore({
|
||||
rootDir: this.options.srcDir,
|
||||
ignoreArray: this.options.ignore
|
||||
})
|
||||
|
||||
// Add support for App.{ext} (or app.{ext})
|
||||
this.appFiles = []
|
||||
for (const ext of this.supportedExtensions) {
|
||||
for (const name of ['app', 'App']) {
|
||||
this.appFiles.push(path.join(this.options.srcDir, `${name}.${ext}`))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
resolveAppTemplate () {
|
||||
// Resolve appDir
|
||||
const templatesDir = path.join(this.options.appDir, '_templates')
|
||||
const files = globby.sync(path.join(templatesDir, '/**'))
|
||||
.map(f => f.replace(templatesDir + path.sep, ''))
|
||||
this.template = {
|
||||
dependencies: {},
|
||||
dir: templatesDir,
|
||||
files
|
||||
}
|
||||
}
|
||||
|
||||
getBundleBuilder () {
|
||||
const context = new BuildContext(this)
|
||||
return new BundleBuilder(context)
|
||||
}
|
||||
|
||||
forGenerate () {
|
||||
this.options.target = TARGETS.static
|
||||
this.bundleBuilder.forGenerate()
|
||||
}
|
||||
|
||||
async build () {
|
||||
// Avoid calling build() method multiple times when dev:true
|
||||
if (this._buildStatus === STATUS.BUILD_DONE && this.options.dev) {
|
||||
return this
|
||||
}
|
||||
// If building
|
||||
if (this._buildStatus === STATUS.BUILDING) {
|
||||
await waitFor(1000)
|
||||
return this.build()
|
||||
}
|
||||
this._buildStatus = STATUS.BUILDING
|
||||
|
||||
if (this.options.dev) {
|
||||
consola.info('Preparing project for development')
|
||||
consola.info('Initial build may take a while')
|
||||
} else {
|
||||
consola.info('Production build')
|
||||
if (this.options.render.ssr) {
|
||||
consola.info(`Bundling for ${chalk.bold.yellow('server')} and ${chalk.bold.green('client')} side`)
|
||||
} else {
|
||||
consola.info(`Bundling only for ${chalk.bold.green('client')} side`)
|
||||
}
|
||||
const target = isFullStatic(this.options) ? 'full static' : this.options.target
|
||||
consola.info(`Target: ${chalk.bold.cyan(target)}`)
|
||||
}
|
||||
|
||||
// Wait for nuxt ready
|
||||
await this.nuxt.ready()
|
||||
|
||||
// Call before hook
|
||||
await this.nuxt.callHook('build:before', this, this.options.build)
|
||||
|
||||
// await this.validatePages()
|
||||
|
||||
// Validate template
|
||||
try {
|
||||
this.validateTemplate()
|
||||
} catch (err) {
|
||||
consola.fatal(err)
|
||||
}
|
||||
|
||||
consola.success('Builder initialized')
|
||||
|
||||
consola.debug(`App root: ${this.options.srcDir}`)
|
||||
|
||||
// Create or empty .nuxt/, .nuxt/components and .nuxt/dist folders
|
||||
await fsExtra.emptyDir(r(this.options.buildDir))
|
||||
const buildDirs = [r(this.options.buildDir, 'components')]
|
||||
if (!this.options.dev) {
|
||||
buildDirs.push(
|
||||
r(this.options.buildDir, 'dist', 'client'),
|
||||
r(this.options.buildDir, 'dist', 'server')
|
||||
)
|
||||
}
|
||||
await Promise.all(buildDirs.map(dir => fsExtra.emptyDir(dir)))
|
||||
|
||||
// Call ready hook
|
||||
await this.nuxt.callHook('builder:prepared', this, this.options.build)
|
||||
|
||||
// Generate routes and interpret the template files
|
||||
await this.generateRoutesAndFiles()
|
||||
|
||||
// Add app template dir to watchers
|
||||
this.options.build.watch.push(this.globPathWithExtensions(this.template.dir))
|
||||
|
||||
await this.resolvePlugins()
|
||||
|
||||
// Start bundle build: webpack, rollup, parcel...
|
||||
await this.bundleBuilder.build()
|
||||
|
||||
// Flag to set that building is done
|
||||
this._buildStatus = STATUS.BUILD_DONE
|
||||
|
||||
// Call done hook
|
||||
await this.nuxt.callHook('build:done', this)
|
||||
|
||||
return this
|
||||
}
|
||||
|
||||
// Check if pages dir exists and warn if not
|
||||
// async validatePages () {
|
||||
// this._nuxtPages = typeof this.options.build.createRoutes !== 'function'
|
||||
|
||||
// if (
|
||||
// !this._nuxtPages ||
|
||||
// await fsExtra.exists(path.join(this.options.srcDir, this.options.dir.pages))
|
||||
// ) {
|
||||
// return
|
||||
// }
|
||||
|
||||
// const dir = this.options.srcDir
|
||||
// if (await fsExtra.exists(path.join(this.options.srcDir, '..', this.options.dir.pages))) {
|
||||
// throw new Error(
|
||||
// `No \`${this.options.dir.pages}\` directory found in ${dir}. Did you mean to run \`nuxt\` in the parent (\`../\`) directory?`
|
||||
// )
|
||||
// }
|
||||
|
||||
// this._defaultPage = true
|
||||
// consola.warn(`No \`${this.options.dir.pages}\` directory found in ${dir}. Using the default built-in page.`)
|
||||
// }
|
||||
|
||||
validateTemplate () {
|
||||
// Validate template dependencies
|
||||
const templateDependencies = this.template.dependencies
|
||||
for (const depName in templateDependencies) {
|
||||
const depVersion = templateDependencies[depName]
|
||||
|
||||
// Load installed version
|
||||
const pkg = this.nuxt.resolver.requireModule(path.join(depName, 'package.json'))
|
||||
if (pkg) {
|
||||
const validVersion = semver.satisfies(pkg.version, depVersion)
|
||||
if (!validVersion) {
|
||||
consola.warn(`${depName}@${depVersion} is recommended but ${depName}@${pkg.version} is installed!`)
|
||||
}
|
||||
} else {
|
||||
consola.warn(`${depName}@${depVersion} is required but not installed!`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
globPathWithExtensions (path: string) {
|
||||
return `${path}/**/*.{${this.supportedExtensions.join(',')}}`
|
||||
}
|
||||
|
||||
createTemplateContext () {
|
||||
return new TemplateContext(this, this.options)
|
||||
}
|
||||
|
||||
async generateRoutesAndFiles () {
|
||||
consola.debug('Generating nuxt files')
|
||||
|
||||
this.plugins = Array.from(await this.normalizePlugins())
|
||||
|
||||
const templateContext = this.createTemplateContext()
|
||||
|
||||
await this.resolvePages(templateContext)
|
||||
await this.resolveApp(templateContext)
|
||||
|
||||
await Promise.all([
|
||||
this.resolveLayouts(templateContext),
|
||||
this.resolveStore(templateContext),
|
||||
this.resolveMiddleware(templateContext)
|
||||
])
|
||||
|
||||
await this.resolvePlugins()
|
||||
|
||||
this.addOptionalTemplates(templateContext)
|
||||
|
||||
await this.resolveCustomTemplates(templateContext)
|
||||
|
||||
await this.resolveLoadingIndicator(templateContext)
|
||||
|
||||
await this.compileTemplates(templateContext)
|
||||
|
||||
consola.success('Nuxt files generated')
|
||||
}
|
||||
|
||||
async normalizePlugins () {
|
||||
// options.extendPlugins allows for returning a new plugins array
|
||||
if (this.options.extendPlugins instanceof Function) {
|
||||
const extendedPlugins = this.options.extendPlugins(this.options.plugins)
|
||||
|
||||
if (Array.isArray(extendedPlugins)) {
|
||||
this.options.plugins = extendedPlugins
|
||||
}
|
||||
}
|
||||
|
||||
// extendPlugins hook only supports in-place modifying
|
||||
await this.nuxt.callHook('builder:extendPlugins', this.options.plugins)
|
||||
|
||||
const modes = ['client', 'server']
|
||||
const modePattern = new RegExp(`\\.(${modes.join('|')})(\\.\\w+)*$`)
|
||||
return uniqBy(
|
||||
this.options.plugins.map((p) => {
|
||||
if (typeof p === 'string') {
|
||||
p = { src: p }
|
||||
}
|
||||
const pluginBaseName = path.basename(p.src, path.extname(p.src)).replace(
|
||||
/[^a-zA-Z?\d\s:]/g,
|
||||
''
|
||||
)
|
||||
|
||||
if (p.ssr === false) {
|
||||
p.mode = 'client'
|
||||
} else if (p.mode === undefined) {
|
||||
p.mode = 'all'
|
||||
p.src.replace(modePattern, (_, mode) => {
|
||||
if (modes.includes(mode)) {
|
||||
p.mode = mode
|
||||
}
|
||||
})
|
||||
} else if (!['client', 'server', 'all'].includes(p.mode)) {
|
||||
consola.warn(`Invalid plugin mode (server/client/all): '${p.mode}'. Falling back to 'all'`)
|
||||
p.mode = 'all'
|
||||
}
|
||||
|
||||
return {
|
||||
src: this.nuxt.resolver.resolveAlias(p.src),
|
||||
mode: p.mode,
|
||||
name: 'nuxt_plugin_' + pluginBaseName + '_' + hash(p.src)
|
||||
}
|
||||
}),
|
||||
p => p.name
|
||||
)
|
||||
}
|
||||
|
||||
addOptionalTemplates (templateContext) {
|
||||
if (this.options.build.indicator) {
|
||||
// templateContext.templateFiles.push('components/nuxt-build-indicator.vue')
|
||||
}
|
||||
|
||||
if (this.options.loading !== false) {
|
||||
// templateContext.templateFiles.push('components/nuxt-loading.vue')
|
||||
}
|
||||
}
|
||||
|
||||
async resolveFiles (dir, cwd = this.options.srcDir) {
|
||||
return this.ignore.filter(await glob(this.globPathWithExtensions(dir), {
|
||||
cwd,
|
||||
follow: this.options.build.followSymlinks
|
||||
}))
|
||||
}
|
||||
|
||||
async resolveRelative (dir) {
|
||||
const dirPrefix = new RegExp(`^${dir}/`)
|
||||
return (await this.resolveFiles(dir)).map(file => ({ src: file.replace(dirPrefix, '') }))
|
||||
}
|
||||
|
||||
async resolveApp ({ templateVars }) {
|
||||
templateVars.appPath = 'app/app.tutorial.vue'
|
||||
|
||||
for (const appFile of this.appFiles) {
|
||||
if (await fsExtra.exists(appFile)) {
|
||||
templateVars.appPath = appFile
|
||||
templateVars.hasApp = true
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
templateVars.hasApp = false
|
||||
}
|
||||
|
||||
async resolveLayouts ({ templateVars, templateFiles }) {
|
||||
if (!this.options.features.layouts) {
|
||||
return
|
||||
}
|
||||
|
||||
if (await fsExtra.exists(path.resolve(this.options.srcDir, this.options.dir.layouts))) {
|
||||
for (const file of await this.resolveFiles(this.options.dir.layouts)) {
|
||||
const name = file
|
||||
.replace(new RegExp(`^${this.options.dir.layouts}/`), '')
|
||||
.replace(new RegExp(`\\.(${this.supportedExtensions.join('|')})$`), '')
|
||||
|
||||
// Layout Priority: module.addLayout > .vue file > other extensions
|
||||
if (name === 'error') {
|
||||
if (!templateVars.components.ErrorPage) {
|
||||
templateVars.components.ErrorPage = this.relativeToBuild(
|
||||
this.options.srcDir,
|
||||
file
|
||||
)
|
||||
}
|
||||
} else if (this.options.layouts[name]) {
|
||||
consola.warn(`Duplicate layout registration, "${name}" has been registered as "${this.options.layouts[name]}"`)
|
||||
} else if (!templateVars.layouts[name] || /\.vue$/.test(file)) {
|
||||
templateVars.layouts[name] = this.relativeToBuild(
|
||||
this.options.srcDir,
|
||||
file
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If no default layout, create its folder and add the default folder
|
||||
if (!templateVars.layouts.default) {
|
||||
await fsExtra.mkdirp(r(this.options.buildDir, 'layouts'))
|
||||
templateFiles.push('layouts/default.vue')
|
||||
templateVars.layouts.default = './layouts/default.vue'
|
||||
}
|
||||
}
|
||||
|
||||
async resolvePages (templateContext) {
|
||||
const { templateVars } = templateContext
|
||||
|
||||
const pagesDir = path.join(this.options.srcDir, this.options.dir.pages)
|
||||
this._nuxtPages = templateContext.hasPages = await fsExtra.exists(pagesDir)
|
||||
|
||||
if (!templateContext.hasPages) {
|
||||
return
|
||||
}
|
||||
|
||||
const { routeNameSplitter, trailingSlash } = this.options.router
|
||||
|
||||
// Use nuxt.js createRoutes bases on pages/
|
||||
const files = {}
|
||||
const ext = new RegExp(`\\.(${this.supportedExtensions.join('|')})$`)
|
||||
for (const page of await this.resolveFiles(this.options.dir.pages)) {
|
||||
const key = page.replace(ext, '')
|
||||
// .vue file takes precedence over other extensions
|
||||
if (/\.vue$/.test(page) || !files[key]) {
|
||||
files[key] = page.replace(/(['"])/g, '\\$1')
|
||||
}
|
||||
}
|
||||
|
||||
templateVars.router.routes = createRoutes({
|
||||
files: Object.values(files),
|
||||
srcDir: this.options.srcDir,
|
||||
pagesDir: this.options.dir.pages,
|
||||
routeNameSplitter,
|
||||
supportedExtensions: this.supportedExtensions,
|
||||
trailingSlash
|
||||
})
|
||||
|
||||
// TODO: Support custom createRoutes
|
||||
// else { // If user defined a custom method to create routes
|
||||
// templateVars.router.routes = await this.options.build.createRoutes(
|
||||
// this.options.srcDir
|
||||
// )
|
||||
// }
|
||||
|
||||
await this.nuxt.callHook(
|
||||
'build:extendRoutes',
|
||||
templateVars.router.routes,
|
||||
r
|
||||
)
|
||||
// router.extendRoutes method
|
||||
if (typeof this.options.router.extendRoutes === 'function') {
|
||||
// let the user extend the routes
|
||||
const extendedRoutes = this.options.router.extendRoutes(
|
||||
templateVars.router.routes,
|
||||
r
|
||||
)
|
||||
// Only overwrite routes when something is returned for backwards compatibility
|
||||
if (extendedRoutes !== undefined) {
|
||||
templateVars.router.routes = extendedRoutes
|
||||
}
|
||||
}
|
||||
|
||||
// Make routes accessible for other modules and webpack configs
|
||||
this.routes = templateVars.router.routes
|
||||
}
|
||||
|
||||
async resolveStore ({ templateVars, templateFiles }) {
|
||||
// Add store if needed
|
||||
if (!this.options.features.store || !this.options.store) {
|
||||
return
|
||||
}
|
||||
|
||||
templateVars.storeModules = (await this.resolveRelative(this.options.dir.store))
|
||||
.sort(({ src: p1 }, { src: p2 }) => {
|
||||
// modules are sorted from low to high priority (for overwriting properties)
|
||||
let res = p1.split('/').length - p2.split('/').length
|
||||
if (res === 0 && p1.includes('/index.')) {
|
||||
res = -1
|
||||
} else if (res === 0 && p2.includes('/index.')) {
|
||||
res = 1
|
||||
}
|
||||
return res
|
||||
})
|
||||
|
||||
templateFiles.push('store.js')
|
||||
}
|
||||
|
||||
async resolveMiddleware ({ templateVars, templateFiles }) {
|
||||
if (!this.options.features.middleware) {
|
||||
return
|
||||
}
|
||||
|
||||
const middleware = await this.resolveRelative(this.options.dir.middleware)
|
||||
const extRE = new RegExp(`\\.(${this.supportedExtensions.join('|')})$`)
|
||||
templateVars.middleware = middleware.map(({ src }) => {
|
||||
const name = src.replace(extRE, '')
|
||||
const dst = this.relativeToBuild(this.options.srcDir, this.options.dir.middleware, src)
|
||||
return { name, src, dst }
|
||||
})
|
||||
|
||||
// templateFiles.push('middleware.js')
|
||||
}
|
||||
|
||||
async resolveCustomTemplates (templateContext) {
|
||||
// Sanitize custom template files
|
||||
this.options.build.templates = this.options.build.templates.map((t) => {
|
||||
const src = typeof t === 'string' ? t : t.src
|
||||
return {
|
||||
src: r(this.options.srcDir, src),
|
||||
dst: t.dst || path.basename(src),
|
||||
custom: true,
|
||||
...(typeof t === 'object' ? t : undefined)
|
||||
}
|
||||
})
|
||||
|
||||
const customTemplateFiles = this.options.build.templates.map(t => t.dst || path.basename(typeof t === 'string' ? t : t.src))
|
||||
|
||||
const templatePaths = uniq([
|
||||
// Modules & user provided templates
|
||||
// first custom to keep their index
|
||||
...customTemplateFiles,
|
||||
// @nuxt/app templates
|
||||
...templateContext.templateFiles
|
||||
])
|
||||
|
||||
const appDir = path.resolve(this.options.srcDir, this.options.dir.app)
|
||||
|
||||
templateContext.templateFiles = await Promise.all(templatePaths.map(async (file) => {
|
||||
// Use custom file if provided in build.templates[]
|
||||
const customTemplateIndex = customTemplateFiles.indexOf(file)
|
||||
const customTemplate = customTemplateIndex !== -1 ? this.options.build.templates[customTemplateIndex] : null
|
||||
let src = customTemplate ? (customTemplate.src || customTemplate) : r(this.template.dir, file)
|
||||
|
||||
// Allow override templates using a file with same name in ${srcDir}/app
|
||||
const customAppFile = path.resolve(this.options.srcDir, this.options.dir.app, file)
|
||||
const customAppFileExists = customAppFile.startsWith(appDir) && await fsExtra.exists(customAppFile)
|
||||
if (customAppFileExists) {
|
||||
src = customAppFile
|
||||
}
|
||||
|
||||
return {
|
||||
src,
|
||||
dst: file,
|
||||
custom: Boolean(customAppFileExists || customTemplate),
|
||||
options: (customTemplate && customTemplate.options) || {}
|
||||
}
|
||||
}))
|
||||
}
|
||||
|
||||
async resolveLoadingIndicator ({ templateFiles }) {
|
||||
if (typeof this.options.loadingIndicator !== 'object' || !this.options.loadingIndicator.name) {
|
||||
return
|
||||
}
|
||||
let indicatorPath = path.resolve(
|
||||
this.template.dir,
|
||||
'views/loading',
|
||||
this.options.loadingIndicator.name + '.html'
|
||||
)
|
||||
|
||||
let customIndicator = false
|
||||
if (!await fsExtra.exists(indicatorPath)) {
|
||||
indicatorPath = this.nuxt.resolver.resolveAlias(
|
||||
this.options.loadingIndicator.name
|
||||
)
|
||||
|
||||
if (await fsExtra.exists(indicatorPath)) {
|
||||
customIndicator = true
|
||||
} else {
|
||||
indicatorPath = null
|
||||
}
|
||||
}
|
||||
|
||||
if (!indicatorPath) {
|
||||
// TODO
|
||||
// consola.error(
|
||||
// `Could not fetch loading indicator: ${
|
||||
// this.options.loadingIndicator.name
|
||||
// }`
|
||||
// )
|
||||
return
|
||||
}
|
||||
|
||||
templateFiles.push({
|
||||
src: indicatorPath,
|
||||
dst: 'loading.html',
|
||||
custom: customIndicator,
|
||||
options: this.options.loadingIndicator
|
||||
})
|
||||
}
|
||||
|
||||
async compileTemplates (templateContext) {
|
||||
// Prepare template options
|
||||
const { templateVars, templateFiles, templateOptions } = templateContext
|
||||
|
||||
await this.nuxt.callHook('build:templates', {
|
||||
templateVars,
|
||||
templatesFiles: templateFiles,
|
||||
resolve: r
|
||||
})
|
||||
|
||||
templateOptions.imports = {
|
||||
...templateOptions.imports,
|
||||
resolvePath: this.nuxt.resolver.resolvePath,
|
||||
resolveAlias: this.nuxt.resolver.resolveAlias,
|
||||
relativeToBuild: this.relativeToBuild
|
||||
}
|
||||
|
||||
// Interpret and move template files to .nuxt/
|
||||
await Promise.all(
|
||||
templateFiles.map(async (templateFile) => {
|
||||
const { src, dst, custom } = templateFile
|
||||
|
||||
// Add custom templates to watcher
|
||||
if (custom) {
|
||||
this.options.build.watch.push(src)
|
||||
}
|
||||
|
||||
// Render template to dst
|
||||
const fileContent = await fsExtra.readFile(src, 'utf8')
|
||||
|
||||
let content
|
||||
try {
|
||||
const templateFunction = template(fileContent, templateOptions)
|
||||
content = stripWhitespace(
|
||||
templateFunction({
|
||||
...templateVars,
|
||||
...templateFile
|
||||
})
|
||||
)
|
||||
} catch (err) {
|
||||
throw new Error(`Could not compile template ${src}: ${err.message}`)
|
||||
}
|
||||
|
||||
// Ensure parent dir exits and write file
|
||||
const relativePath = r(this.options.buildDir, dst)
|
||||
await fsExtra.outputFile(relativePath, content, 'utf8')
|
||||
})
|
||||
)
|
||||
}
|
||||
|
||||
resolvePlugins () {
|
||||
// Check plugins exist then set alias to their real path
|
||||
return Promise.all(this.plugins.map(async (p) => {
|
||||
const ext = '{?(.+([^.])),/index.+([^.])}'
|
||||
const pluginFiles = await glob(`${p.src}${ext}`)
|
||||
|
||||
if (!pluginFiles || pluginFiles.length === 0) {
|
||||
throw new Error(`Plugin not found: ${p.src}`)
|
||||
}
|
||||
|
||||
if (pluginFiles.length > 1 && !isIndexFileAndFolder(pluginFiles)) {
|
||||
consola.warn({
|
||||
message: `Found ${pluginFiles.length} plugins that match the configuration, suggest to specify extension:`,
|
||||
additional: '\n' + pluginFiles.map(x => `- ${x}`).join('\n')
|
||||
})
|
||||
}
|
||||
|
||||
p.src = this.relativeToBuild(p.src)
|
||||
}))
|
||||
}
|
||||
|
||||
// TODO: Uncomment when generateConfig enabled again
|
||||
// async generateConfig () {
|
||||
// const config = path.resolve(this.options.buildDir, 'build.config.js')
|
||||
// const options = omit(this.options, Options.unsafeKeys)
|
||||
// await fsExtra.writeFile(
|
||||
// config,
|
||||
// `export default ${JSON.stringify(options, null, ' ')}`,
|
||||
// 'utf8'
|
||||
// )
|
||||
// }
|
||||
|
||||
createFileWatcher (patterns, events, listener, watcherCreatedCallback) {
|
||||
const options = this.options.watchers.chokidar
|
||||
const watcher = chokidar.watch(patterns, options)
|
||||
|
||||
for (const event of events) {
|
||||
watcher.on(event, listener)
|
||||
}
|
||||
|
||||
// TODO: due to fixes in chokidar this isnt used anymore and could be removed in Nuxt v3
|
||||
const { rewatchOnRawEvents } = this.options.watchers
|
||||
if (rewatchOnRawEvents && Array.isArray(rewatchOnRawEvents)) {
|
||||
watcher.on('raw', (_event) => {
|
||||
if (rewatchOnRawEvents.includes(_event)) {
|
||||
watcher.close()
|
||||
|
||||
listener()
|
||||
this.createFileWatcher(patterns, events, listener, watcherCreatedCallback)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
if (typeof watcherCreatedCallback === 'function') {
|
||||
watcherCreatedCallback(watcher)
|
||||
}
|
||||
}
|
||||
|
||||
assignWatcher (key: string) {
|
||||
return (watcher) => {
|
||||
if (this.watchers[key]) {
|
||||
this.watchers[key].close()
|
||||
}
|
||||
this.watchers[key] = watcher
|
||||
}
|
||||
}
|
||||
|
||||
watchClient () {
|
||||
let patterns = [
|
||||
r(this.options.srcDir, this.options.dir.layouts),
|
||||
r(this.options.srcDir, this.options.dir.middleware),
|
||||
...this.appFiles
|
||||
]
|
||||
|
||||
if (this.options.store) {
|
||||
patterns.push(r(this.options.srcDir, this.options.dir.store))
|
||||
}
|
||||
|
||||
if (this._nuxtPages && !this._defaultPage) {
|
||||
patterns.push(r(this.options.srcDir, this.options.dir.pages))
|
||||
}
|
||||
|
||||
patterns = patterns.map(path => upath.normalizeSafe(this.globPathWithExtensions(path)))
|
||||
|
||||
const refreshFiles = debounce(() => this.generateRoutesAndFiles(), 200)
|
||||
|
||||
// Watch for src Files
|
||||
this.createFileWatcher(patterns, ['add', 'unlink'], refreshFiles, this.assignWatcher('files'))
|
||||
|
||||
// Watch for custom provided files
|
||||
const customPatterns = uniq([
|
||||
...this.options.build.watch,
|
||||
...Object.values(omit(this.options.build.styleResources, ['options']))
|
||||
]).map(upath.normalizeSafe)
|
||||
|
||||
if (customPatterns.length === 0) {
|
||||
return
|
||||
}
|
||||
|
||||
this.createFileWatcher(customPatterns, ['change'], refreshFiles, this.assignWatcher('custom'))
|
||||
|
||||
// Watch for app/ files
|
||||
this.createFileWatcher([r(this.options.srcDir, this.options.dir.app)], ['add', 'change', 'unlink'], refreshFiles, this.assignWatcher('app'))
|
||||
}
|
||||
|
||||
serverMiddlewareHMR () {
|
||||
// Check nuxt.server dependency
|
||||
if (!this.nuxt.server) {
|
||||
return
|
||||
}
|
||||
|
||||
// Get registered server middleware with path
|
||||
const entries = this.nuxt.server.serverMiddlewarePaths()
|
||||
|
||||
// Resolve dependency tree
|
||||
const deps = new Set()
|
||||
const dep2Entry = {}
|
||||
|
||||
for (const entry of entries) {
|
||||
for (const dep of scanRequireTree(entry)) {
|
||||
deps.add(dep)
|
||||
if (!dep2Entry[dep]) {
|
||||
dep2Entry[dep] = new Set()
|
||||
}
|
||||
dep2Entry[dep].add(entry)
|
||||
}
|
||||
}
|
||||
|
||||
// Create watcher
|
||||
this.createFileWatcher(
|
||||
Array.from(deps),
|
||||
['all'],
|
||||
debounce((event, fileName) => {
|
||||
if (!dep2Entry[fileName]) {
|
||||
return // #7097
|
||||
}
|
||||
for (const entry of dep2Entry[fileName]) {
|
||||
// Reload entry
|
||||
let newItem
|
||||
try {
|
||||
newItem = this.nuxt.server.replaceMiddleware(entry, entry)
|
||||
} catch (error) {
|
||||
consola.error(error)
|
||||
consola.error(`[HMR Error]: ${error}`)
|
||||
}
|
||||
|
||||
if (!newItem) {
|
||||
// Full reload if HMR failed
|
||||
return this.nuxt.callHook('watch:restart', { event, path: fileName })
|
||||
}
|
||||
|
||||
// Log
|
||||
consola.info(`[HMR] ${chalk.cyan(newItem.route || '/')} (${chalk.grey(fileName)})`)
|
||||
}
|
||||
// Tree may be changed so recreate watcher
|
||||
this.serverMiddlewareHMR()
|
||||
}, 200),
|
||||
this.assignWatcher('serverMiddleware')
|
||||
)
|
||||
}
|
||||
|
||||
watchRestart () {
|
||||
const nuxtRestartWatch = [
|
||||
// Custom watchers
|
||||
...this.options.watch
|
||||
].map(this.nuxt.resolver.resolveAlias)
|
||||
|
||||
if (this.ignore.ignoreFile) {
|
||||
nuxtRestartWatch.push(this.ignore.ignoreFile)
|
||||
}
|
||||
|
||||
if (this.options._envConfig && this.options._envConfig.dotenv) {
|
||||
nuxtRestartWatch.push(this.options._envConfig.dotenv)
|
||||
}
|
||||
|
||||
// If default page displayed, watch for first page creation
|
||||
if (this._nuxtPages && this._defaultPage) {
|
||||
nuxtRestartWatch.push(path.join(this.options.srcDir, this.options.dir.pages))
|
||||
}
|
||||
// If store not activated, watch for a file in the directory
|
||||
if (!this.options.store) {
|
||||
nuxtRestartWatch.push(path.join(this.options.srcDir, this.options.dir.store))
|
||||
}
|
||||
|
||||
this.createFileWatcher(
|
||||
nuxtRestartWatch,
|
||||
['all'],
|
||||
async (event, fileName) => {
|
||||
if (['add', 'change', 'unlink'].includes(event) === false) {
|
||||
return
|
||||
}
|
||||
await this.nuxt.callHook('watch:fileChanged', this, fileName) // Legacy
|
||||
await this.nuxt.callHook('watch:restart', { event, path: fileName })
|
||||
},
|
||||
this.assignWatcher('restart')
|
||||
)
|
||||
}
|
||||
|
||||
unwatch () {
|
||||
for (const watcher in this.watchers) {
|
||||
this.watchers[watcher].close()
|
||||
}
|
||||
}
|
||||
|
||||
async close () {
|
||||
if (this.__closed) {
|
||||
return
|
||||
}
|
||||
this.__closed = true
|
||||
|
||||
// Unwatch
|
||||
this.unwatch()
|
||||
|
||||
// Close bundleBuilder
|
||||
if (typeof this.bundleBuilder.close === 'function') {
|
||||
await this.bundleBuilder.close()
|
||||
}
|
||||
build () {
|
||||
return build(this)
|
||||
}
|
||||
}
|
||||
|
||||
const STATUS = {
|
||||
INITIAL: 1,
|
||||
BUILD_DONE: 2,
|
||||
BUILDING: 3
|
||||
} as const
|
||||
// Extends VueRouter
|
||||
async function build (builder: Builder) {
|
||||
const { nuxt } = builder
|
||||
|
||||
builder.app = resolveApp(nuxt, nuxt.options.srcDir)
|
||||
await copyTemplates(builder)
|
||||
|
||||
await bundle(builder)
|
||||
}
|
||||
|
||||
async function bundle ({ nuxt }: Builder) {
|
||||
// TODO: get rid of this context and directly pass nuxt to BundleBuilder
|
||||
const bundleBuilder = new BundleBuilder({
|
||||
nuxt,
|
||||
options: nuxt.options,
|
||||
buildOptions: nuxt.options.build,
|
||||
target: nuxt.options.target,
|
||||
plugins: []
|
||||
})
|
||||
await bundleBuilder.build()
|
||||
}
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
import type Builder from '../builder'
|
||||
|
||||
export default class BuildContext {
|
||||
_builder: Builder
|
||||
nuxt: Builder['nuxt']
|
||||
options: Builder['nuxt']['options']
|
||||
target: Builder['nuxt']['options']['target']
|
||||
|
||||
constructor (builder: Builder) {
|
||||
this._builder = builder
|
||||
this.nuxt = builder.nuxt
|
||||
this.options = builder.nuxt.options
|
||||
this.target = builder.nuxt.options.target
|
||||
}
|
||||
|
||||
get buildOptions () {
|
||||
return this.options.build
|
||||
}
|
||||
|
||||
get plugins () {
|
||||
return this._builder.plugins
|
||||
}
|
||||
}
|
||||
@ -1,75 +0,0 @@
|
||||
import hash from 'hash-sum'
|
||||
import uniqBy from 'lodash/uniqBy'
|
||||
import serialize from 'serialize-javascript'
|
||||
|
||||
import devalue from '@nuxt/devalue'
|
||||
import { NormalizedConfiguration } from 'src/config'
|
||||
import { r, wp, wChunk, serializeFunction, isFullStatic } from 'src/utils'
|
||||
|
||||
import type Builder from '../builder'
|
||||
|
||||
export default class TemplateContext {
|
||||
templateFiles: string[]
|
||||
templateVars: any
|
||||
|
||||
constructor (builder: Builder, options: NormalizedConfiguration) {
|
||||
this.templateFiles = Array.from(builder.template.files)
|
||||
this.templateVars = {
|
||||
nuxtOptions: options,
|
||||
features: options.features,
|
||||
extensions: options.extensions
|
||||
.map((ext: string) => ext.replace(/^\./, ''))
|
||||
.join('|'),
|
||||
messages: options.messages,
|
||||
splitChunks: options.build.splitChunks,
|
||||
uniqBy,
|
||||
isDev: options.dev,
|
||||
isTest: options.test,
|
||||
isFullStatic: isFullStatic(options),
|
||||
debug: options.debug,
|
||||
buildIndicator: options.dev && options.build.indicator,
|
||||
vue: { config: options.vue.config },
|
||||
fetch: options.fetch,
|
||||
mode: options.mode,
|
||||
router: options.router,
|
||||
env: options.env,
|
||||
head: options.head,
|
||||
store: options.features.store ? options.store : false,
|
||||
globalName: options.globalName,
|
||||
globals: builder.globals,
|
||||
css: options.css,
|
||||
plugins: builder.plugins,
|
||||
appPath: './App.js',
|
||||
layouts: Object.assign({}, options.layouts),
|
||||
loading:
|
||||
typeof options.loading === 'string'
|
||||
? builder.relativeToBuild(options.srcDir, options.loading)
|
||||
: options.loading,
|
||||
pageTransition: options.pageTransition,
|
||||
layoutTransition: options.layoutTransition,
|
||||
rootDir: options.rootDir,
|
||||
srcDir: options.srcDir,
|
||||
dir: options.dir,
|
||||
components: {
|
||||
ErrorPage: options.ErrorPage
|
||||
? builder.relativeToBuild(options.ErrorPage)
|
||||
: null
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
get templateOptions () {
|
||||
return {
|
||||
imports: {
|
||||
serialize,
|
||||
serializeFunction,
|
||||
devalue,
|
||||
hash,
|
||||
r,
|
||||
wp,
|
||||
wChunk
|
||||
},
|
||||
interpolate: /<%=([\s\S]+?)%>/g
|
||||
}
|
||||
}
|
||||
}
|
||||
26
packages/nuxt3/src/builder/template.ts
Normal file
26
packages/nuxt3/src/builder/template.ts
Normal file
@ -0,0 +1,26 @@
|
||||
import { resolve, join, sep } from 'path'
|
||||
import fsExtra from 'fs-extra'
|
||||
import globby from 'globby'
|
||||
import lodashTemplate from 'lodash/template'
|
||||
import { Builder } from './builder'
|
||||
|
||||
export async function copyTemplates ({ nuxt, app }: Builder) {
|
||||
// Resolve appDir
|
||||
const templatesDir = join(nuxt.options.appDir, '_templates')
|
||||
|
||||
const templateFiles = (await globby(join(templatesDir, '/**')))
|
||||
.map(f => f.replace(templatesDir + sep, ''))
|
||||
|
||||
await fsExtra.mkdirp(nuxt.options.buildDir)
|
||||
|
||||
for (const template of templateFiles) {
|
||||
const src = resolve(templatesDir, template)
|
||||
const dst = resolve(nuxt.options.buildDir, template)
|
||||
|
||||
const templateData = { app: Object.freeze(app) }
|
||||
const srcContents = await fsExtra.readFile(src, 'utf-8')
|
||||
const compiledSrc = lodashTemplate(srcContents, {})(templateData)
|
||||
|
||||
await fsExtra.writeFile(dst, compiledSrc)
|
||||
}
|
||||
}
|
||||
@ -189,7 +189,7 @@ function normalizeConfig (_options: CliConfiguration) {
|
||||
)
|
||||
)
|
||||
|
||||
const mandatoryExtensions = ['js', 'mjs']
|
||||
const mandatoryExtensions = ['js', 'mjs', 'ts', 'tsx', 'vue', 'jsx']
|
||||
|
||||
overrideProp(options, 'extensions', mandatoryExtensions
|
||||
.filter(ext => !options.extensions.includes(ext))
|
||||
|
||||
@ -128,6 +128,13 @@ export default class Resolver {
|
||||
throw new Error(`Cannot resolve "${path}" from "${resolvedPath}"`)
|
||||
}
|
||||
|
||||
tryResolvePath (path: string, options?: ResolvePathOptions) {
|
||||
try {
|
||||
return this.resolvePath(path, options)
|
||||
} catch (e) {
|
||||
}
|
||||
}
|
||||
|
||||
requireModule <T> (path: string, { useESM, isAlias, interopDefault }: RequireModuleOptions = {}): T {
|
||||
let resolvedPath = path
|
||||
let requiredModule: any
|
||||
|
||||
Loading…
Reference in New Issue
Block a user