@docusaurus/core 2.3.1 → 2.4.1

package/bin/beforeCli.mjs

@@ -104,10 +104,20 @@ export default async function beforeCli() {
       .filter((p) => p.startsWith('@docusaurus'))
       .map((p) => p.concat('@latest'))
       .join(' ');
-    const isYarnUsed = await fs.pathExists(path.resolve('yarn.lock'));
-    const upgradeCommand = isYarnUsed
-      ? `yarn upgrade ${siteDocusaurusPackagesForUpdate}`
-      : `npm i ${siteDocusaurusPackagesForUpdate}`;
+
+    const getUpgradeCommand = async () => {
+      const isYarnUsed = await fs.pathExists(path.resolve('yarn.lock'));
+      if (!isYarnUsed) {
+        return `npm i ${siteDocusaurusPackagesForUpdate}`;
+      }
+
+      const isYarnClassicUsed = !(await fs.pathExists(
+        path.resolve('.yarnrc.yml'),
+      ));
+      return isYarnClassicUsed
+        ? `yarn upgrade ${siteDocusaurusPackagesForUpdate}`
+        : `yarn up ${siteDocusaurusPackagesForUpdate}`;
+    };
 
     /** @type {import('boxen').Options} */
     const boxenOptions = {
@@ -124,7 +134,7 @@ export default async function beforeCli() {
       )} → ${logger.green(`${notifier.update.latest}`)}
 
   To upgrade Docusaurus packages with the latest version, run the following command:
-  ${logger.code(upgradeCommand)}`,
+  ${logger.code(await getUpgradeCommand())}`,
       boxenOptions,
     );
 

package/bin/docusaurus.mjs

@@ -24,6 +24,12 @@ import {
 } from '../lib/index.js';
 import beforeCli from './beforeCli.mjs';
 
+// Env variables are initialized to dev, but can be overridden by each command
+// For example, "docusaurus build" overrides them to "production"
+// See also https://github.com/facebook/docusaurus/issues/8599
+process.env.BABEL_ENV ??= 'development';
+process.env.NODE_ENV ??= 'development';
+
 await beforeCli();
 
 cli.version(DOCUSAURUS_VERSION).usage('<command> [options]');

package/lib/client/BaseUrlIssueBanner/index.js

@@ -11,9 +11,11 @@ import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 // Double-security: critical CSS will hide the banner if CSS can load!
 import './styles.module.css';
-const BannerContainerId = 'docusaurus-base-url-issue-banner-container';
-const BannerId = 'docusaurus-base-url-issue-banner';
-const SuggestionContainerId = 'docusaurus-base-url-issue-banner-suggestion-container';
+// __ prefix allows search crawlers (Algolia/DocSearch) to ignore anchors
+// https://github.com/facebook/docusaurus/issues/8883#issuecomment-1516328368
+const BannerContainerId = '__docusaurus-base-url-issue-banner-container';
+const BannerId = '__docusaurus-base-url-issue-banner';
+const SuggestionContainerId = '__docusaurus-base-url-issue-banner-suggestion-container';
 const InsertBannerWindowAttribute = '__DOCUSAURUS_INSERT_BASEURL_BANNER';
 // It is important to not use React to render this banner
 // otherwise Google would index it, even if it's hidden with some critical CSS!
@@ -24,7 +26,7 @@ function createInlineHtmlBanner(baseUrl) {
     return `
 <div id="${BannerId}" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">
    <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>
-   <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>
+   <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>
    <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">${baseUrl}</span> ${baseUrl === '/' ? ' (default value)' : ''}</p>
    <p>We suggest trying baseUrl = <span id="${SuggestionContainerId}" style="font-weight: bold; color: green;"></span></p>
 </div>

package/lib/client/BaseUrlIssueBanner/styles.module.css

@@ -5,6 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-:global(#docusaurus-base-url-issue-banner-container) {
+:global(#__docusaurus-base-url-issue-banner-container) {
   display: none;
 }

package/lib/client/theme-fallback/Error/index.js

@@ -9,24 +9,39 @@
 import React from 'react';
 import Head from '@docusaurus/Head';
 import ErrorBoundary from '@docusaurus/ErrorBoundary';
+import { getErrorCausalChain } from '@docusaurus/utils-common';
 import Layout from '@theme/Layout';
 function ErrorDisplay({ error, tryAgain }) {
     return (<div style={{
             display: 'flex',
             flexDirection: 'column',
             justifyContent: 'center',
-            alignItems: 'center',
-            height: '50vh',
+            alignItems: 'flex-start',
+            minHeight: '100vh',
             width: '100%',
+            maxWidth: '80ch',
             fontSize: '20px',
+            margin: '0 auto',
+            padding: '1rem',
+        }}>
+      <h1 style={{ fontSize: '3rem' }}>This page crashed</h1>
+      <button type="button" onClick={tryAgain} style={{
+            margin: '1rem 0',
+            fontSize: '2rem',
+            cursor: 'pointer',
+            borderRadius: 20,
+            padding: '1rem',
         }}>
-      <h1>This page crashed.</h1>
-      <p>{error.message}</p>
-      <button type="button" onClick={tryAgain}>
         Try again
       </button>
+      <ErrorBoundaryError error={error}/>
     </div>);
 }
+function ErrorBoundaryError({ error }) {
+    const causalChain = getErrorCausalChain(error);
+    const fullMessage = causalChain.map((e) => e.message).join('\n\nCause:\n');
+    return <p style={{ whiteSpace: 'pre-wrap' }}>{fullMessage}</p>;
+}
 export default function Error({ error, tryAgain }) {
     // We wrap the error in its own error boundary because the layout can actually
     // throw too... Only the ErrorDisplay component is simple enough to be

package/lib/commands/build.js

@@ -29,6 +29,9 @@ async function build(siteDirParam = '.', cliOptions = {},
 // deploy, we have to let deploy finish.
 // See https://github.com/facebook/docusaurus/pull/2496
 forceTerminate = true) {
+    process.env.BABEL_ENV = 'production';
+    process.env.NODE_ENV = 'production';
+    process.env.DOCUSAURUS_CURRENT_LOCALE = cliOptions.locale;
     const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     ['SIGINT', 'SIGTERM'].forEach((sig) => {
         process.on(sig, () => process.exit());
@@ -78,8 +81,10 @@ forceTerminate = true) {
 }
 exports.build = build;
 async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLastLocale, }) {
-    process.env.BABEL_ENV = 'production';
-    process.env.NODE_ENV = 'production';
+    // Temporary workaround to unlock the ability to translate the site config
+    // We'll remove it if a better official API can be designed
+    // See https://github.com/facebook/docusaurus/issues/4542
+    process.env.DOCUSAURUS_CURRENT_LOCALE = locale;
     logger_1.default.info `name=${`[${locale}]`} Creating an optimized production build...`;
     const props = await (0, server_1.load)({
         siteDir,

package/lib/commands/start.js

@@ -26,9 +26,11 @@ const client_1 = tslib_1.__importDefault(require("../webpack/client"));
 const utils_2 = require("../webpack/utils");
 const getHostPort_1 = require("../server/getHostPort");
 async function start(siteDirParam = '.', cliOptions = {}) {
+    // Temporary workaround to unlock the ability to translate the site config
+    // We'll remove it if a better official API can be designed
+    // See https://github.com/facebook/docusaurus/issues/4542
+    process.env.DOCUSAURUS_CURRENT_LOCALE = cliOptions.locale;
     const siteDir = await fs_extra_1.default.realpath(siteDirParam);
-    process.env.NODE_ENV = 'development';
-    process.env.BABEL_ENV = 'development';
     logger_1.default.info('Starting the development server...');
     function loadSite() {
         return (0, server_1.load)({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "2.3.1",
+  "version": "2.4.1",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,13 +43,13 @@
     "@babel/runtime": "^7.18.6",
     "@babel/runtime-corejs3": "^7.18.6",
     "@babel/traverse": "^7.18.8",
-    "@docusaurus/cssnano-preset": "2.3.1",
-    "@docusaurus/logger": "2.3.1",
-    "@docusaurus/mdx-loader": "2.3.1",
+    "@docusaurus/cssnano-preset": "2.4.1",
+    "@docusaurus/logger": "2.4.1",
+    "@docusaurus/mdx-loader": "2.4.1",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "2.3.1",
-    "@docusaurus/utils-common": "2.3.1",
-    "@docusaurus/utils-validation": "2.3.1",
+    "@docusaurus/utils": "2.4.1",
+    "@docusaurus/utils-common": "2.4.1",
+    "@docusaurus/utils-validation": "2.4.1",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.7",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.7",
@@ -106,8 +106,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.3.1",
-    "@docusaurus/types": "2.3.1",
+    "@docusaurus/module-type-aliases": "2.4.1",
+    "@docusaurus/types": "2.4.1",
     "@types/detect-port": "^1.3.2",
     "@types/react-dom": "^18.0.6",
     "@types/react-router-config": "^5.0.6",
@@ -127,5 +127,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "cf12f21a10f6c5439ff931e61419c4bb03a5a2dc"
+  "gitHead": "60e657d8ae5a4a9ed1c2d777f9defd882cc12681"
 }