line_push/node_modules/@nuxt/generator/dist/generator.js
2022-07-17 13:16:16 +08:00

493 lines
15 KiB
JavaScript

/*!
* @nuxt/generator v2.13.3 (c) 2016-2020
* - All the amazing contributors
* Released under the MIT License.
* Website: https://nuxtjs.org
*/
'use strict';
Object.defineProperty(exports, '__esModule', { value: true });
function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
const path = _interopDefault(require('path'));
const chalk = _interopDefault(require('chalk'));
const consola = _interopDefault(require('consola'));
const fsExtra = _interopDefault(require('fs-extra'));
const htmlMinifier = _interopDefault(require('html-minifier'));
const nodeHtmlParser = require('node-html-parser');
const utils = require('@nuxt/utils');
function _typeof(obj) {
"@babel/helpers - typeof";
if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") {
_typeof = function (obj) {
return typeof obj;
};
} else {
_typeof = function (obj) {
return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
};
}
return _typeof(obj);
}
function isObject(val) {
return val !== null && _typeof(val) === 'object' && !Array.isArray(val);
}
function _defu(baseObj, defaults) {
if (!isObject(baseObj)) {
return _defu({}, defaults);
}
if (!isObject(defaults)) {
return _defu(baseObj, {});
}
var obj = Object.assign({}, defaults);
for (var key in baseObj) {
if (key === '__proto__' || key === 'constructor') {
continue;
}
var val = baseObj[key];
if (val === null) {
continue;
}
if (isObject(val) && isObject(obj[key])) {
obj[key] = _defu(val, obj[key]);
} else {
obj[key] = val;
}
}
return obj;
}
function defu() {
for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
args[_key] = arguments[_key];
}
return args.reduce(_defu, {});
}
var defu_1 = defu;
class Generator {
constructor (nuxt, builder) {
this.nuxt = nuxt;
this.options = nuxt.options;
this.builder = builder;
this.isFullStatic = false;
// Set variables
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;
this.distNuxtPath = path.join(
this.distPath,
utils.isUrl(this.options.build.publicPath) ? '' : this.options.build.publicPath
);
// Shared payload
this._payload = null;
this.setPayload = (payload) => {
this._payload = defu_1(payload, this._payload);
};
}
async generate ({ build = true, init = true } = {}) {
consola.debug('Initializing generator...');
await this.initiate({ build, init });
// Payloads for full static
if (this.isFullStatic) {
consola.info('Full static mode activated');
const { staticAssets } = this.options.generate;
this.staticAssetsDir = path.resolve(this.distNuxtPath, staticAssets.dir, staticAssets.version);
this.staticAssetsBase = this.options.generate.staticAssets.versionBase;
}
consola.debug('Preparing routes for generate...');
const routes = await this.initRoutes();
consola.info('Generating pages');
const errors = await this.generateRoutes(routes);
await this.afterGenerate();
// Done hook
await this.nuxt.callHook('generate:done', this, errors);
await this.nuxt.callHook('export:done', this, { errors });
return { errors }
}
async initiate ({ build = true, init = true } = {}) {
// Wait for nuxt be ready
await this.nuxt.ready();
// Call before hook
await this.nuxt.callHook('generate:before', this, this.options.generate);
await this.nuxt.callHook('export:before', this);
if (build) {
// Add flag to set process.static
this.builder.forGenerate();
// Start build process
await this.builder.build();
this.isFullStatic = utils.isFullStatic(this.options);
} else {
const hasBuilt = await fsExtra.exists(path.resolve(this.options.buildDir, 'dist', 'server', 'client.manifest.json'));
if (!hasBuilt) {
const fullStaticArgs = utils.isFullStatic(this.options) ? ' --target static' : '';
throw new Error(
`No build files found in ${this.srcBuiltPath}.\nPlease run \`nuxt build${fullStaticArgs}\` before calling \`nuxt export\``
)
}
const config = this.getBuildConfig();
if (!config || (config.target !== utils.TARGETS.static && !this.options._legacyGenerate)) {
throw new Error(
`In order to use \`nuxt export\`, you need to run \`nuxt build --target static\``
)
}
this.isFullStatic = config.isFullStatic;
this.options.render.ssr = config.ssr;
}
// Initialize dist directory
if (init) {
await this.initDist();
}
}
async initRoutes (...args) {
// Resolve config.generate.routes promises before generating the routes
let generateRoutes = [];
if (this.options.router.mode !== 'hash') {
try {
generateRoutes = await utils.promisifyRoute(
this.options.generate.routes || [],
...args
);
} catch (e) {
consola.error('Could not resolve routes');
throw e // eslint-disable-line no-unreachable
}
}
let routes = [];
// Generate only index.html for router.mode = 'hash' or client-side apps
if (this.options.router.mode === 'hash') {
routes = ['/'];
} else {
routes = utils.flatRoutes(this.getAppRoutes());
}
routes = routes.filter(route => this.shouldGenerateRoute(route));
routes = this.decorateWithPayloads(routes, generateRoutes);
// extendRoutes hook
await this.nuxt.callHook('generate:extendRoutes', routes);
await this.nuxt.callHook('export:extendRoutes', { routes });
return routes
}
shouldGenerateRoute (route) {
return this.options.generate.exclude.every((regex) => {
if (typeof regex === 'string') {
return regex !== route
}
return !regex.test(route)
})
}
getBuildConfig () {
try {
return require(path.join(this.options.buildDir, 'nuxt/config.json'))
} catch (err) {
return null
}
}
getAppRoutes () {
return require(path.join(this.options.buildDir, 'routes.json'))
}
async generateRoutes (routes) {
const errors = [];
this.routes = [];
this.generatedRoutes = new Set();
routes.forEach(({ route, ...props }) => {
route = decodeURI(route);
this.routes.push({ route, ...props });
// Add routes to the tracked generated routes (for crawler)
this.generatedRoutes.add(route);
});
// Start generate process
while (this.routes.length) {
let n = 0;
await Promise.all(
this.routes
.splice(0, this.options.generate.concurrency)
.map(async ({ route, payload }) => {
await utils.waitFor(n++ * this.options.generate.interval);
await this.generateRoute({ route, payload, errors });
})
);
}
// Improve string representation for errors
// TODO: Use consola for more consistency
errors.toString = () => this._formatErrors(errors);
return errors
}
_formatErrors (errors) {
return errors
.map(({ type, route, error }) => {
const isHandled = type === 'handled';
const color = isHandled ? 'yellow' : 'red';
let line = chalk[color](` ${route}\n\n`);
if (isHandled) {
line += chalk.grey(JSON.stringify(error, undefined, 2) + '\n');
} else {
line += chalk.grey(error.stack || error.message || `${error}`);
}
return line
})
.join('\n')
}
async afterGenerate () {
const { fallback } = this.options.generate;
// Disable SPA fallback if value isn't a non-empty string
if (typeof fallback !== 'string' || !fallback) {
return
}
const fallbackPath = path.join(this.distPath, fallback);
// Prevent conflicts
if (await fsExtra.exists(fallbackPath)) {
consola.warn(`SPA fallback was configured, but the configured path (${fallbackPath}) already exists.`);
return
}
// Render and write the SPA template to the fallback path
let { html } = await this.nuxt.server.renderRoute('/', {
spa: true,
staticAssetsBase: this.staticAssetsBase
});
try {
html = this.minifyHtml(html);
} catch (error) {
consola.warn('HTML minification failed for SPA fallback');
}
await fsExtra.writeFile(fallbackPath, html, 'utf8');
consola.success('Client-side fallback created: `' + fallback + '`');
}
async initDist () {
// Clean destination folder
await fsExtra.emptyDir(this.distPath);
consola.info(`Generating output directory: ${path.basename(this.distPath)}/`);
await this.nuxt.callHook('generate:distRemoved', this);
await this.nuxt.callHook('export:distRemoved', this);
// Copy static and built files
if (await fsExtra.exists(this.staticRoutes)) {
await fsExtra.copy(this.staticRoutes, this.distPath);
}
// Copy .nuxt/dist/client/ to dist/_nuxt/
await fsExtra.copy(this.srcBuiltPath, this.distNuxtPath);
if (this.payloadDir) {
await fsExtra.ensureDir(this.payloadDir);
}
// Add .nojekyll file to let GitHub Pages add the _nuxt/ folder
// https://help.github.com/articles/files-that-start-with-an-underscore-are-missing/
const nojekyllPath = path.resolve(this.distPath, '.nojekyll');
fsExtra.writeFile(nojekyllPath, '');
await this.nuxt.callHook('generate:distCopied', this);
await this.nuxt.callHook('export:distCopied', this);
}
decorateWithPayloads (routes, generateRoutes) {
const routeMap = {};
// Fill routeMap for known routes
routes.forEach((route) => {
routeMap[route] = { route, payload: null };
});
// Fill routeMap with given generate.routes
generateRoutes.forEach((route) => {
// route is either a string or like { route : '/my_route/1', payload: {} }
const path = utils.isString(route) ? route : route.route;
routeMap[path] = {
route: path,
payload: route.payload || null
};
});
return Object.values(routeMap)
}
async generateRoute ({ route, payload = {}, errors = [] }) {
let html;
const pageErrors = [];
const setPayload = (_payload) => {
payload = defu_1(_payload, payload);
};
// Apply shared payload
if (this._payload) {
payload = defu_1(payload, this._payload);
}
await this.nuxt.callHook('generate:route', { route, setPayload });
await this.nuxt.callHook('export:route', { route, setPayload });
try {
const renderContext = {
payload,
staticAssetsBase: this.staticAssetsBase
};
const res = await this.nuxt.server.renderRoute(route, renderContext);
html = res.html;
// If crawler activated and called from generateRoutes()
if (this.options.generate.crawler && this.options.render.ssr) {
const possibleTrailingSlash = this.options.router.trailingSlash ? '/' : '';
nodeHtmlParser.parse(html).querySelectorAll('a').map((el) => {
const sanitizedHref = (el.getAttribute('href') || '')
.replace(this.options.router.base, '/')
.replace(/\/+$/, '')
.split('?')[0]
.split('#')[0]
.trim();
const route = decodeURI(sanitizedHref + possibleTrailingSlash);
if (route.startsWith('/') && !path.extname(route) && this.shouldGenerateRoute(route) && !this.generatedRoutes.has(route)) {
this.generatedRoutes.add(route);
this.routes.push({ route });
}
});
}
// Save Static Assets
if (this.staticAssetsDir && renderContext.staticAssets) {
for (const asset of renderContext.staticAssets) {
const assetPath = path.join(this.staticAssetsDir, asset.path);
await fsExtra.ensureDir(path.dirname(assetPath));
await fsExtra.writeFile(assetPath, asset.src, 'utf-8');
}
}
if (res.error) {
pageErrors.push({ type: 'handled', route, error: res.error });
}
} catch (err) {
pageErrors.push({ type: 'unhandled', route, error: err });
errors.push(...pageErrors);
await this.nuxt.callHook('generate:routeFailed', { route, errors: pageErrors });
await this.nuxt.callHook('export:routeFailed', { route, errors: pageErrors });
consola.error(this._formatErrors(pageErrors));
return false
}
try {
html = this.minifyHtml(html);
} catch (err) {
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 });
}
let fileName;
if (this.options.generate.subFolders) {
fileName = path.join(route, path.sep, 'index.html'); // /about -> /about/index.html
fileName = fileName === '/404/index.html' ? '/404.html' : fileName; // /404 -> /404.html
} else {
const normalizedRoute = route.replace(/\/$/, '');
fileName = route.length > 1 ? path.join(path.sep, normalizedRoute + '.html') : path.join(path.sep, 'index.html');
}
// Call hook to let user update the path & html
const page = { route, path: fileName, html, exclude: false };
await this.nuxt.callHook('generate:page', page);
await this.nuxt.callHook('export:page', { page, errors: pageErrors });
if (page.exclude) {
return false
}
page.path = path.join(this.distPath, page.path);
// Make sure the sub folders are created
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 });
await this.nuxt.callHook('export:routeCreated', { route, path: page.path, errors: pageErrors });
if (pageErrors.length) {
consola.error(`Error generating route "${route}": ${pageErrors.map(e => e.error.message).join(', ')}`);
errors.push(...pageErrors);
} else {
consola.success(`Generated route "${route}"`);
}
return true
}
minifyHtml (html) {
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) {
return html
}
return htmlMinifier.minify(html, minificationOptions)
}
}
function getGenerator (nuxt) {
return new Generator(nuxt)
}
exports.Generator = Generator;
exports.getGenerator = getGenerator;