@docusaurus/core 0.0.0-5537 → 0.0.0-5542

package/bin/docusaurus.mjs

@@ -244,7 +244,11 @@ if (!process.argv.slice(2).length) {
 cli.parse(process.argv);
 
 process.on('unhandledRejection', (err) => {
-  logger.error(err instanceof Error ? err.stack : err);
+  console.log('');
+  // Do not use logger.error here: it does not print error causes
+  console.error(err);
+  console.log('');
+
   logger.info`Docusaurus version: number=${DOCUSAURUS_VERSION}
 Node version: number=${process.version}`;
   process.exit(1);

package/lib/client/serverEntry.js

@@ -9,7 +9,6 @@ import path from 'path';
 import fs from 'fs-extra';
 // eslint-disable-next-line no-restricted-imports
 import _ from 'lodash';
-import chalk from 'chalk';
 import * as eta from 'eta';
 import { StaticRouter } from 'react-router-dom';
 import ReactDOMServer from 'react-dom/server';
@@ -27,24 +26,31 @@ function renderSSRTemplate(ssrTemplate, data) {
     const compiled = getCompiledSSRTemplate(ssrTemplate);
     return compiled(data, eta.defaultConfig);
 }
+function buildSSRErrorMessage({ error, pathname, }) {
+    const parts = [
+        `Docusaurus server-side rendering could not render static page with path ${pathname} because of error: ${error.message}`,
+    ];
+    const isNotDefinedErrorRegex = /(?:window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
+    if (isNotDefinedErrorRegex.test(error.message)) {
+        // prettier-ignore
+        parts.push(`It looks like you are using code that should run on the client-side only.
+To get around it, try using \`<BrowserOnly>\` (https://docusaurus.io/docs/docusaurus-core/#browseronly) or \`ExecutionEnvironment\` (https://docusaurus.io/docs/docusaurus-core/#executionenvironment).
+It might also require to wrap your client code in \`useEffect\` hook and/or import a third-party library dynamically (if any).`);
+    }
+    return parts.join('\n');
+}
 export default async function render(locals) {
     try {
         return await doRender(locals);
     }
-    catch (err) {
-        // We are not using logger in this file, because it seems to fail with some
-        // compilers / some polyfill methods. This is very likely a bug, but in the
-        // long term, when we output native ES modules in SSR, the bug will be gone.
-        // prettier-ignore
-        console.error(chalk.red(`${chalk.bold('[ERROR]')} Docusaurus server-side rendering could not render static page with path ${chalk.cyan.underline(locals.path)}.`));
-        const isNotDefinedErrorRegex = /(?:window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
-        if (isNotDefinedErrorRegex.test(err.message)) {
-            // prettier-ignore
-            console.info(`${chalk.cyan.bold('[INFO]')} It looks like you are using code that should run on the client-side only.
-To get around it, try using ${chalk.cyan('`<BrowserOnly>`')} (${chalk.cyan.underline('https://docusaurus.io/docs/docusaurus-core/#browseronly')}) or ${chalk.cyan('`ExecutionEnvironment`')} (${chalk.cyan.underline('https://docusaurus.io/docs/docusaurus-core/#executionenvironment')}).
-It might also require to wrap your client code in ${chalk.cyan('`useEffect`')} hook and/or import a third-party library dynamically (if any).`);
-        }
-        throw err;
+    catch (errorUnknown) {
+        const error = errorUnknown;
+        const message = buildSSRErrorMessage({ error, pathname: locals.path });
+        const ssrError = new Error(message, { cause: error });
+        // It is important to log the error here because the stacktrace causal chain
+        // is not available anymore upper in the tree (this SSR runs in eval)
+        console.error(ssrError);
+        throw ssrError;
     }
 }
 // Renderer for static-site-generator-webpack-plugin (async rendering).
@@ -124,7 +130,8 @@ async function doRender(locals) {
     }
     catch (err) {
         // prettier-ignore
-        console.error(chalk.red(`${chalk.bold('[ERROR]')} Minification of page ${chalk.cyan.underline(locals.path)} failed.`));
+        console.error(`Minification of page ${locals.path} failed.`);
+        console.error(err);
         throw err;
     }
 }

package/lib/commands/build.js

@@ -47,8 +47,9 @@ forceTerminate = true) {
             });
         }
         catch (err) {
-            logger_1.default.error `Unable to build website for locale name=${locale}.`;
-            throw err;
+            throw new Error(logger_1.default.interpolate `Unable to build website for locale name=${locale}.`, {
+                cause: err,
+            });
         }
     }
     const context = await (0, server_1.loadContext)({

package/lib/commands/start.js

@@ -124,16 +124,22 @@ async function start(siteDirParam = '.', cliOptions = {}) {
         }
     });
     const compiler = (0, webpack_1.default)(config);
-    if (process.env.E2E_TEST) {
-        compiler.hooks.done.tap('done', (stats) => {
+    compiler.hooks.done.tap('done', (stats) => {
+        const errorsWarnings = stats.toJson('errors-warnings');
+        const statsErrorMessage = (0, utils_2.formatStatsErrorMessage)(errorsWarnings);
+        if (statsErrorMessage) {
+            console.error(statsErrorMessage);
+        }
+        (0, utils_2.printStatsWarnings)(errorsWarnings);
+        if (process.env.E2E_TEST) {
             if (stats.hasErrors()) {
                 logger_1.default.error('E2E_TEST: Project has compiler errors.');
                 process.exit(1);
             }
             logger_1.default.success('E2E_TEST: Project can compile.');
             process.exit(0);
-        });
-    }
+        }
+    });
     // https://webpack.js.org/configuration/dev-server
     const defaultDevServerConfig = {
         hot: cliOptions.hotOnly ? 'only' : true,

package/lib/webpack/client.js

@@ -10,9 +10,10 @@ const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
+const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
 const base_1 = require("./base");
 const ChunkAssetPlugin_1 = tslib_1.__importDefault(require("./plugins/ChunkAssetPlugin"));
-const LogPlugin_1 = tslib_1.__importDefault(require("./plugins/LogPlugin"));
+const utils_1 = require("./utils");
 async function createClientConfig(props, minify = true) {
     const isBuilding = process.argv[2] === 'build';
     const config = await (0, base_1.createBaseConfig)(props, false, minify);
@@ -29,7 +30,7 @@ async function createClientConfig(props, minify = true) {
         plugins: [
             new ChunkAssetPlugin_1.default(),
             // Show compilation progress bar and build time.
-            new LogPlugin_1.default({
+            new webpackbar_1.default({
                 name: 'Client',
             }),
         ],
@@ -41,7 +42,8 @@ async function createClientConfig(props, minify = true) {
             apply: (compiler) => {
                 compiler.hooks.done.tap('client:done', (stats) => {
                     if (stats.hasErrors()) {
-                        logger_1.default.error('Client bundle compiled with errors therefore further build is impossible.');
+                        const errorsWarnings = stats.toJson('errors-warnings');
+                        logger_1.default.error(`Client bundle compiled with errors therefore further build is impossible.\n${(0, utils_1.formatStatsErrorMessage)(errorsWarnings)}`);
                         process.exit(1);
                     }
                 });

package/lib/webpack/server.js

@@ -12,9 +12,9 @@ const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
 const utils_1 = require("@docusaurus/utils");
 // Forked for Docusaurus: https://github.com/slorber/static-site-generator-webpack-plugin
 const static_site_generator_webpack_plugin_1 = tslib_1.__importDefault(require("@slorber/static-site-generator-webpack-plugin"));
+const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
 const base_1 = require("./base");
 const WaitPlugin_1 = tslib_1.__importDefault(require("./plugins/WaitPlugin"));
-const LogPlugin_1 = tslib_1.__importDefault(require("./plugins/LogPlugin"));
 const ssr_html_template_1 = tslib_1.__importDefault(require("./templates/ssr.html.template"));
 async function createServerConfig({ props, onLinksCollected, onHeadTagsCollected, }) {
     const { baseUrl, routesPaths, generatedFilesDir, headTags, preBodyTags, postBodyTags, siteConfig: { noIndex, trailingSlash, ssrTemplate }, } = props;
@@ -72,7 +72,7 @@ async function createServerConfig({ props, onLinksCollected, onHeadTagsCollected
                     : undefined,
             }),
             // Show compilation progress bar.
-            new LogPlugin_1.default({
+            new webpackbar_1.default({
                 name: 'Server',
                 color: 'yellow',
             }),

package/lib/webpack/utils.d.ts

@@ -5,9 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference types="node" />
-import { type Configuration, type RuleSetRule, type WebpackPluginInstance } from 'webpack';
+import webpack, { type Configuration, type RuleSetRule, type WebpackPluginInstance } from 'webpack';
 import type { TransformOptions } from '@babel/core';
 import type { Plugin } from '@docusaurus/types';
+export declare function formatStatsErrorMessage(statsJson: ReturnType<webpack.Stats['toJson']> | undefined): string | undefined;
+export declare function printStatsWarnings(statsJson: ReturnType<webpack.Stats['toJson']> | undefined): void;
 export declare function getStyleLoaders(isServer: boolean, cssOptionsArg?: {
     [key: string]: unknown;
 }): RuleSetRule[];

package/lib/webpack/utils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMinimizer = exports.getHttpsConfig = exports.compile = exports.applyConfigurePostCss = exports.applyConfigureWebpack = exports.getCustomizableJSLoader = exports.getBabelOptions = exports.getCustomBabelConfigFilePath = exports.getStyleLoaders = void 0;
+exports.getMinimizer = exports.getHttpsConfig = exports.compile = exports.applyConfigurePostCss = exports.applyConfigureWebpack = exports.getCustomizableJSLoader = exports.getBabelOptions = exports.getCustomBabelConfigFilePath = exports.getStyleLoaders = exports.printStatsWarnings = exports.formatStatsErrorMessage = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -18,6 +18,26 @@ const webpack_merge_1 = require("webpack-merge");
 const webpack_1 = tslib_1.__importDefault(require("webpack"));
 const terser_webpack_plugin_1 = tslib_1.__importDefault(require("terser-webpack-plugin"));
 const css_minimizer_webpack_plugin_1 = tslib_1.__importDefault(require("css-minimizer-webpack-plugin"));
+const formatWebpackMessages_1 = tslib_1.__importDefault(require("react-dev-utils/formatWebpackMessages"));
+function formatStatsErrorMessage(statsJson) {
+    if (statsJson?.errors?.length) {
+        // TODO formatWebpackMessages does not print stack-traces
+        // Also the error causal chain is lost here
+        // We log the stacktrace inside serverEntry.tsx for now (not ideal)
+        const { errors } = (0, formatWebpackMessages_1.default)(statsJson);
+        return errors.join('\n---\n');
+    }
+    return undefined;
+}
+exports.formatStatsErrorMessage = formatStatsErrorMessage;
+function printStatsWarnings(statsJson) {
+    if (statsJson?.warnings?.length) {
+        statsJson.warnings?.forEach((warning) => {
+            logger_1.default.warn(warning);
+        });
+    }
+}
+exports.printStatsWarnings = printStatsWarnings;
 // Utility method to get style loaders
 function getStyleLoaders(isServer, cssOptionsArg = {}) {
     const cssOptions = {
@@ -177,13 +197,10 @@ function compile(config) {
             // Let plugins consume all the stats
             const errorsWarnings = stats?.toJson('errors-warnings');
             if (stats?.hasErrors()) {
-                reject(new Error('Failed to compile with errors.'));
-            }
-            if (errorsWarnings && stats?.hasWarnings()) {
-                errorsWarnings.warnings?.forEach((warning) => {
-                    logger_1.default.warn(warning);
-                });
+                const statsErrorMessage = formatStatsErrorMessage(errorsWarnings);
+                reject(new Error(`Failed to compile due to Webpack errors.\n${statsErrorMessage}`));
             }
+            printStatsWarnings(errorsWarnings);
             // Webpack 5 requires calling close() so that persistent caching works
             // See https://github.com/webpack/webpack.js.org/pull/4775
             compiler.close((errClose) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-5537",
+  "version": "0.0.0-5542",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,13 +43,13 @@
     "@babel/runtime": "^7.21.0",
     "@babel/runtime-corejs3": "^7.21.0",
     "@babel/traverse": "^7.21.2",
-    "@docusaurus/cssnano-preset": "0.0.0-5537",
-    "@docusaurus/logger": "0.0.0-5537",
-    "@docusaurus/mdx-loader": "0.0.0-5537",
+    "@docusaurus/cssnano-preset": "0.0.0-5542",
+    "@docusaurus/logger": "0.0.0-5542",
+    "@docusaurus/mdx-loader": "0.0.0-5542",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-5537",
-    "@docusaurus/utils-common": "0.0.0-5537",
-    "@docusaurus/utils-validation": "0.0.0-5537",
+    "@docusaurus/utils": "0.0.0-5542",
+    "@docusaurus/utils-common": "0.0.0-5542",
+    "@docusaurus/utils-validation": "0.0.0-5542",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.7",
     "@svgr/webpack": "^6.5.1",
     "autoprefixer": "^10.4.13",
@@ -106,8 +106,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5537",
-    "@docusaurus/types": "0.0.0-5537",
+    "@docusaurus/module-type-aliases": "0.0.0-5542",
+    "@docusaurus/types": "0.0.0-5542",
     "@types/detect-port": "^1.3.2",
     "@types/react-dom": "^18.0.11",
     "@types/react-router-config": "^5.0.6",
@@ -127,5 +127,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "0d741c45967525fefc8f471d88371aefe8a0ad86"
+  "gitHead": "58a3d23394f5e0101913369f54fbf70193e1d36a"
 }

package/lib/webpack/plugins/LogPlugin.d.ts

@@ -1,11 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import WebpackBar from 'webpackbar';
-import type { Compiler } from 'webpack';
-export default class LogPlugin extends WebpackBar {
-    apply(compiler: Compiler): void;
-}

package/lib/webpack/plugins/LogPlugin.js

@@ -1,33 +0,0 @@
-"use strict";
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
-const formatWebpackMessages_1 = tslib_1.__importDefault(require("react-dev-utils/formatWebpackMessages"));
-function showError(arr) {
-    console.log(`\n\n${arr.join('\n')}`);
-}
-class LogPlugin extends webpackbar_1.default {
-    apply(compiler) {
-        super.apply(compiler);
-        // TODO can't this be done in compile(configs) alongside the warnings???
-        compiler.hooks.done.tap('DocusaurusLogPlugin', (stats) => {
-            if (stats.hasErrors()) {
-                const errorsWarnings = stats.toJson('errors-warnings');
-                // TODO do we really want to keep this legacy logic?
-                // let's wait and see how the react-dev-utils support Webpack5
-                // we probably want to print the error stacktraces here
-                const messages = (0, formatWebpackMessages_1.default)(errorsWarnings);
-                if (messages.errors.length) {
-                    showError(messages.errors);
-                }
-            }
-        });
-    }
-}
-exports.default = LogPlugin;