Nuxt/lib/builder/generator.js

281 lines
8.0 KiB
JavaScript
Raw Normal View History

2018-03-16 19:11:24 +00:00
import path from 'path'
import htmlMinifier from 'html-minifier'
2018-03-16 16:12:06 +00:00
import Chalk from 'chalk'
2018-03-16 19:11:24 +00:00
import fsExtra from 'fs-extra'
2018-03-31 16:22:14 +00:00
import consola from 'consola'
import { flatRoutes, isUrl, promisifyRoute, waitFor, isString } from '../common/utils'
2018-03-31 16:22:14 +00:00
2018-03-16 16:12:06 +00:00
export default class Generator {
2017-10-30 17:41:22 +00:00
constructor(nuxt, builder) {
2017-06-11 14:17:36 +00:00
this.nuxt = nuxt
this.options = nuxt.options
this.builder = builder
2017-07-03 11:11:40 +00:00
// Set variables
2018-03-16 19:11:24 +00:00
this.staticRoutes = path.resolve(this.options.srcDir, this.options.dir.static)
this.srcBuiltPath = path.resolve(this.options.buildDir, 'dist', 'client')
this.distPath = this.options.generate.dir
2018-03-16 19:11:24 +00:00
this.distNuxtPath = path.join(
this.distPath,
isUrl(this.options.build.publicPath) ? '' : this.options.build.publicPath
)
}
2017-06-11 14:17:36 +00:00
2017-10-30 17:41:22 +00:00
async generate({ build = true, init = true } = {}) {
2018-04-01 20:20:46 +00:00
consola.debug('Initializing generator...')
2018-03-13 17:16:12 +00:00
await this.initiate({ build, init })
2018-04-01 20:20:46 +00:00
consola.debug('Preparing routes for generate...')
2018-03-13 17:16:12 +00:00
const routes = await this.initRoutes()
2018-04-01 20:20:46 +00:00
consola.info({
2018-03-31 19:56:38 +00:00
message: 'Generating pages',
badge: true,
clear: true
})
2018-03-13 17:16:12 +00:00
const errors = await this.generateRoutes(routes)
2018-03-13 17:16:12 +00:00
await this.afterGenerate()
// Done hook
await this.nuxt.callHook('generate:done', this, errors)
return { errors }
}
async initiate({ build = true, init = true } = {}) {
2017-10-30 21:39:08 +00:00
// Wait for nuxt be ready
await this.nuxt.ready()
// Call before hook
await this.nuxt.callHook('generate:before', this, this.options.generate)
2017-08-17 12:43:51 +00:00
if (build) {
// Add flag to set process.static
this.builder.forGenerate()
// Start build process
await this.builder.build()
}
// Initialize dist directory
if (init) {
await this.initDist()
2017-06-11 14:17:36 +00:00
}
}
2017-06-12 20:16:42 +00:00
async initRoutes(...args) {
2017-06-12 20:16:42 +00:00
// Resolve config.generate.routes promises before generating the routes
let generateRoutes = []
2017-06-11 14:17:36 +00:00
if (this.options.router.mode !== 'hash') {
2017-05-14 18:21:14 +00:00
try {
generateRoutes = await promisifyRoute(
this.options.generate.routes || [],
...args
)
2017-06-11 14:17:36 +00:00
} catch (e) {
2018-04-01 20:20:46 +00:00
consola.error('Could not resolve routes')
2017-06-11 14:17:36 +00:00
throw e // eslint-disable-line no-unreachable
2016-11-24 00:47:11 +00:00
}
2017-06-11 14:17:36 +00:00
}
2017-06-12 20:16:42 +00:00
// Generate only index.html for router.mode = 'hash'
let routes =
this.options.router.mode === 'hash'
? ['/']
: flatRoutes(this.options.router.routes)
routes = this.decorateWithPayloads(routes, generateRoutes)
2017-06-11 14:17:36 +00:00
2017-10-30 21:39:08 +00:00
// extendRoutes hook
await this.nuxt.callHook('generate:extendRoutes', routes)
2017-07-03 11:11:40 +00:00
return routes
}
async generateRoutes(routes) {
2018-08-08 10:54:05 +00:00
const errors = []
// Start generate process
2017-06-11 14:17:36 +00:00
while (routes.length) {
let n = 0
await Promise.all(
routes
.splice(0, this.options.generate.concurrency)
.map(async ({ route, payload }) => {
await waitFor(n++ * this.options.generate.interval)
await this.generateRoute({ route, payload, errors })
})
)
2017-06-11 14:17:36 +00:00
}
2017-06-12 20:16:42 +00:00
// Improve string representation for errors
errors.toString = () => this._formatErrors(errors)
return errors
}
_formatErrors(errors) {
return errors
.map(({ type, route, error }) => {
const isHandled = type === 'handled'
const bgColor = isHandled ? 'bgYellow' : 'bgRed'
const color = isHandled ? 'yellow' : 'red'
let line =
Chalk.black[bgColor](' GEN ERR ') + Chalk[color](` ${route}\n\n`)
if (isHandled) {
line += Chalk.grey(JSON.stringify(error, undefined, 2) + '\n')
} else {
2018-03-16 19:11:24 +00:00
line += Chalk.grey(error.stack)
}
return line
})
.join('\n')
}
async afterGenerate() {
2018-08-08 10:54:05 +00:00
const { fallback } = this.options.generate
2018-01-27 00:20:03 +00:00
// Disable SPA fallback if value isn't a non-empty string
if (typeof fallback !== 'string' || !fallback) return
2018-01-27 00:20:03 +00:00
2018-03-16 19:11:24 +00:00
const fallbackPath = path.join(this.distPath, fallback)
2018-01-27 00:20:03 +00:00
// Prevent conflicts
2018-03-16 19:11:24 +00:00
if (fsExtra.existsSync(fallbackPath)) {
2018-04-01 20:20:46 +00:00
consola.warn(`SPA fallback was configured, but the configured path (${fallbackPath}) already exists.`)
2018-01-27 00:20:03 +00:00
return
}
2018-01-27 00:20:03 +00:00
// Render and write the SPA template to the fallback path
const { html } = await this.nuxt.renderRoute('/', { spa: true })
2018-03-16 19:11:24 +00:00
await fsExtra.writeFile(fallbackPath, html, 'utf8')
}
2017-10-30 17:41:22 +00:00
async initDist() {
// Clean destination folder
2018-03-16 19:11:24 +00:00
await fsExtra.remove(this.distPath)
await this.nuxt.callHook('generate:distRemoved', this)
// Copy static and built files
/* istanbul ignore if */
2018-03-16 19:11:24 +00:00
if (fsExtra.existsSync(this.staticRoutes)) {
await fsExtra.copy(this.staticRoutes, this.distPath)
}
2018-03-16 19:11:24 +00:00
await fsExtra.copy(this.srcBuiltPath, this.distNuxtPath)
2018-08-01 16:07:43 +00:00
// Add .nojekyll file to let GitHub Pages add the _nuxt/ folder
// https://help.github.com/articles/files-that-start-with-an-underscore-are-missing/
2018-03-16 19:11:24 +00:00
const nojekyllPath = path.resolve(this.distPath, '.nojekyll')
fsExtra.writeFile(nojekyllPath, '')
await this.nuxt.callHook('generate:distCopied', this)
}
2017-10-30 17:41:22 +00:00
decorateWithPayloads(routes, generateRoutes) {
2018-08-08 10:54:05 +00:00
const routeMap = {}
// Fill routeMap for known routes
routes.forEach((route) => {
routeMap[route] = { route, payload: null }
})
// Fill routeMap with given generate.routes
generateRoutes.forEach((route) => {
2017-10-30 17:41:22 +00:00
// route is either a string or like { route : '/my_route/1', payload: {} }
const path = isString(route) ? route : route.route
routeMap[path] = {
route: path,
payload: route.payload || null
}
})
return Object.values(routeMap)
}
2017-10-30 17:41:22 +00:00
async generateRoute({ route, payload = {}, errors = [] }) {
let html
const pageErrors = []
try {
const res = await this.nuxt.renderer.renderRoute(route, {
_generate: true,
payload
})
html = res.html
if (res.error) {
pageErrors.push({ type: 'handled', route, error: res.error })
}
} catch (err) {
/* istanbul ignore next */
pageErrors.push({ type: 'unhandled', route, error: err })
Array.prototype.push.apply(errors, pageErrors)
await this.nuxt.callHook('generate:routeFailed', {
route,
errors: pageErrors
})
consola.error(this._formatErrors(pageErrors))
return false
}
let minificationOptions = this.options.build.html.minify
// Legacy: Override minification options with generate.minify if present
// TODO: Remove in Nuxt version 3
if (typeof this.options.generate.minify !== 'undefined') {
minificationOptions = this.options.generate.minify
consola.warn('generate.minify has been deprecated and will be removed in the next major version.' +
' Use build.html.minify instead!')
}
if (minificationOptions) {
try {
html = htmlMinifier.minify(html, minificationOptions)
} catch (err) /* istanbul ignore next */ {
const minifyErr = new Error(
`HTML minification failed. Make sure the route generates valid HTML. Failed HTML:\n ${html}`
)
pageErrors.push({ type: 'unhandled', route, error: minifyErr })
}
}
2018-03-16 19:21:55 +00:00
let _path
2017-11-06 07:36:28 +00:00
if (this.options.generate.subFolders) {
2018-03-16 19:21:55 +00:00
_path = path.join(route, path.sep, 'index.html') // /about -> /about/index.html
_path = _path === '/404/index.html' ? '/404.html' : _path // /404 -> /404.html
2017-11-06 07:36:28 +00:00
} else {
2018-03-16 19:21:55 +00:00
_path = route.length > 1 ? path.join(path.sep, route + '.html') : path.join(path.sep, 'index.html')
2017-11-06 07:36:28 +00:00
}
2017-10-30 22:14:21 +00:00
// Call hook to let user update the path & html
2018-03-16 19:21:55 +00:00
const page = { route, path: _path, html }
2017-10-30 22:14:21 +00:00
await this.nuxt.callHook('generate:page', page)
2018-03-16 19:11:24 +00:00
page.path = path.join(this.distPath, page.path)
// Make sure the sub folders are created
2018-03-16 19:11:24 +00:00
await fsExtra.mkdirp(path.dirname(page.path))
await fsExtra.writeFile(page.path, page.html, 'utf8')
await this.nuxt.callHook('generate:routeCreated', {
route,
path: page.path,
errors: pageErrors
})
if (pageErrors.length) {
2018-04-01 20:20:46 +00:00
consola.error('Error generating ' + route)
Array.prototype.push.apply(errors, pageErrors)
2018-03-13 17:19:39 +00:00
} else {
2018-04-01 20:20:46 +00:00
consola.success('Generated ' + route)
}
return true
}
2016-11-10 11:33:52 +00:00
}