@docusaurus/core 3.3.2 → 3.5.0

package/lib/webpack/configure.js

@@ -0,0 +1,99 @@
+"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 });
+exports.applyConfigureWebpack = applyConfigureWebpack;
+exports.applyConfigurePostCss = applyConfigurePostCss;
+exports.executePluginsConfigureWebpack = executePluginsConfigureWebpack;
+const webpack_merge_1 = require("webpack-merge");
+const utils_1 = require("./utils");
+/**
+ * Helper function to modify webpack config
+ * @param configureWebpack a webpack config or a function to modify config
+ * @param config initial webpack config
+ * @param isServer indicates if this is a server webpack configuration
+ * @param jsLoader custom js loader config
+ * @param content content loaded by the plugin
+ * @returns final/ modified webpack config
+ */
+function applyConfigureWebpack(configureWebpack, config, isServer, jsLoader, content) {
+    // Export some utility functions
+    const utils = {
+        getStyleLoaders: utils_1.getStyleLoaders,
+        getJSLoader: (0, utils_1.getCustomizableJSLoader)(jsLoader),
+    };
+    if (typeof configureWebpack === 'function') {
+        const { mergeStrategy, ...res } = configureWebpack(config, isServer, utils, content) ?? {};
+        const customizeRules = mergeStrategy ?? {};
+        return (0, webpack_merge_1.mergeWithCustomize)({
+            customizeArray: (0, webpack_merge_1.customizeArray)(customizeRules),
+            customizeObject: (0, webpack_merge_1.customizeObject)(customizeRules),
+        })(config, res);
+    }
+    return config;
+}
+function applyConfigurePostCss(configurePostCss, config) {
+    // Not ideal heuristic but good enough for our use-case?
+    function isPostCssLoader(loader) {
+        return !!loader?.options?.postcssOptions;
+    }
+    // Does not handle all edge cases, but good enough for now
+    function overridePostCssOptions(entry) {
+        if (isPostCssLoader(entry)) {
+            entry.options.postcssOptions = configurePostCss(entry.options.postcssOptions);
+        }
+        else if (Array.isArray(entry.oneOf)) {
+            entry.oneOf.forEach((r) => {
+                if (r) {
+                    overridePostCssOptions(r);
+                }
+            });
+        }
+        else if (Array.isArray(entry.use)) {
+            entry.use
+                .filter((u) => typeof u === 'object')
+                .forEach((rule) => overridePostCssOptions(rule));
+        }
+    }
+    config.module?.rules?.forEach((rule) => overridePostCssOptions(rule));
+    return config;
+}
+// Plugin Lifecycle - configurePostCss()
+function executePluginsConfigurePostCss({ plugins, config, }) {
+    let resultConfig = config;
+    plugins.forEach((plugin) => {
+        const { configurePostCss } = plugin;
+        if (configurePostCss) {
+            resultConfig = applyConfigurePostCss(configurePostCss.bind(plugin), resultConfig);
+        }
+    });
+    return resultConfig;
+}
+// Plugin Lifecycle - configureWebpack()
+function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }) {
+    // Step1 - Configure Webpack
+    let resultConfig = config;
+    plugins.forEach((plugin) => {
+        const { configureWebpack } = plugin;
+        if (configureWebpack) {
+            resultConfig = applyConfigureWebpack(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
+            resultConfig, isServer, jsLoader, plugin.content);
+        }
+    });
+    // Step2 - For client code, configure PostCSS
+    // The order matters! We want to configure PostCSS on loaders
+    // that were potentially added by configureWebpack
+    // See https://github.com/facebook/docusaurus/issues/10106
+    // Note: it's useless to configure postCSS for the server
+    if (!isServer) {
+        resultConfig = executePluginsConfigurePostCss({
+            plugins,
+            config: resultConfig,
+        });
+    }
+    return resultConfig;
+}

package/lib/webpack/minification.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMinimizer = void 0;
+exports.getMinimizer = getMinimizer;
 const tslib_1 = require("tslib");
 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"));
@@ -94,4 +94,3 @@ function getMinimizer() {
     }
     return minimizer;
 }
-exports.getMinimizer = getMinimizer;

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

@@ -0,0 +1,10 @@
+/**
+ * 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 type webpack from 'webpack';
+export default class ForceTerminatePlugin implements webpack.WebpackPluginInstance {
+    apply(compiler: webpack.Compiler): void;
+}

package/lib/webpack/plugins/ForceTerminatePlugin.js

@@ -0,0 +1,25 @@
+"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 logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("../utils");
+// When building, include the plugin to force terminate building if errors
+// happened in the client bundle.
+class ForceTerminatePlugin {
+    apply(compiler) {
+        compiler.hooks.done.tap('client:done', (stats) => {
+            if (stats.hasErrors()) {
+                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);
+            }
+        });
+    }
+}
+exports.default = ForceTerminatePlugin;

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

@@ -0,0 +1,11 @@
+/**
+ * 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 CopyWebpackPlugin from 'copy-webpack-plugin';
+import type { Props } from '@docusaurus/types';
+export declare function createStaticDirectoriesCopyPlugin({ props, }: {
+    props: Props;
+}): Promise<CopyWebpackPlugin | undefined>;

package/lib/webpack/plugins/StaticDirectoriesCopyPlugin.js

@@ -0,0 +1,38 @@
+"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 });
+exports.createStaticDirectoriesCopyPlugin = createStaticDirectoriesCopyPlugin;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const copy_webpack_plugin_1 = tslib_1.__importDefault(require("copy-webpack-plugin"));
+async function createStaticDirectoriesCopyPlugin({ props, }) {
+    const { outDir, siteDir, siteConfig: { staticDirectories: staticDirectoriesOption }, } = props;
+    // The staticDirectories option can contain empty directories, or non-existent
+    // directories (e.g. user deleted `static`). Instead of issuing an error, we
+    // just silently filter them out, because user could have never configured it
+    // in the first place (the default option should always "work").
+    const staticDirectories = (await Promise.all(staticDirectoriesOption.map(async (dir) => {
+        const staticDir = path_1.default.resolve(siteDir, dir);
+        if ((await fs_extra_1.default.pathExists(staticDir)) &&
+            (await fs_extra_1.default.readdir(staticDir)).length > 0) {
+            return staticDir;
+        }
+        return '';
+    }))).filter(Boolean);
+    if (staticDirectories.length === 0) {
+        return undefined;
+    }
+    return new copy_webpack_plugin_1.default({
+        patterns: staticDirectories.map((dir) => ({
+            from: dir,
+            to: outDir,
+            toType: 'dir',
+        })),
+    });
+}

package/lib/webpack/server.js

@@ -6,13 +6,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createServerConfig;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
 const utils_1 = require("@docusaurus/utils");
 const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
-const copy_webpack_plugin_1 = tslib_1.__importDefault(require("copy-webpack-plugin"));
 const base_1 = require("./base");
 async function createServerConfig(params) {
     const { props } = params;
@@ -41,34 +40,7 @@ async function createServerConfig(params) {
                 name: 'Server',
                 color: 'yellow',
             }),
-            await createStaticDirectoriesCopyPlugin(params),
         ].filter(Boolean),
     });
     return { config, serverBundlePath };
 }
-exports.default = createServerConfig;
-async function createStaticDirectoriesCopyPlugin({ props }) {
-    const { outDir, siteDir, siteConfig: { staticDirectories: staticDirectoriesOption }, } = props;
-    // The staticDirectories option can contain empty directories, or non-existent
-    // directories (e.g. user deleted `static`). Instead of issuing an error, we
-    // just silently filter them out, because user could have never configured it
-    // in the first place (the default option should always "work").
-    const staticDirectories = (await Promise.all(staticDirectoriesOption.map(async (dir) => {
-        const staticDir = path_1.default.resolve(siteDir, dir);
-        if ((await fs_extra_1.default.pathExists(staticDir)) &&
-            (await fs_extra_1.default.readdir(staticDir)).length > 0) {
-            return staticDir;
-        }
-        return '';
-    }))).filter(Boolean);
-    if (staticDirectories.length === 0) {
-        return undefined;
-    }
-    return new copy_webpack_plugin_1.default({
-        patterns: staticDirectories.map((dir) => ({
-            from: dir,
-            to: outDir,
-            toType: 'dir',
-        })),
-    });
-}

package/lib/webpack/utils.d.ts

@@ -4,10 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="node" />
 import webpack, { type Configuration, type RuleSetRule } from 'webpack';
 import type { TransformOptions } from '@babel/core';
-import type { Plugin, LoadedPlugin } 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?: {
@@ -18,31 +16,10 @@ export declare function getBabelOptions({ isServer, babelOptions, }?: {
     isServer?: boolean;
     babelOptions?: TransformOptions | string;
 }): TransformOptions;
-export declare const getCustomizableJSLoader: (jsLoader?: 'babel' | ((isServer: boolean) => RuleSetRule)) => ({ isServer, babelOptions, }: {
+export declare const getCustomizableJSLoader: (jsLoader?: "babel" | ((isServer: boolean) => RuleSetRule)) => ({ isServer, babelOptions, }: {
     isServer: boolean;
     babelOptions?: TransformOptions | string;
 }) => RuleSetRule;
-/**
- * Helper function to modify webpack config
- * @param configureWebpack a webpack config or a function to modify config
- * @param config initial webpack config
- * @param isServer indicates if this is a server webpack configuration
- * @param jsLoader custom js loader config
- * @param content content loaded by the plugin
- * @returns final/ modified webpack config
- */
-export declare function applyConfigureWebpack(configureWebpack: NonNullable<Plugin['configureWebpack']>, config: Configuration, isServer: boolean, jsLoader: 'babel' | ((isServer: boolean) => RuleSetRule) | undefined, content: unknown): Configuration;
-export declare function applyConfigurePostCss(configurePostCss: NonNullable<Plugin['configurePostCss']>, config: Configuration): Configuration;
-export declare function executePluginsConfigurePostCss({ plugins, config, }: {
-    plugins: LoadedPlugin[];
-    config: Configuration;
-}): Configuration;
-export declare function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }: {
-    plugins: LoadedPlugin[];
-    config: Configuration;
-    isServer: boolean;
-    jsLoader: 'babel' | ((isServer: boolean) => RuleSetRule) | undefined;
-}): Configuration;
 declare global {
     interface Error {
         /** @see https://webpack.js.org/api/node/#error-handling */

package/lib/webpack/utils.js

@@ -6,7 +6,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHttpsConfig = exports.compile = exports.executePluginsConfigureWebpack = exports.executePluginsConfigurePostCss = exports.applyConfigurePostCss = exports.applyConfigureWebpack = exports.getCustomizableJSLoader = exports.getBabelOptions = exports.getCustomBabelConfigFilePath = exports.getStyleLoaders = exports.printStatsWarnings = exports.formatStatsErrorMessage = void 0;
+exports.getCustomizableJSLoader = void 0;
+exports.formatStatsErrorMessage = formatStatsErrorMessage;
+exports.printStatsWarnings = printStatsWarnings;
+exports.getStyleLoaders = getStyleLoaders;
+exports.getCustomBabelConfigFilePath = getCustomBabelConfigFilePath;
+exports.getBabelOptions = getBabelOptions;
+exports.compile = compile;
+exports.getHttpsConfig = getHttpsConfig;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -14,7 +21,6 @@ const crypto_1 = tslib_1.__importDefault(require("crypto"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const mini_css_extract_plugin_1 = tslib_1.__importDefault(require("mini-css-extract-plugin"));
-const webpack_merge_1 = require("webpack-merge");
 const webpack_1 = tslib_1.__importDefault(require("webpack"));
 const formatWebpackMessages_1 = tslib_1.__importDefault(require("react-dev-utils/formatWebpackMessages"));
 function formatStatsErrorMessage(statsJson) {
@@ -29,7 +35,6 @@ function formatStatsErrorMessage(statsJson) {
     }
     return undefined;
 }
-exports.formatStatsErrorMessage = formatStatsErrorMessage;
 function printStatsWarnings(statsJson) {
     if (statsJson?.warnings?.length) {
         statsJson.warnings?.forEach((warning) => {
@@ -37,7 +42,6 @@ function printStatsWarnings(statsJson) {
         });
     }
 }
-exports.printStatsWarnings = printStatsWarnings;
 // Utility method to get style loaders
 function getStyleLoaders(isServer, cssOptionsArg = {}) {
     const cssOptions = {
@@ -98,14 +102,12 @@ function getStyleLoaders(isServer, cssOptionsArg = {}) {
         },
     ];
 }
-exports.getStyleLoaders = getStyleLoaders;
 async function getCustomBabelConfigFilePath(siteDir) {
     const customBabelConfigurationPath = path_1.default.join(siteDir, utils_1.BABEL_CONFIG_FILE_NAME);
     return (await fs_extra_1.default.pathExists(customBabelConfigurationPath))
         ? customBabelConfigurationPath
         : undefined;
 }
-exports.getCustomBabelConfigFilePath = getCustomBabelConfigFilePath;
 function getBabelOptions({ isServer, babelOptions, } = {}) {
     if (typeof babelOptions === 'string') {
         return {
@@ -121,7 +123,6 @@ function getBabelOptions({ isServer, babelOptions, } = {}) {
         caller: { name: isServer ? 'server' : 'client' },
     };
 }
-exports.getBabelOptions = getBabelOptions;
 // Name is generic on purpose
 // we want to support multiple js loader implementations (babel + esbuild)
 function getDefaultBabelLoader({ isServer, babelOptions, }) {
@@ -134,84 +135,6 @@ const getCustomizableJSLoader = (jsLoader = 'babel') => ({ isServer, babelOption
     ? getDefaultBabelLoader({ isServer, babelOptions })
     : jsLoader(isServer);
 exports.getCustomizableJSLoader = getCustomizableJSLoader;
-/**
- * Helper function to modify webpack config
- * @param configureWebpack a webpack config or a function to modify config
- * @param config initial webpack config
- * @param isServer indicates if this is a server webpack configuration
- * @param jsLoader custom js loader config
- * @param content content loaded by the plugin
- * @returns final/ modified webpack config
- */
-function applyConfigureWebpack(configureWebpack, config, isServer, jsLoader, content) {
-    // Export some utility functions
-    const utils = {
-        getStyleLoaders,
-        getJSLoader: (0, exports.getCustomizableJSLoader)(jsLoader),
-    };
-    if (typeof configureWebpack === 'function') {
-        const { mergeStrategy, ...res } = configureWebpack(config, isServer, utils, content) ?? {};
-        const customizeRules = mergeStrategy ?? {};
-        return (0, webpack_merge_1.mergeWithCustomize)({
-            customizeArray: (0, webpack_merge_1.customizeArray)(customizeRules),
-            customizeObject: (0, webpack_merge_1.customizeObject)(customizeRules),
-        })(config, res);
-    }
-    return config;
-}
-exports.applyConfigureWebpack = applyConfigureWebpack;
-function applyConfigurePostCss(configurePostCss, config) {
-    // Not ideal heuristic but good enough for our use-case?
-    function isPostCssLoader(loader) {
-        return !!loader?.options?.postcssOptions;
-    }
-    // Does not handle all edge cases, but good enough for now
-    function overridePostCssOptions(entry) {
-        if (isPostCssLoader(entry)) {
-            entry.options.postcssOptions = configurePostCss(entry.options.postcssOptions);
-        }
-        else if (Array.isArray(entry.oneOf)) {
-            entry.oneOf.forEach((r) => {
-                if (r) {
-                    overridePostCssOptions(r);
-                }
-            });
-        }
-        else if (Array.isArray(entry.use)) {
-            entry.use
-                .filter((u) => typeof u === 'object')
-                .forEach((rule) => overridePostCssOptions(rule));
-        }
-    }
-    config.module?.rules?.forEach((rule) => overridePostCssOptions(rule));
-    return config;
-}
-exports.applyConfigurePostCss = applyConfigurePostCss;
-// Plugin Lifecycle - configurePostCss()
-function executePluginsConfigurePostCss({ plugins, config, }) {
-    let resultConfig = config;
-    plugins.forEach((plugin) => {
-        const { configurePostCss } = plugin;
-        if (configurePostCss) {
-            resultConfig = applyConfigurePostCss(configurePostCss.bind(plugin), resultConfig);
-        }
-    });
-    return resultConfig;
-}
-exports.executePluginsConfigurePostCss = executePluginsConfigurePostCss;
-// Plugin Lifecycle - configureWebpack()
-function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }) {
-    let resultConfig = config;
-    plugins.forEach((plugin) => {
-        const { configureWebpack } = plugin;
-        if (configureWebpack) {
-            resultConfig = applyConfigureWebpack(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
-            resultConfig, isServer, jsLoader, plugin.content);
-        }
-    });
-    return resultConfig;
-}
-exports.executePluginsConfigureWebpack = executePluginsConfigureWebpack;
 function compile(config) {
     return new Promise((resolve, reject) => {
         const compiler = (0, webpack_1.default)(config);
@@ -244,7 +167,6 @@ function compile(config) {
         });
     });
 }
-exports.compile = compile;
 // Ensure the certificate and key provided are valid and if not
 // throw an easy to debug error
 function validateKeyAndCerts({ cert, key, keyFile, crtFile, }) {
@@ -291,4 +213,3 @@ async function getHttpsConfig() {
     }
     return isHttps;
 }
-exports.getHttpsConfig = getHttpsConfig;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.3.2",
+  "version": "3.5.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,12 +43,12 @@
     "@babel/runtime": "^7.22.6",
     "@babel/runtime-corejs3": "^7.22.6",
     "@babel/traverse": "^7.22.8",
-    "@docusaurus/cssnano-preset": "3.3.2",
-    "@docusaurus/logger": "3.3.2",
-    "@docusaurus/mdx-loader": "3.3.2",
-    "@docusaurus/utils": "3.3.2",
-    "@docusaurus/utils-common": "3.3.2",
-    "@docusaurus/utils-validation": "3.3.2",
+    "@docusaurus/cssnano-preset": "3.5.0",
+    "@docusaurus/logger": "3.5.0",
+    "@docusaurus/mdx-loader": "3.5.0",
+    "@docusaurus/utils": "3.5.0",
+    "@docusaurus/utils-common": "3.5.0",
+    "@docusaurus/utils-validation": "3.5.0",
     "autoprefixer": "^10.4.14",
     "babel-loader": "^9.1.3",
     "babel-plugin-dynamic-import-node": "^2.3.3",
@@ -103,8 +103,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.3.2",
-    "@docusaurus/types": "3.3.2",
+    "@docusaurus/module-type-aliases": "3.5.0",
+    "@docusaurus/types": "3.5.0",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -124,5 +124,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "bc638d674bfbde1e254ef306697f47e764b5e107"
+  "gitHead": "cb5829f3c34b26d798b869e38ee25073488140bd"
 }