@docusaurus/core 0.0.0-4521 → 0.0.0-4526

package/lib/server/index.d.ts

@@ -19,5 +19,5 @@ export declare function loadSiteConfig({ siteDir, customConfigFilePath, }: {
     siteConfigPath: string;
 }>;
 export declare function loadContext(siteDir: string, options?: LoadContextOptions): Promise<LoadContext>;
-export declare function loadPluginConfigs(context: LoadContext): PluginConfig[];
+export declare function loadPluginConfigs(context: LoadContext): Promise<PluginConfig[]>;
 export declare function load(siteDir: string, options?: LoadContextOptions): Promise<Props>;

package/lib/server/index.js

@@ -82,8 +82,8 @@ async function loadContext(siteDir, options = {}) {
     };
 }
 exports.loadContext = loadContext;
-function loadPluginConfigs(context) {
-    let { plugins: presetPlugins, themes: presetThemes } = (0, presets_1.default)(context);
+async function loadPluginConfigs(context) {
+    let { plugins: presetPlugins, themes: presetThemes } = await (0, presets_1.default)(context);
     const { siteConfig, siteConfigPath } = context;
     const require = (0, module_1.createRequire)(siteConfigPath);
     function normalizeShorthand(pluginConfig, pluginType) {
@@ -150,10 +150,12 @@ function createBootstrapPlugin({ siteConfig, }) {
         },
     };
 }
-// Configure Webpack fallback mdx loader for md/mdx files out of content-plugin folders
-// Adds a "fallback" mdx loader for mdx files that are not processed by content plugins
-// This allows to do things such as importing repo/README.md as a partial from another doc
-// Not ideal solution though, but good enough for now
+/**
+ * Configure Webpack fallback mdx loader for md/mdx files out of content-plugin
+ * folders. Adds a "fallback" mdx loader for mdx files that are not processed by
+ * content plugins. This allows to do things such as importing repo/README.md as
+ * a partial from another doc. Not ideal solution, but good enough for now
+ */
 function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
     return {
         name: 'docusaurus-mdx-fallback-plugin',
@@ -161,9 +163,9 @@ function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
         options: {},
         version: { type: 'synthetic' },
         configureWebpack(config, isServer, { getJSLoader }) {
-            // We need the mdx fallback loader to exclude files that were already processed by content plugins mdx loaders
-            // This works, but a bit hacky...
-            // Not sure there's a way to handle that differently in webpack :s
+            // We need the mdx fallback loader to exclude files that were already
+            // processed by content plugins mdx loaders. This works, but a bit
+            // hacky... Not sure there's a way to handle that differently in webpack
             function getMDXFallbackExcludedPaths() {
                 var _a;
                 const rules = (_a = config === null || config === void 0 ? void 0 : config.module) === null || _a === void 0 ? void 0 : _a.rules;
@@ -176,7 +178,7 @@ function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
                 module: {
                     rules: [
                         {
-                            test: /(\.mdx?)$/,
+                            test: /\.mdx?$/i,
                             exclude: getMDXFallbackExcludedPaths(),
                             use: [
                                 getJSLoader({ isServer }),
@@ -203,7 +205,7 @@ async function load(siteDir, options = {}) {
     const context = await loadContext(siteDir, options);
     const { generatedFilesDir, siteConfig, siteConfigPath, outDir, baseUrl, i18n, ssrTemplate, codeTranslations, } = context;
     // Plugins.
-    const pluginConfigs = loadPluginConfigs(context);
+    const pluginConfigs = await loadPluginConfigs(context);
     const { plugins, pluginsRouteConfigs, globalData, themeConfigTranslated } = await (0, plugins_1.loadPlugins)({ pluginConfigs, context });
     // Side-effect to replace the untranslated themeConfig by the translated one
     context.siteConfig.themeConfig = themeConfigTranslated;

package/lib/server/moduleShorthand.js

@@ -13,7 +13,7 @@ function getNamePatterns(moduleName, moduleType) {
         if (!moduleName.includes('/')) {
             return [`${moduleName}/docusaurus-${moduleType}`];
         }
-        const [scope, packageName] = moduleName.split(/\/(.*)/);
+        const [scope, packageName] = moduleName.split(/\/(?<rest>.*)/);
         return [
             `${scope}/${packageName}`,
             `${scope}/docusaurus-${moduleType}-${packageName}`,

package/lib/server/plugins/index.js

@@ -57,9 +57,9 @@ async function loadPlugins({ pluginConfigs, context, }) {
         context,
     });
     // 2. Plugin Lifecycle - loadContent.
-    // Currently plugins run lifecycle methods in parallel and are not order-dependent.
-    // We could change this in future if there are plugins which need to
-    // run in certain order or depend on others for data.
+    // Currently plugins run lifecycle methods in parallel and are not
+    // order-dependent. We could change this in future if there are plugins which
+    // need to run in certain order or depend on others for data.
     const loadedPlugins = await Promise.all(plugins.map(async (plugin) => {
         const content = plugin.loadContent ? await plugin.loadContent() : null;
         return { ...plugin, content };
@@ -134,9 +134,9 @@ async function loadPlugins({ pluginConfigs, context, }) {
         });
     }));
     // 4. Plugin Lifecycle - routesLoaded.
-    // Currently plugins run lifecycle methods in parallel and are not order-dependent.
-    // We could change this in future if there are plugins which need to
-    // run in certain order or depend on others for data.
+    // Currently plugins run lifecycle methods in parallel and are not
+    // order-dependent. We could change this in future if there are plugins which
+    // need to run in certain order or depend on others for data.
     await Promise.all(contentLoadedTranslatedPlugins.map(async (plugin) => {
         if (!plugin.routesLoaded) {
             return null;

package/lib/server/plugins/init.js

@@ -13,7 +13,7 @@ const utils_1 = require("@docusaurus/utils");
 const versions_1 = require("../versions");
 const pluginIds_1 = require("./pluginIds");
 const utils_validation_1 = require("@docusaurus/utils-validation");
-function normalizePluginConfig(pluginConfig, pluginRequire) {
+async function normalizePluginConfig(pluginConfig, pluginRequire) {
     var _a, _b, _c, _d;
     // plugins: ['./plugin']
     if (typeof pluginConfig === 'string') {
@@ -71,9 +71,7 @@ function getOptionValidationFunction(normalizedPluginConfig) {
         // support both commonjs and ES modules
         return ((_c = (_b = (_a = normalizedPluginConfig.pluginModule.module) === null || _a === void 0 ? void 0 : _a.default) === null || _b === void 0 ? void 0 : _b.validateOptions) !== null && _c !== void 0 ? _c : (_d = normalizedPluginConfig.pluginModule.module) === null || _d === void 0 ? void 0 : _d.validateOptions);
     }
-    else {
-        return normalizedPluginConfig.plugin.validateOptions;
-    }
+    return normalizedPluginConfig.plugin.validateOptions;
 }
 function getThemeValidationFunction(normalizedPluginConfig) {
     var _a, _b;
@@ -81,13 +79,11 @@ function getThemeValidationFunction(normalizedPluginConfig) {
         // support both commonjs and ES modules
         return ((_b = (_a = normalizedPluginConfig.pluginModule.module.default) === null || _a === void 0 ? void 0 : _a.validateThemeConfig) !== null && _b !== void 0 ? _b : normalizedPluginConfig.pluginModule.module.validateThemeConfig);
     }
-    else {
-        return normalizedPluginConfig.plugin.validateThemeConfig;
-    }
+    return normalizedPluginConfig.plugin.validateThemeConfig;
 }
 async function initPlugins({ pluginConfigs, context, }) {
-    // We need to resolve plugins from the perspective of the siteDir, since the siteDir's package.json
-    // declares the dependency on these plugins.
+    // We need to resolve plugins from the perspective of the siteDir, since the
+    // siteDir's package.json declares the dependency on these plugins.
     const pluginRequire = (0, module_1.createRequire)(context.siteConfigPath);
     function doGetPluginVersion(normalizedPluginConfig) {
         var _a, _b;
@@ -96,9 +92,7 @@ async function initPlugins({ pluginConfigs, context, }) {
             const pluginPath = pluginRequire.resolve((_b = normalizedPluginConfig.pluginModule) === null || _b === void 0 ? void 0 : _b.path);
             return (0, versions_1.getPluginVersion)(pluginPath, context.siteDir);
         }
-        else {
-            return { type: 'local' };
-        }
+        return { type: 'local' };
     }
     function doValidateThemeConfig(normalizedPluginConfig) {
         const validateThemeConfig = getThemeValidationFunction(normalizedPluginConfig);
@@ -108,9 +102,7 @@ async function initPlugins({ pluginConfigs, context, }) {
                 themeConfig: context.siteConfig.themeConfig,
             });
         }
-        else {
-            return context.siteConfig.themeConfig;
-        }
+        return context.siteConfig.themeConfig;
     }
     function doValidatePluginOptions(normalizedPluginConfig) {
         var _a;
@@ -121,17 +113,15 @@ async function initPlugins({ pluginConfigs, context, }) {
                 options: normalizedPluginConfig.options,
             });
         }
-        else {
-            // Important to ensure all plugins have an id
-            // as we don't go through the Joi schema that adds it
-            return {
-                ...normalizedPluginConfig.options,
-                id: (_a = normalizedPluginConfig.options.id) !== null && _a !== void 0 ? _a : utils_1.DEFAULT_PLUGIN_ID,
-            };
-        }
+        // Important to ensure all plugins have an id
+        // as we don't go through the Joi schema that adds it
+        return {
+            ...normalizedPluginConfig.options,
+            id: (_a = normalizedPluginConfig.options.id) !== null && _a !== void 0 ? _a : utils_1.DEFAULT_PLUGIN_ID,
+        };
     }
     async function initializePlugin(pluginConfig) {
-        const normalizedPluginConfig = normalizePluginConfig(pluginConfig, pluginRequire);
+        const normalizedPluginConfig = await normalizePluginConfig(pluginConfig, pluginRequire);
         const pluginVersion = doGetPluginVersion(normalizedPluginConfig);
         const pluginOptions = doValidatePluginOptions(normalizedPluginConfig);
         // Side-effect: merge the normalized theme config in the original one

package/lib/server/presets/index.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { LoadContext, PluginConfig } from '@docusaurus/types';
-export default function loadPresets(context: LoadContext): {
+export default function loadPresets(context: LoadContext): Promise<{
     plugins: PluginConfig[];
     themes: PluginConfig[];
-};
+}>;

package/lib/server/presets/index.js

@@ -10,9 +10,9 @@ const tslib_1 = require("tslib");
 const module_1 = require("module");
 const import_fresh_1 = (0, tslib_1.__importDefault)(require("import-fresh"));
 const moduleShorthand_1 = require("../moduleShorthand");
-function loadPresets(context) {
-    // We need to resolve presets from the perspective of the siteDir, since the siteDir's package.json
-    // declares the dependency on these presets.
+async function loadPresets(context) {
+    // We need to resolve presets from the perspective of the siteDir, since the
+    // siteDir's package.json declares the dependency on these presets.
     const presetRequire = (0, module_1.createRequire)(context.siteConfigPath);
     const presets = context.siteConfig.presets || [];
     const unflatPlugins = [];

package/lib/server/routes.js

@@ -11,7 +11,7 @@ const lodash_1 = require("lodash");
 const querystring_1 = require("querystring");
 function indent(str) {
     const spaces = '  ';
-    return `${spaces}${str.replace(/(\n)/g, `\n${spaces}`)}`;
+    return `${spaces}${str.replace(/\n/g, `\n${spaces}`)}`;
 }
 const createRouteCodeString = ({ routePath, routeHash, exact, subroutesCodeStrings, props, }) => {
     const parts = [
@@ -73,7 +73,8 @@ async function loadRoutes(pluginsRouteConfigs, baseUrl) {
         }
         // Collect all page paths for injecting it later in the plugin lifecycle
         // This is useful for plugins like sitemaps, redirects etc...
-        // If a route has subroutes, it is not necessarily a valid page path (more likely to be a wrapper)
+        // If a route has subroutes, it is not necessarily a valid page path (more
+        // likely to be a wrapper)
         if (!subroutes) {
             routesPaths.push(routePath);
         }

package/lib/server/themes/index.js

@@ -17,8 +17,9 @@ function loadThemeAliases(themePaths, userThemePaths) {
     themePaths.forEach((themePath) => {
         const themeAliases = (0, alias_1.default)(themePath, true);
         Object.keys(themeAliases).forEach((aliasKey) => {
-            // If this alias shadows a previous one, use @theme-init to preserve the initial one.
-            // @theme-init is only applied once: to the initial theme that provided this component
+            // If this alias shadows a previous one, use @theme-init to preserve the
+            // initial one. @theme-init is only applied once: to the initial theme
+            // that provided this component
             if (aliasKey in aliases) {
                 const componentName = aliasKey.substring(aliasKey.indexOf('/') + 1);
                 const initAlias = `@theme-init/${componentName}`;

package/lib/server/translations/translations.js

@@ -56,7 +56,7 @@ function mergeTranslationFileContent({ existingContent = {}, newContent, options
     Object.entries(newContentTransformed).forEach(([key, { message, description }]) => {
         var _a, _b;
         result[key] = {
-            // If the messages already exist, we don't override them (unless requested)
+            // If messages already exist, we don't override them (unless requested)
             message: options.override
                 ? message
                 : (_b = (_a = existingContent[key]) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : message,
@@ -162,9 +162,7 @@ async function localizePluginTranslationFile({ siteDir, plugin, locale, translat
             },
         };
     }
-    else {
-        return translationFile;
-    }
+    return translationFile;
 }
 exports.localizePluginTranslationFile = localizePluginTranslationFile;
 async function getPluginsDefaultCodeTranslationMessages(plugins) {

package/lib/server/translations/translationsExtractor.js

@@ -36,8 +36,9 @@ function getSiteSourceCodeFilePaths(siteDir) {
 function getPluginSourceCodeFilePaths(plugin) {
     var _a, _b, _c;
     // The getPathsToWatch() generally returns the js/jsx/ts/tsx/md/mdx file paths
-    // We can use this method as well to know which folders we should try to extract translations from
-    // Hacky/implicit, but do we want to introduce a new lifecycle method just for that???
+    // We can use this method as well to know which folders we should try to
+    // extract translations from. Hacky/implicit, but do we want to introduce a
+    // new lifecycle method just for that???
     const codePaths = (_b = (_a = plugin.getPathsToWatch) === null || _a === void 0 ? void 0 : _a.call(plugin)) !== null && _b !== void 0 ? _b : [];
     // We also include theme code
     const themePath = (_c = plugin.getThemePath) === null || _c === void 0 ? void 0 : _c.call(plugin);
@@ -54,14 +55,16 @@ exports.globSourceCodeFilePaths = globSourceCodeFilePaths;
 async function getSourceCodeFilePaths(siteDir, plugins) {
     const sitePaths = getSiteSourceCodeFilePaths(siteDir);
     // The getPathsToWatch() generally returns the js/jsx/ts/tsx/md/mdx file paths
-    // We can use this method as well to know which folders we should try to extract translations from
-    // Hacky/implicit, but do we want to introduce a new lifecycle method for that???
+    // We can use this method as well to know which folders we should try to
+    // extract translations from. Hacky/implicit, but do we want to introduce a
+    // new lifecycle method for that???
     const pluginsPaths = plugins.flatMap(getPluginSourceCodeFilePaths);
     const allPaths = [...sitePaths, ...pluginsPaths];
     return globSourceCodeFilePaths(allPaths);
 }
 async function extractSiteSourceCodeTranslations(siteDir, plugins, babelOptions, extraSourceCodeFilePaths = []) {
-    // Should we warn here if the same translation "key" is found in multiple source code files?
+    // Should we warn here if the same translation "key" is found in multiple
+    // source code files?
     function toTranslationFileContent(sourceCodeFileTranslations) {
         return sourceCodeFileTranslations.reduce((acc, item) => ({ ...acc, ...item.translations }), {});
     }
@@ -92,8 +95,9 @@ async function extractSourceCodeFileTranslations(sourceCodeFilePath, babelOption
         const ast = (0, core_1.parse)(code, {
             ...babelOptions,
             ast: true,
-            // filename is important, because babel does not process the same files according to their js/ts extensions
-            // see  see https://twitter.com/NicoloRibaudo/status/1321130735605002243
+            // filename is important, because babel does not process the same files
+            // according to their js/ts extensions.
+            // See https://twitter.com/NicoloRibaudo/status/1321130735605002243
             filename: sourceCodeFilePath,
         });
         const translations = await extractSourceCodeAstTranslations(ast, sourceCodeFilePath);
@@ -169,12 +173,10 @@ Full code: ${(0, generator_1.default)(node).code}`;
                             typeof attributeValueEvaluated.value === 'string') {
                             return attributeValueEvaluated.value;
                         }
-                        else {
-                            warnings.push(`<Translate> prop=${propName} should be a statically evaluable object.
+                        warnings.push(`<Translate> prop=${propName} should be a statically evaluable object.
 Example: <Translate id="optional id" description="optional description">Message</Translate>
 Dynamically constructed values are not allowed, because they prevent translations to be extracted.
 ${sourceWarningPart(path.node)}`);
-                        }
                     }
                     return undefined;
                 }
@@ -191,7 +193,7 @@ ${sourceWarningPart(path.node)}`);
                     }
                     else {
                         translations[id] = {
-                            message: message !== null && message !== void 0 ? message : id,
+                            message: id,
                             ...(description && { description }),
                         };
                     }
@@ -199,8 +201,9 @@ ${sourceWarningPart(path.node)}`);
                 }
                 // Handle single non-empty content
                 const singleChildren = childrenPath
-                    // Remove empty/useless text nodes that might be around our translation!
-                    // Makes the translation system more reliable to JSX formatting issues
+                    // Remove empty/useless text nodes that might be around our
+                    // translation! Makes the translation system more reliable to JSX
+                    // formatting issues
                     .filter((children) => !(children.isJSXText() &&
                     children.node.value.replace('\n', '').trim() === ''))
                     .pop();
@@ -231,7 +234,7 @@ ${sourceWarningPart(path.node)}`);
                 const args = path.get('arguments');
                 if (args.length === 1 || args.length === 2) {
                     const firstArgPath = args[0];
-                    // evaluation allows translate("x" + "y"); to be considered as translate("xy");
+                    // translate("x" + "y"); => translate("xy");
                     const firstArgEvaluated = firstArgPath.evaluate();
                     if (firstArgEvaluated.confident &&
                         typeof firstArgEvaluated.value === 'object') {

package/lib/server/versions/index.js

@@ -33,7 +33,8 @@ function getPluginVersion(pluginPath, siteDir) {
         const packageJsonPath = (0, path_1.join)(potentialPluginPackageJsonDirectory, 'package.json');
         if ((0, fs_extra_1.existsSync)(packageJsonPath) && (0, fs_extra_1.lstatSync)(packageJsonPath).isFile()) {
             if (potentialPluginPackageJsonDirectory === siteDir) {
-                // If the plugin belongs to the same docusaurus project, we classify it as local plugin.
+                // If the plugin belongs to the same docusaurus project, we classify it
+                // as local plugin.
                 return { type: 'project' };
             }
             return {
@@ -44,7 +45,8 @@ function getPluginVersion(pluginPath, siteDir) {
         }
         potentialPluginPackageJsonDirectory = (0, path_1.dirname)(potentialPluginPackageJsonDirectory);
     }
-    // In rare cases where a plugin is a path where no parent directory contains package.json, we can only classify it as local.
+    // In the case where a plugin is a path where no parent directory contains
+    // package.json (e.g. inline plugin), we can only classify it as local.
     return { type: 'local' };
 }
 exports.getPluginVersion = getPluginVersion;

package/lib/webpack/base.js

@@ -14,8 +14,8 @@ const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const utils_1 = require("./utils");
 const themes_1 = require("../server/themes");
 const utils_2 = require("@docusaurus/utils");
-const CSS_REGEX = /\.css$/;
-const CSS_MODULE_REGEX = /\.module\.css$/;
+const CSS_REGEX = /\.css$/i;
+const CSS_MODULE_REGEX = /\.module\.css$/i;
 exports.clientDir = path_1.default.join(__dirname, '..', 'client');
 const LibrariesToTranspile = [
     'copy-text-to-clipboard', // contains optional catch binding, incompatible with recent versions of Edge
@@ -28,7 +28,7 @@ function excludeJS(modulePath) {
     }
     // Don't transpile node_modules except any docusaurus npm package
     return (/node_modules/.test(modulePath) &&
-        !/(docusaurus)((?!node_modules).)*\.jsx?$/.test(modulePath) &&
+        !/docusaurus(?:(?!node_modules).)*\.jsx?$/.test(modulePath) &&
         !LibrariesToTranspileRegex.test(modulePath));
 }
 exports.excludeJS = excludeJS;
@@ -69,16 +69,19 @@ function createBaseConfig(props, isServer, minify = true) {
             // When version string changes, cache is evicted
             version: [
                 siteMetadata.docusaurusVersion,
-                // Webpack does not evict the cache correctly on alias/swizzle change, so we force eviction.
+                // Webpack does not evict the cache correctly on alias/swizzle change,
+                // so we force eviction.
                 // See https://github.com/webpack/webpack/issues/13627
                 (0, utils_2.md5Hash)(JSON.stringify(themeAliases)),
             ].join('-'),
-            // When one of those modules/dependencies change (including transitive deps), cache is invalidated
+            // When one of those modules/dependencies change (including transitive
+            // deps), cache is invalidated
             buildDependencies: {
                 config: [
                     __filename,
                     path_1.default.join(__dirname, isServer ? 'server.js' : 'client.js'),
-                    // Docusaurus config changes can affect MDX/JSX compilation, so we'd rather evict the cache.
+                    // Docusaurus config changes can affect MDX/JSX compilation, so we'd
+                    // rather evict the cache.
                     // See https://github.com/questdb/questdb.io/issues/493
                     siteConfigPath,
                 ],
@@ -120,10 +123,11 @@ function createBaseConfig(props, isServer, minify = true) {
                 ...getDocusaurusAliases(),
                 ...themeAliases,
             },
-            // This allows you to set a fallback for where Webpack should look for modules.
-            // We want `@docusaurus/core` own dependencies/`node_modules` to "win" if there is conflict
-            // Example: if there is core-js@3 in user's own node_modules, but core depends on
-            // core-js@2, we should use core-js@2.
+            // This allows you to set a fallback for where Webpack should look for
+            // modules. We want `@docusaurus/core` own dependencies/`node_modules` to
+            // "win" if there is conflict. Example: if there is core-js@3 in user's
+            // own node_modules, but core depends on core-js@2, we should use
+            // core-js@2.
             modules: [
                 path_1.default.resolve(__dirname, '..', '..', 'node_modules'),
                 'node_modules',
@@ -135,7 +139,8 @@ function createBaseConfig(props, isServer, minify = true) {
         },
         optimization: {
             removeAvailableModules: false,
-            // Only minimize client bundle in production because server bundle is only used for static site generation
+            // Only minimize client bundle in production because server bundle is only
+            // used for static site generation
             minimize: minimizeEnabled,
             minimizer: minimizeEnabled
                 ? (0, utils_1.getMinimizer)(useSimpleCssMinifier)
@@ -143,7 +148,9 @@ function createBaseConfig(props, isServer, minify = true) {
             splitChunks: isServer
                 ? false
                 : {
-                    // Since the chunk name includes all origin chunk names it's recommended for production builds with long term caching to NOT include [name] in the filenames
+                    // Since the chunk name includes all origin chunk names it's
+                    // recommended for production builds with long term caching to NOT
+                    // include [name] in the filenames
                     name: false,
                     cacheGroups: {
                         // disable the built-in cacheGroups
@@ -175,7 +182,7 @@ function createBaseConfig(props, isServer, minify = true) {
                 fileLoaderUtils.rules.svg(),
                 fileLoaderUtils.rules.otherAssets(),
                 {
-                    test: /\.(j|t)sx?$/,
+                    test: /\.[jt]sx?$/i,
                     exclude: excludeJS,
                     use: [
                         (0, utils_1.getCustomizableJSLoader)((_a = siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader)({
@@ -217,8 +224,9 @@ function createBaseConfig(props, isServer, minify = true) {
                 chunkFilename: isProd
                     ? 'assets/css/[name].[contenthash:8].css'
                     : '[name].css',
-                // remove css order warnings if css imports are not sorted alphabetically
-                // see https://github.com/webpack-contrib/mini-css-extract-plugin/pull/422 for more reasoning
+                // remove css order warnings if css imports are not sorted
+                // alphabetically. See https://github.com/webpack-contrib/mini-css-extract-plugin/pull/422
+                // for more reasoning
                 ignoreOrder: true,
             }),
         ],

package/lib/webpack/client.js

@@ -18,7 +18,9 @@ function createClientConfig(props, minify = true) {
     const isBuilding = process.argv[2] === 'build';
     const config = (0, base_1.createBaseConfig)(props, false, minify);
     const clientConfig = (0, webpack_merge_1.default)(config, {
-        // target: 'browserslist', //  useless, disabled on purpose (errors on existing sites with no browserslist cfg)
+        // useless, disabled on purpose (errors on existing sites with no
+        // browserslist config)
+        // target: 'browserslist',
         entry: path_1.default.resolve(__dirname, '../client/clientEntry.js'),
         optimization: {
             // Keep the runtime chunk separated to enable long term caching
@@ -33,7 +35,8 @@ function createClientConfig(props, minify = true) {
             }),
         ],
     });
-    // When building include the plugin to force terminate building if errors happened in the client bundle.
+    // When building, include the plugin to force terminate building if errors
+    // happened in the client bundle.
     if (isBuilding) {
         (_a = clientConfig.plugins) === null || _a === void 0 ? void 0 : _a.push({
             apply: (compiler) => {

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

@@ -5,6 +5,17 @@
  * 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"
+ */
 declare class ChunkAssetPlugin {
     apply(compiler: Compiler): void;
 }

package/lib/webpack/plugins/ChunkAssetPlugin.js

@@ -8,16 +8,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const webpack_1 = require("webpack");
 const pluginName = 'chunk-asset-plugin';
+/**
+ * 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"
+ */
 class ChunkAssetPlugin {
     apply(compiler) {
         compiler.hooks.thisCompilation.tap(pluginName, ({ mainTemplate }) => {
-            /* 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"
-            */
             mainTemplate.hooks.requireExtensions.tap(pluginName, (source, chunk) => {
                 const chunkIdToName = chunk.getChunkMaps(false).name;
                 const chunkNameToId = Object.create(null);
@@ -30,10 +34,13 @@ class ChunkAssetPlugin {
                 buf.push(
                 // If chunkName is passed, we convert it to chunk asset url
                 // .p => public path url ("/" or "/baseUrl/")
-                // .u(chunkId) => chunk asset url ("assets/js/x63b64xd.contentHash.js")
-                // not sure where this is documented, but this link was helpful: https://programmer.help/blogs/5d68849083e1a.html
+                // .u(chunkId) =>
+                //   chunk asset url ("assets/js/x63b64xd.contentHash.js")
+                // not sure where this is documented, but this link was helpful:
+                // https://programmer.help/blogs/5d68849083e1a.html
                 //
-                // Note: __webpack_require__.gca() is called in docusaurus.ts for prefetching
+                // Note: __webpack_require__.gca() is called in docusaurus.ts for
+                // prefetching
                 // Note: we previously used jsonpScriptSrc (Webpack 4)
                 `__webpack_require__.gca = function(chunkId) { chunkId = ${JSON.stringify(chunkNameToId)}[chunkId]||chunkId; return __webpack_require__.p + __webpack_require__.u(chunkId); };`);
                 return webpack_1.Template.asString(buf);

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

@@ -13,8 +13,8 @@
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -69,7 +69,8 @@ declare class CleanWebpackPlugin {
      *
      * Only happens once.
      *
-     * Warning: It is recommended to initially clean your build directory outside of webpack to minimize unexpected behavior.
+     * Warning: It is recommended to initially clean your build directory outside
+     * of webpack to minimize unexpected behavior.
      */
     handleInitial(): void;
     handleDone(stats: Stats): void;

package/lib/webpack/plugins/CleanWebpackPlugin.js

@@ -60,7 +60,8 @@ class CleanWebpackPlugin {
      *
      * Only happens once.
      *
-     * Warning: It is recommended to initially clean your build directory outside of webpack to minimize unexpected behavior.
+     * Warning: It is recommended to initially clean your build directory outside
+     * of webpack to minimize unexpected behavior.
      */
     handleInitial() {
         if (this.initialClean) {

package/lib/webpack/server.js

@@ -57,9 +57,10 @@ function createServerConfig({ props, onLinksCollected = () => { }, }) {
                 },
                 paths: ssgPaths,
                 preferFoldersOutput: trailingSlash,
-                // When using "new URL('file.js', import.meta.url)", Webpack will emit __filename, and this plugin will throw
-                // not sure the __filename value has any importance for this plugin, just using an empty string to avoid the error
-                // See https://github.com/facebook/docusaurus/issues/4922
+                // When using "new URL('file.js', import.meta.url)", Webpack will emit
+                // __filename, and this plugin will throw. not sure the __filename value
+                // has any importance for this plugin, just using an empty string to
+                // avoid the error. See https://github.com/facebook/docusaurus/issues/4922
                 globals: { __filename: '' },
             }),
             // Show compilation progress bar.