@docusaurus/core 3.5.0 → 3.5.2-canary-6121

package/lib/{templates/templates.d.ts → ssg/ssgTemplate.d.ts}

@@ -4,9 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { SSGParams } from '../ssg';
+import type { SSGParams } from './ssgParams';
 import type { AppRenderResult } from '../common';
-export type SSRTemplateData = {
+export type SSGTemplateData = {
     appHtml: string;
     baseUrl: string;
     htmlAttributes: string;
@@ -20,12 +20,13 @@ export type SSRTemplateData = {
     noIndex: boolean;
     version: string;
 };
-export type SSRTemplateCompiled = (data: SSRTemplateData) => string;
-export declare function compileSSRTemplate(template: string): Promise<SSRTemplateCompiled>;
-export declare function renderSSRTemplate({ params, result, }: {
+export type SSGTemplateCompiled = (data: SSGTemplateData) => string;
+export declare function compileSSGTemplate(template: string): Promise<SSGTemplateCompiled>;
+export declare function renderSSGTemplate({ params, result, ssgTemplate, }: {
     params: SSGParams;
     result: AppRenderResult;
+    ssgTemplate: SSGTemplateCompiled;
 }): string;
 export declare function renderHashRouterTemplate({ params, }: {
     params: SSGParams;
-}): string;
+}): Promise<string>;

package/lib/{templates/templates.js → ssg/ssgTemplate.js}

@@ -6,13 +6,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compileSSRTemplate = compileSSRTemplate;
-exports.renderSSRTemplate = renderSSRTemplate;
+exports.compileSSGTemplate = compileSSGTemplate;
+exports.renderSSGTemplate = renderSSGTemplate;
 exports.renderHashRouterTemplate = renderHashRouterTemplate;
 const tslib_1 = require("tslib");
 const eta = tslib_1.__importStar(require("eta"));
 const react_loadable_ssr_addon_v5_slorber_1 = require("react-loadable-ssr-addon-v5-slorber");
-async function compileSSRTemplate(template) {
+const logger_1 = require("@docusaurus/logger");
+async function compileSSGTemplate(template) {
     const compiledTemplate = eta.compile(template.trim(), {
         rmWhitespace: true,
     });
@@ -32,8 +33,8 @@ function getScriptsAndStylesheets({ modules, manifest, }) {
     const scripts = (bundles.js ?? []).map((b) => b.file);
     return { scripts, stylesheets };
 }
-function renderSSRTemplate({ params, result, }) {
-    const { baseUrl, headTags, preBodyTags, postBodyTags, manifest, noIndex, DOCUSAURUS_VERSION, ssrTemplate, } = params;
+function renderSSGTemplate({ params, result, ssgTemplate, }) {
+    const { baseUrl, headTags, preBodyTags, postBodyTags, manifest, noIndex, DOCUSAURUS_VERSION, } = params;
     const { html: appHtml, collectedData: { modules, helmet }, } = result;
     const { scripts, stylesheets } = getScriptsAndStylesheets({ manifest, modules });
     const htmlAttributes = helmet.htmlAttributes.toString();
@@ -59,12 +60,13 @@ function renderSSRTemplate({ params, result, }) {
         noIndex,
         version: DOCUSAURUS_VERSION,
     };
-    return ssrTemplate(data);
+    return ssgTemplate(data);
 }
-function renderHashRouterTemplate({ params, }) {
+async function renderHashRouterTemplate({ params, }) {
     const { 
     // baseUrl,
-    headTags, preBodyTags, postBodyTags, manifest, DOCUSAURUS_VERSION, ssrTemplate, } = params;
+    headTags, preBodyTags, postBodyTags, manifest, DOCUSAURUS_VERSION, ssgTemplateContent, } = params;
+    const ssgTemplate = await logger_1.PerfLogger.async('Compile SSG template', () => compileSSGTemplate(ssgTemplateContent));
     const { scripts, stylesheets } = getScriptsAndStylesheets({
         manifest,
         modules: [],
@@ -83,5 +85,5 @@ function renderHashRouterTemplate({ params, }) {
         noIndex: false,
         version: DOCUSAURUS_VERSION,
     };
-    return ssrTemplate(data);
+    return ssgTemplate(data);
 }

package/lib/ssg/ssgUtils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { SSGParams } from './ssgParams';
+export declare const SSGConcurrency: number;
+export declare function generateHashRouterEntrypoint({ content, params, }: {
+    content: string;
+    params: SSGParams;
+}): Promise<void>;
+export declare function writeStaticFile({ content, pathname, params, }: {
+    content: string;
+    pathname: string;
+    params: SSGParams;
+}): Promise<void>;

package/lib/ssg/ssgUtils.js

@@ -0,0 +1,58 @@
+"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.SSGConcurrency = void 0;
+exports.generateHashRouterEntrypoint = generateHashRouterEntrypoint;
+exports.writeStaticFile = writeStaticFile;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = tslib_1.__importDefault(require("path"));
+// Secret way to set SSR plugin concurrency option
+// Waiting for feedback before documenting this officially?
+exports.SSGConcurrency = process.env.DOCUSAURUS_SSR_CONCURRENCY
+    ? parseInt(process.env.DOCUSAURUS_SSR_CONCURRENCY, 10)
+    : // Not easy to define a reasonable option default
+        // Will still be better than Infinity
+        // See also https://github.com/sindresorhus/p-map/issues/24
+        32;
+function pathnameToFilename({ pathname, trailingSlash, }) {
+    const outputFileName = pathname.replace(/^[/\\]/, ''); // Remove leading slashes for webpack-dev-server
+    // Paths ending with .html are left untouched
+    if (/\.html?$/i.test(outputFileName)) {
+        return outputFileName;
+    }
+    // Legacy retro-compatible behavior
+    if (typeof trailingSlash === 'undefined') {
+        return path_1.default.join(outputFileName, 'index.html');
+    }
+    // New behavior: we can say if we prefer file/folder output
+    // Useful resource: https://github.com/slorber/trailing-slash-guide
+    if (pathname === '' || pathname.endsWith('/') || trailingSlash) {
+        return path_1.default.join(outputFileName, 'index.html');
+    }
+    return `${outputFileName}.html`;
+}
+async function generateHashRouterEntrypoint({ content, params, }) {
+    await writeStaticFile({
+        pathname: '/',
+        content,
+        params,
+    });
+}
+async function writeStaticFile({ content, pathname, params, }) {
+    function removeBaseUrl(p, baseUrl) {
+        return baseUrl === '/' ? p : p.replace(new RegExp(`^${baseUrl}`), '/');
+    }
+    const filename = pathnameToFilename({
+        pathname: removeBaseUrl(pathname, params.baseUrl),
+        trailingSlash: params.trailingSlash,
+    });
+    const filePath = path_1.default.join(params.outDir, filename);
+    await fs_extra_1.default.ensureDir(path_1.default.dirname(filePath));
+    await fs_extra_1.default.writeFile(filePath, content);
+}

package/lib/webpack/base.d.ts

@@ -5,11 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Configuration } from 'webpack';
-import type { Props } from '@docusaurus/types';
+import type { ConfigureWebpackUtils, FasterConfig, Props } from '@docusaurus/types';
 export declare const clientDir: string;
 export declare function excludeJS(modulePath: string): boolean;
-export declare function createBaseConfig({ props, isServer, minify, }: {
+export declare function createBaseConfig({ props, isServer, minify, faster, configureWebpackUtils, }: {
     props: Props;
     isServer: boolean;
     minify: boolean;
+    faster: FasterConfig;
+    configureWebpackUtils: ConfigureWebpackUtils;
 }): Promise<Configuration>;

package/lib/webpack/base.js

@@ -12,10 +12,9 @@ exports.createBaseConfig = createBaseConfig;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const mini_css_extract_plugin_1 = tslib_1.__importDefault(require("mini-css-extract-plugin"));
+const babel_1 = require("@docusaurus/babel");
+const bundler_1 = require("@docusaurus/bundler");
 const utils_1 = require("@docusaurus/utils");
-const utils_2 = require("./utils");
-const minification_1 = require("./minification");
 const aliases_1 = require("./aliases");
 const CSS_REGEX = /\.css$/i;
 const CSS_MODULE_REGEX = /\.module\.css$/i;
@@ -24,6 +23,14 @@ const LibrariesToTranspile = [
     'copy-text-to-clipboard', // Contains optional catch binding, incompatible with recent versions of Edge
 ];
 const LibrariesToTranspileRegex = new RegExp(LibrariesToTranspile.map((libName) => `(node_modules/${libName})`).join('|'));
+const ReactAliases = process.env
+    .DOCUSAURUS_NO_REACT_ALIASES
+    ? {}
+    : {
+        react: path_1.default.dirname(require.resolve('react/package.json')),
+        'react-dom': path_1.default.dirname(require.resolve('react-dom/package.json')),
+        '@mdx-js/react': path_1.default.dirname(require.resolve('@mdx-js/react')),
+    };
 function excludeJS(modulePath) {
     // Always transpile client dir
     if (modulePath.startsWith(exports.clientDir)) {
@@ -34,19 +41,27 @@ function excludeJS(modulePath) {
         !/docusaurus(?:(?!node_modules).)*\.jsx?$/.test(modulePath) &&
         !LibrariesToTranspileRegex.test(modulePath));
 }
-async function createBaseConfig({ props, isServer, minify, }) {
+async function createBaseConfig({ props, isServer, minify, faster, configureWebpackUtils, }) {
     const { outDir, siteDir, siteConfig, siteConfigPath, baseUrl, generatedFilesDir, routesPaths, siteMetadata, plugins, } = props;
     const totalPages = routesPaths.length;
     const isProd = process.env.NODE_ENV === 'production';
     const minimizeEnabled = minify && isProd;
-    const fileLoaderUtils = (0, utils_1.getFileLoaderUtils)();
+    const fileLoaderUtils = (0, utils_1.getFileLoaderUtils)(isServer);
     const name = isServer ? 'server' : 'client';
     const mode = isProd ? 'production' : 'development';
     const themeAliases = await (0, aliases_1.loadThemeAliases)({ siteDir, plugins });
-    return {
-        mode,
-        name,
-        cache: {
+    const createJsLoader = await (0, bundler_1.createJsLoaderFactory)({ siteConfig });
+    const CSSExtractPlugin = await (0, bundler_1.getCSSExtractPlugin)({
+        currentBundler: props.currentBundler,
+    });
+    function getCache() {
+        if (props.currentBundler.name === 'rspack') {
+            // TODO Rspack only supports memory cache (as of Sept 2024)
+            // TODO re-enable file persistent cache one Rspack supports it
+            //  See also https://rspack.dev/config/cache#cache
+            return undefined;
+        }
+        return {
             type: 'filesystem',
             // Can we share the same cache across locales?
             // Exploring that question at https://github.com/webpack/webpack/issues/13034
@@ -72,7 +87,12 @@ async function createBaseConfig({ props, isServer, minify, }) {
                     siteConfigPath,
                 ],
             },
-        },
+        };
+    }
+    return {
+        mode,
+        name,
+        cache: getCache(),
         output: {
             pathinfo: false,
             path: outDir,
@@ -89,7 +109,6 @@ async function createBaseConfig({ props, isServer, minify, }) {
         },
         devtool: isProd ? undefined : 'eval-cheap-module-source-map',
         resolve: {
-            unsafeCache: false, // Not enabled, does not seem to improve perf much
             extensions: ['.wasm', '.mjs', '.js', '.jsx', '.ts', '.tsx', '.json'],
             symlinks: true, // See https://github.com/facebook/docusaurus/issues/3272
             roots: [
@@ -101,6 +120,7 @@ async function createBaseConfig({ props, isServer, minify, }) {
                 process.cwd(),
             ],
             alias: {
+                ...ReactAliases,
                 '@site': siteDir,
                 '@generated': generatedFilesDir,
                 ...(await (0, aliases_1.loadDocusaurusAliases)()),
@@ -125,7 +145,9 @@ async function createBaseConfig({ props, isServer, minify, }) {
             // Only minimize client bundle in production because server bundle is only
             // used for static site generation
             minimize: minimizeEnabled,
-            minimizer: minimizeEnabled ? (0, minification_1.getMinimizer)() : undefined,
+            minimizer: minimizeEnabled
+                ? await (0, bundler_1.getMinimizers)({ faster, currentBundler: props.currentBundler })
+                : undefined,
             splitChunks: isServer
                 ? false
                 : {
@@ -166,16 +188,16 @@ async function createBaseConfig({ props, isServer, minify, }) {
                     test: /\.[jt]sx?$/i,
                     exclude: excludeJS,
                     use: [
-                        (0, utils_2.getCustomizableJSLoader)(siteConfig.webpack?.jsLoader)({
+                        createJsLoader({
                             isServer,
-                            babelOptions: await (0, utils_2.getCustomBabelConfigFilePath)(siteDir),
+                            babelOptions: await (0, babel_1.getCustomBabelConfigFilePath)(siteDir),
                         }),
                     ],
                 },
                 {
                     test: CSS_REGEX,
                     exclude: CSS_MODULE_REGEX,
-                    use: (0, utils_2.getStyleLoaders)(isServer, {
+                    use: configureWebpackUtils.getStyleLoaders(isServer, {
                         importLoaders: 1,
                         sourceMap: !isProd,
                     }),
@@ -184,11 +206,11 @@ async function createBaseConfig({ props, isServer, minify, }) {
                 // using the extension .module.css
                 {
                     test: CSS_MODULE_REGEX,
-                    use: (0, utils_2.getStyleLoaders)(isServer, {
+                    use: configureWebpackUtils.getStyleLoaders(isServer, {
                         modules: {
-                            localIdentName: isProd
-                                ? `[local]_[contenthash:base64:4]`
-                                : `[local]_[path][name]`,
+                            // Using the same CSS Module class pattern in dev/prod on purpose
+                            // See https://github.com/facebook/docusaurus/pull/10423
+                            localIdentName: `[local]_[contenthash:base64:4]`,
                             exportOnlyLocals: isServer,
                         },
                         importLoaders: 1,
@@ -198,7 +220,7 @@ async function createBaseConfig({ props, isServer, minify, }) {
             ],
         },
         plugins: [
-            new mini_css_extract_plugin_1.default({
+            new CSSExtractPlugin({
                 filename: isProd
                     ? 'assets/css/[name].[contenthash:8].css'
                     : '[name].css',

package/lib/webpack/client.d.ts

@@ -4,18 +4,22 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { Props } from '@docusaurus/types';
+import type { ConfigureWebpackUtils, FasterConfig, Props } from '@docusaurus/types';
 import type { Configuration } from 'webpack';
-export declare function createStartClientConfig({ props, minify, poll, }: {
+export declare function createStartClientConfig({ props, minify, poll, faster, configureWebpackUtils, }: {
     props: Props;
     minify: boolean;
     poll: number | boolean | undefined;
+    faster: FasterConfig;
+    configureWebpackUtils: ConfigureWebpackUtils;
 }): Promise<{
     clientConfig: Configuration;
 }>;
-export declare function createBuildClientConfig({ props, minify, bundleAnalyzer, }: {
+export declare function createBuildClientConfig({ props, minify, faster, configureWebpackUtils, bundleAnalyzer, }: {
     props: Props;
     minify: boolean;
+    faster: FasterConfig;
+    configureWebpackUtils: ConfigureWebpackUtils;
     bundleAnalyzer: boolean;
 }): Promise<{
     config: Configuration;

package/lib/webpack/client.js

@@ -11,18 +11,26 @@ exports.createBuildClientConfig = createBuildClientConfig;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
-const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
-const webpack_1 = tslib_1.__importDefault(require("webpack"));
 const webpack_bundle_analyzer_1 = require("webpack-bundle-analyzer");
 const react_loadable_ssr_addon_v5_slorber_1 = tslib_1.__importDefault(require("react-loadable-ssr-addon-v5-slorber"));
 const html_webpack_plugin_1 = tslib_1.__importDefault(require("html-webpack-plugin"));
+const bundler_1 = require("@docusaurus/bundler");
 const base_1 = require("./base");
 const ChunkAssetPlugin_1 = tslib_1.__importDefault(require("./plugins/ChunkAssetPlugin"));
 const CleanWebpackPlugin_1 = tslib_1.__importDefault(require("./plugins/CleanWebpackPlugin"));
 const ForceTerminatePlugin_1 = tslib_1.__importDefault(require("./plugins/ForceTerminatePlugin"));
 const StaticDirectoriesCopyPlugin_1 = require("./plugins/StaticDirectoriesCopyPlugin");
-async function createBaseClientConfig({ props, hydrate, minify, }) {
-    const baseConfig = await (0, base_1.createBaseConfig)({ props, isServer: false, minify });
+async function createBaseClientConfig({ props, hydrate, minify, faster, configureWebpackUtils, }) {
+    const baseConfig = await (0, base_1.createBaseConfig)({
+        props,
+        isServer: false,
+        minify,
+        faster,
+        configureWebpackUtils,
+    });
+    const ProgressBarPlugin = await (0, bundler_1.getProgressBarPlugin)({
+        currentBundler: props.currentBundler,
+    });
     return (0, webpack_merge_1.default)(baseConfig, {
         // Useless, disabled on purpose (errors on existing sites with no
         // browserslist config)
@@ -30,29 +38,32 @@ async function createBaseClientConfig({ props, hydrate, minify, }) {
         entry: path_1.default.resolve(__dirname, '../client/clientEntry.js'),
         optimization: {
             // Keep the runtime chunk separated to enable long term caching
-            // https://twitter.com/wSokra/status/969679223278505985
+            // https://x.com/wSokra/status/969679223278505985
             runtimeChunk: true,
         },
         plugins: [
-            new webpack_1.default.DefinePlugin({
+            new props.currentBundler.instance.DefinePlugin({
                 'process.env.HYDRATE_CLIENT_ENTRY': JSON.stringify(hydrate),
             }),
             new ChunkAssetPlugin_1.default(),
-            // Show compilation progress bar and build time.
-            new webpackbar_1.default({
+            new ProgressBarPlugin({
                 name: 'Client',
             }),
-            await (0, StaticDirectoriesCopyPlugin_1.createStaticDirectoriesCopyPlugin)({ props }),
+            await (0, StaticDirectoriesCopyPlugin_1.createStaticDirectoriesCopyPlugin)({
+                props,
+            }),
         ].filter(Boolean),
     });
 }
 // client config when running "docusaurus start"
-async function createStartClientConfig({ props, minify, poll, }) {
+async function createStartClientConfig({ props, minify, poll, faster, configureWebpackUtils, }) {
     const { siteConfig, headTags, preBodyTags, postBodyTags } = props;
     const clientConfig = (0, webpack_merge_1.default)(await createBaseClientConfig({
         props,
         minify,
         hydrate: false,
+        faster,
+        configureWebpackUtils,
     }), {
         watchOptions: {
             ignored: /node_modules\/(?!@docusaurus)/,
@@ -65,7 +76,7 @@ async function createStartClientConfig({ props, minify, poll, }) {
         plugins: [
             // Generates an `index.html` file with the <script> injected.
             new html_webpack_plugin_1.default({
-                template: path_1.default.join(__dirname, '../templates/dev.html.template.ejs'),
+                template: path_1.default.join(__dirname, './templates/dev.html.template.ejs'),
                 // So we can define the position where the scripts are injected.
                 inject: false,
                 filename: 'index.html',
@@ -79,7 +90,7 @@ async function createStartClientConfig({ props, minify, poll, }) {
     return { clientConfig };
 }
 // client config when running "docusaurus build"
-async function createBuildClientConfig({ props, minify, bundleAnalyzer, }) {
+async function createBuildClientConfig({ props, minify, faster, configureWebpackUtils, bundleAnalyzer, }) {
     // Apply user webpack config.
     const { generatedFilesDir, siteConfig } = props;
     const router = siteConfig.future.experimental_router;
@@ -87,7 +98,13 @@ async function createBuildClientConfig({ props, minify, bundleAnalyzer, }) {
     // This is because it will always be a client-rendered React app
     const hydrate = router !== 'hash';
     const clientManifestPath = path_1.default.join(generatedFilesDir, 'client-manifest.json');
-    const config = (0, webpack_merge_1.default)(await createBaseClientConfig({ props, minify, hydrate }), {
+    const config = (0, webpack_merge_1.default)(await createBaseClientConfig({
+        props,
+        minify,
+        faster,
+        configureWebpackUtils,
+        hydrate,
+    }), {
         plugins: [
             new ForceTerminatePlugin_1.default(),
             // Remove/clean build folders before building bundles.
@@ -99,7 +116,7 @@ async function createBuildClientConfig({ props, minify, bundleAnalyzer, }) {
             new react_loadable_ssr_addon_v5_slorber_1.default({
                 filename: clientManifestPath,
             }),
-        ].filter((x) => Boolean(x)),
+        ],
     });
     return { config, clientManifestPath };
 }

package/lib/webpack/configure.d.ts

@@ -4,22 +4,36 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { Configuration, RuleSetRule } from 'webpack';
-import type { Plugin, LoadedPlugin } from '@docusaurus/types';
+import { getCurrentBundler, createJsLoaderFactory } from '@docusaurus/bundler';
+import type { Configuration } from 'webpack';
+import type { Plugin, ConfigureWebpackUtils, LoadedPlugin } from '@docusaurus/types';
+/**
+ * Creates convenient utils to inject into the configureWebpack() lifecycle
+ * @param config the Docusaurus config
+ */
+export declare function createConfigureWebpackUtils({ siteConfig, }: {
+    siteConfig: Parameters<typeof createJsLoaderFactory>[0]['siteConfig'] & Parameters<typeof getCurrentBundler>[0]['siteConfig'];
+}): Promise<ConfigureWebpackUtils>;
 /**
  * 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 utils the <code>ConfigureWebpackUtils</code> utils to inject into the configureWebpack() lifecycle
  * @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 applyConfigureWebpack({ configureWebpack, config, isServer, configureWebpackUtils, content, }: {
+    configureWebpack: NonNullable<Plugin['configureWebpack']>;
+    config: Configuration;
+    isServer: boolean;
+    configureWebpackUtils: ConfigureWebpackUtils;
+    content: unknown;
+}): Configuration;
 export declare function applyConfigurePostCss(configurePostCss: NonNullable<Plugin['configurePostCss']>, config: Configuration): Configuration;
-export declare function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }: {
+export declare function executePluginsConfigureWebpack({ plugins, config: configInput, isServer, configureWebpackUtils, }: {
     plugins: LoadedPlugin[];
     config: Configuration;
     isServer: boolean;
-    jsLoader: 'babel' | ((isServer: boolean) => RuleSetRule) | undefined;
+    configureWebpackUtils: ConfigureWebpackUtils;
 }): Configuration;

package/lib/webpack/configure.js

@@ -6,28 +6,38 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConfigureWebpackUtils = createConfigureWebpackUtils;
 exports.applyConfigureWebpack = applyConfigureWebpack;
 exports.applyConfigurePostCss = applyConfigurePostCss;
 exports.executePluginsConfigureWebpack = executePluginsConfigureWebpack;
 const webpack_merge_1 = require("webpack-merge");
-const utils_1 = require("./utils");
+const bundler_1 = require("@docusaurus/bundler");
+/**
+ * Creates convenient utils to inject into the configureWebpack() lifecycle
+ * @param config the Docusaurus config
+ */
+async function createConfigureWebpackUtils({ siteConfig, }) {
+    const currentBundler = await (0, bundler_1.getCurrentBundler)({ siteConfig });
+    const getStyleLoaders = await (0, bundler_1.createStyleLoadersFactory)({ currentBundler });
+    const getJSLoader = await (0, bundler_1.createJsLoaderFactory)({ siteConfig });
+    return {
+        currentBundler,
+        getStyleLoaders,
+        getJSLoader,
+    };
+}
 /**
  * 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 utils the <code>ConfigureWebpackUtils</code> utils to inject into the configureWebpack() lifecycle
  * @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),
-    };
+function applyConfigureWebpack({ configureWebpack, config, isServer, configureWebpackUtils, content, }) {
     if (typeof configureWebpack === 'function') {
-        const { mergeStrategy, ...res } = configureWebpack(config, isServer, utils, content) ?? {};
+        const { mergeStrategy, ...res } = configureWebpack(config, isServer, configureWebpackUtils, content) ?? {};
         const customizeRules = mergeStrategy ?? {};
         return (0, webpack_merge_1.mergeWithCustomize)({
             customizeArray: (0, webpack_merge_1.customizeArray)(customizeRules),
@@ -74,14 +84,19 @@ function executePluginsConfigurePostCss({ plugins, config, }) {
     return resultConfig;
 }
 // Plugin Lifecycle - configureWebpack()
-function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }) {
+function executePluginsConfigureWebpack({ plugins, config: configInput, isServer, configureWebpackUtils, }) {
+    let config = configInput;
     // 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);
+            config = applyConfigureWebpack({
+                configureWebpack: configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
+                config,
+                isServer,
+                configureWebpackUtils,
+                content: plugin.content,
+            });
         }
     });
     // Step2 - For client code, configure PostCSS
@@ -90,10 +105,10 @@ function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }
     // See https://github.com/facebook/docusaurus/issues/10106
     // Note: it's useless to configure postCSS for the server
     if (!isServer) {
-        resultConfig = executePluginsConfigurePostCss({
+        config = executePluginsConfigurePostCss({
             plugins,
-            config: resultConfig,
+            config,
         });
     }
-    return resultConfig;
+    return config;
 }

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

@@ -5,17 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { type Compiler } from 'webpack';
-/**
- * We modify webpack runtime to add an extra function called
- * "__webpack_require__.gca" that will allow us to get the corresponding chunk
- * asset for a webpack chunk. Pass it the chunkName or chunkId you want to load.
- * For example: if you have a chunk named "my-chunk-name" that will map to
- * "/publicPath/0a84b5e7.c8e35c7a.js" as its corresponding output path
- * __webpack_require__.gca("my-chunk-name") will return
- * "/publicPath/0a84b5e7.c8e35c7a.js"
- *
- * "gca" stands for "get chunk asset"
- */
 export default class ChunkAssetPlugin {
     apply(compiler: Compiler): void;
 }