@docusaurus/core 2.0.0-beta.ff31de0ff → 2.0.1

package/lib/server/utils.js

@@ -1,23 +1,21 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeGlobby = exports.getAllFinalRoutes = void 0;
-const tslib_1 = require("tslib");
 /**
  * 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.
  */
-const lodash_1 = require("lodash");
-const globby_1 = tslib_1.__importDefault(require("globby"));
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safeGlobby = exports.getAllFinalRoutes = void 0;
+const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
 // Recursively get the final routes (routes with no subroutes)
 function getAllFinalRoutes(routeConfig) {
     function getFinalRoutes(route) {
-        return route.routes ? lodash_1.flatMap(route.routes, getFinalRoutes) : [route];
+        return route.routes ? route.routes.flatMap(getFinalRoutes) : [route];
     }
-    return lodash_1.flatMap(routeConfig, getFinalRoutes);
+    return routeConfig.flatMap(getFinalRoutes);
 }
 exports.getAllFinalRoutes = getAllFinalRoutes;
 // Globby that fix Windows path patterns
@@ -25,7 +23,7 @@ exports.getAllFinalRoutes = getAllFinalRoutes;
 async function safeGlobby(patterns, options) {
     // Required for Windows support, as paths using \ should not be used by globby
     // (also using the windows hard drive prefix like c: is not a good idea)
-    const globPaths = patterns.map((dirPath) => utils_1.posixPath(path_1.default.relative(process.cwd(), dirPath)));
-    return globby_1.default(globPaths, options);
+    const globPaths = patterns.map((dirPath) => (0, utils_1.posixPath)(path_1.default.relative(process.cwd(), dirPath)));
+    return (0, utils_1.Globby)(globPaths, options);
 }
 exports.safeGlobby = safeGlobby;

package/lib/webpack/aliases/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { LoadedPlugin } from '@docusaurus/types';
+/**
+ * Aliases used for Webpack resolution (useful for implementing swizzling)
+ */
+declare type ThemeAliases = {
+    [alias: string]: string;
+};
+/**
+ * Order of Webpack aliases is important because one alias can shadow another.
+ * This ensures `@theme/NavbarItem` alias is after
+ * `@theme/NavbarItem/LocaleDropdown`.
+ *
+ * @see https://github.com/facebook/docusaurus/pull/3922
+ * @see https://github.com/facebook/docusaurus/issues/5382
+ */
+export declare function sortAliases(aliases: ThemeAliases): ThemeAliases;
+export declare function createAliasesForTheme(themePath: string, addOriginalAlias: boolean): Promise<ThemeAliases>;
+export declare function loadThemeAliases({ siteDir, plugins, }: {
+    siteDir: string;
+    plugins: LoadedPlugin[];
+}): Promise<ThemeAliases>;
+/**
+ * Note: a `@docusaurus` alias would also catch `@docusaurus/theme-common`, so
+ * instead of naively aliasing this to `client/exports`, we use fine-grained
+ * aliases instead.
+ */
+export declare function loadDocusaurusAliases(): Promise<ThemeAliases>;
+export {};

package/lib/webpack/aliases/index.js

@@ -0,0 +1,106 @@
+"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.loadDocusaurusAliases = exports.loadThemeAliases = exports.createAliasesForTheme = exports.sortAliases = void 0;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+const ThemeFallbackDir = path_1.default.join(__dirname, '../../client/theme-fallback');
+/**
+ * Order of Webpack aliases is important because one alias can shadow another.
+ * This ensures `@theme/NavbarItem` alias is after
+ * `@theme/NavbarItem/LocaleDropdown`.
+ *
+ * @see https://github.com/facebook/docusaurus/pull/3922
+ * @see https://github.com/facebook/docusaurus/issues/5382
+ */
+function sortAliases(aliases) {
+    // Alphabetical order by default
+    const entries = lodash_1.default.sortBy(Object.entries(aliases), ([alias]) => alias);
+    // @theme/NavbarItem should be after @theme/NavbarItem/LocaleDropdown
+    entries.sort(([alias1], [alias2]) => 
+    // eslint-disable-next-line no-nested-ternary
+    alias1.includes(`${alias2}/`) ? -1 : alias2.includes(`${alias1}/`) ? 1 : 0);
+    return Object.fromEntries(entries);
+}
+exports.sortAliases = sortAliases;
+async function createAliasesForTheme(themePath, addOriginalAlias) {
+    if (!(await fs_extra_1.default.pathExists(themePath))) {
+        return {};
+    }
+    const themeComponentFiles = await (0, utils_1.Globby)(['**/*.{js,jsx,ts,tsx}'], {
+        cwd: themePath,
+    });
+    const aliases = {};
+    themeComponentFiles.forEach((relativeSource) => {
+        const filePath = path_1.default.join(themePath, relativeSource);
+        const fileName = (0, utils_1.fileToPath)(relativeSource);
+        const aliasName = (0, utils_1.posixPath)((0, utils_1.normalizeUrl)(['@theme', fileName]).replace(/\/$/, ''));
+        aliases[aliasName] = filePath;
+        if (addOriginalAlias) {
+            // For swizzled components to access the original.
+            const originalAliasName = (0, utils_1.posixPath)((0, utils_1.normalizeUrl)(['@theme-original', fileName]).replace(/\/$/, ''));
+            aliases[originalAliasName] = filePath;
+        }
+    });
+    return sortAliases(aliases);
+}
+exports.createAliasesForTheme = createAliasesForTheme;
+async function createThemeAliases(themePaths, userThemePaths) {
+    const aliases = {};
+    for (const themePath of themePaths) {
+        const themeAliases = await createAliasesForTheme(themePath, true);
+        Object.entries(themeAliases).forEach(([aliasKey, alias]) => {
+            // 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}`;
+                if (!(initAlias in aliases)) {
+                    aliases[initAlias] = aliases[aliasKey];
+                }
+            }
+            aliases[aliasKey] = alias;
+        });
+    }
+    for (const themePath of userThemePaths) {
+        const userThemeAliases = await createAliasesForTheme(themePath, false);
+        Object.assign(aliases, userThemeAliases);
+    }
+    return sortAliases(aliases);
+}
+function loadThemeAliases({ siteDir, plugins, }) {
+    const pluginThemes = plugins
+        .map((plugin) => plugin.getThemePath && path_1.default.resolve(plugin.path, plugin.getThemePath()))
+        .filter((x) => Boolean(x));
+    const userTheme = path_1.default.resolve(siteDir, utils_1.THEME_PATH);
+    return createThemeAliases([ThemeFallbackDir, ...pluginThemes], [userTheme]);
+}
+exports.loadThemeAliases = loadThemeAliases;
+/**
+ * Note: a `@docusaurus` alias would also catch `@docusaurus/theme-common`, so
+ * instead of naively aliasing this to `client/exports`, we use fine-grained
+ * aliases instead.
+ */
+async function loadDocusaurusAliases() {
+    const dirPath = path_1.default.resolve(__dirname, '../../client/exports');
+    const extensions = ['.js', '.ts', '.tsx'];
+    const aliases = {};
+    (await fs_extra_1.default.readdir(dirPath))
+        .filter((fileName) => extensions.includes(path_1.default.extname(fileName)))
+        .forEach((fileName) => {
+        const fileNameWithoutExtension = path_1.default.basename(fileName, path_1.default.extname(fileName));
+        const aliasName = `@docusaurus/${fileNameWithoutExtension}`;
+        aliases[aliasName] = path_1.default.resolve(dirPath, fileName);
+    });
+    return aliases;
+}
+exports.loadDocusaurusAliases = loadDocusaurusAliases;

package/lib/webpack/base.d.ts

@@ -4,9 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Configuration } from 'webpack';
-import { Props } from '@docusaurus/types';
+import type { Configuration } from 'webpack';
+import type { Props } from '@docusaurus/types';
 export declare const clientDir: string;
 export declare function excludeJS(modulePath: string): boolean;
-export declare function getDocusaurusAliases(): Record<string, string>;
-export declare function createBaseConfig(props: Props, isServer: boolean, minify?: boolean): Configuration;
+export declare function createBaseConfig(props: Props, isServer: boolean, minify?: boolean): Promise<Configuration>;

package/lib/webpack/base.js

@@ -6,74 +6,69 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBaseConfig = exports.getDocusaurusAliases = exports.excludeJS = exports.clientDir = void 0;
+exports.createBaseConfig = exports.excludeJS = exports.clientDir = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const mini_css_extract_plugin_1 = tslib_1.__importDefault(require("mini-css-extract-plugin"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const utils_1 = require("./utils");
-const constants_1 = require("../constants");
-const sharedModuleAliases_1 = tslib_1.__importDefault(require("./sharedModuleAliases"));
-const CSS_REGEX = /\.css$/;
-const CSS_MODULE_REGEX = /\.module\.css$/;
+const mini_css_extract_plugin_1 = tslib_1.__importDefault(require("mini-css-extract-plugin"));
+const utils_1 = require("@docusaurus/utils");
+const utils_2 = require("./utils");
+const aliases_1 = require("./aliases");
+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
+    '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('|'));
 function excludeJS(modulePath) {
-    // always transpile client dir
+    // Always transpile client dir
     if (modulePath.startsWith(exports.clientDir)) {
         return false;
     }
     // Don't transpile node_modules except any docusaurus npm package
-    return (/node_modules/.test(modulePath) &&
-        !/(docusaurus)((?!node_modules).)*\.jsx?$/.test(modulePath) &&
+    return (modulePath.includes('node_modules') &&
+        !/docusaurus(?:(?!node_modules).)*\.jsx?$/.test(modulePath) &&
         !LibrariesToTranspileRegex.test(modulePath));
 }
 exports.excludeJS = excludeJS;
-function getDocusaurusAliases() {
-    const dirPath = path_1.default.resolve(__dirname, '../client/exports');
-    const extensions = ['.js', '.ts', '.tsx'];
-    const aliases = {};
-    fs_extra_1.default.readdirSync(dirPath)
-        .filter((fileName) => extensions.includes(path_1.default.extname(fileName)))
-        .forEach((fileName) => {
-        const fileNameWithoutExtension = path_1.default.basename(fileName, path_1.default.extname(fileName));
-        const aliasName = `@docusaurus/${fileNameWithoutExtension}`;
-        aliases[aliasName] = path_1.default.resolve(dirPath, fileName);
-    });
-    return aliases;
-}
-exports.getDocusaurusAliases = getDocusaurusAliases;
-function createBaseConfig(props, isServer, minify = true) {
-    var _a;
-    const { outDir, siteDir, siteConfig, baseUrl, generatedFilesDir, routesPaths, siteMetadata, } = props;
+async function createBaseConfig(props, isServer, minify = true) {
+    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 && !isServer;
     const useSimpleCssMinifier = process.env.USE_SIMPLE_CSS_MINIFIER === 'true';
-    const fileLoaderUtils = utils_1.getFileLoaderUtils();
+    const fileLoaderUtils = (0, utils_1.getFileLoaderUtils)();
     const name = isServer ? 'server' : 'client';
     const mode = isProd ? 'production' : 'development';
+    const themeAliases = await (0, aliases_1.loadThemeAliases)({ siteDir, plugins });
     return {
         mode,
         name,
         cache: {
-            // TODO temporary env variable to reduce risk of Webpack 5 release
-            // maybe expose an official api, once this is solved? https://github.com/webpack/webpack/issues/13034
-            type: process.env.DOCUSAURUS_WEBPACK_CACHE_TYPE ||
-                'filesystem',
+            type: 'filesystem',
             // Can we share the same cache across locales?
             // Exploring that question at https://github.com/webpack/webpack/issues/13034
             // name: `${name}-${mode}`,
             name: `${name}-${mode}-${props.i18n.currentLocale}`,
-            version: siteMetadata.docusaurusVersion,
+            // 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.
+                // See https://github.com/webpack/webpack/issues/13627
+                (0, utils_1.md5Hash)(JSON.stringify(themeAliases)),
+            ].join('-'),
+            // When one of those modules/dependencies change (including transitive
+            // deps), cache is invalidated
             buildDependencies: {
-                // When one of dependencies change, cache is invalidated
                 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.
+                    // See https://github.com/questdb/questdb.io/issues/493
+                    siteConfigPath,
                 ],
             },
         },
@@ -85,6 +80,7 @@ function createBaseConfig(props, isServer, minify = true) {
                 ? 'assets/js/[name].[contenthash:8].js'
                 : '[name].js',
             publicPath: baseUrl,
+            hashFunction: 'xxhash64',
         },
         // Don't throw warning when asset created is over 250kb
         performance: {
@@ -99,27 +95,25 @@ function createBaseConfig(props, isServer, minify = true) {
                 // Allow resolution of url("/fonts/xyz.ttf") by webpack
                 // See https://webpack.js.org/configuration/resolve/#resolveroots
                 // See https://github.com/webpack-contrib/css-loader/issues/1256
-                path_1.default.join(siteDir, constants_1.STATIC_DIR_NAME),
+                ...siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
                 siteDir,
                 process.cwd(),
             ],
             alias: {
-                ...sharedModuleAliases_1.default,
                 '@site': siteDir,
                 '@generated': generatedFilesDir,
-                // Note: a @docusaurus alias would also catch @docusaurus/theme-common,
-                // so we use fine-grained aliases instead
-                // '@docusaurus': path.resolve(__dirname, '../client/exports'),
-                ...getDocusaurusAliases(),
+                ...(await (0, aliases_1.loadDocusaurusAliases)()),
+                ...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',
-                path_1.default.resolve(fs_extra_1.default.realpathSync(process.cwd()), 'node_modules'),
+                path_1.default.resolve(await fs_extra_1.default.realpath(process.cwd()), 'node_modules'),
             ],
         },
         resolveLoader: {
@@ -127,18 +121,21 @@ 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
-                ? utils_1.getMinimizer(useSimpleCssMinifier)
+                ? (0, utils_2.getMinimizer)(useSimpleCssMinifier)
                 : undefined,
             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
+                        // Disable the built-in cacheGroups
                         default: false,
                         common: {
                             name: 'common',
@@ -167,19 +164,19 @@ function createBaseConfig(props, isServer, minify = true) {
                 fileLoaderUtils.rules.svg(),
                 fileLoaderUtils.rules.otherAssets(),
                 {
-                    test: /\.(j|t)sx?$/,
+                    test: /\.[jt]sx?$/i,
                     exclude: excludeJS,
                     use: [
-                        utils_1.getCustomizableJSLoader((_a = siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader)({
+                        (0, utils_2.getCustomizableJSLoader)(siteConfig.webpack?.jsLoader)({
                             isServer,
-                            babelOptions: utils_1.getCustomBabelConfigFilePath(siteDir),
+                            babelOptions: await (0, utils_2.getCustomBabelConfigFilePath)(siteDir),
                         }),
                     ],
                 },
                 {
                     test: CSS_REGEX,
                     exclude: CSS_MODULE_REGEX,
-                    use: utils_1.getStyleLoaders(isServer, {
+                    use: (0, utils_2.getStyleLoaders)(isServer, {
                         importLoaders: 1,
                         sourceMap: !isProd,
                     }),
@@ -188,11 +185,11 @@ function createBaseConfig(props, isServer, minify = true) {
                 // using the extension .module.css
                 {
                     test: CSS_MODULE_REGEX,
-                    use: utils_1.getStyleLoaders(isServer, {
+                    use: (0, utils_2.getStyleLoaders)(isServer, {
                         modules: {
                             localIdentName: isProd
                                 ? `[local]_[contenthash:base64:4]`
-                                : `[local]_[path]`,
+                                : `[local]_[path][name]`,
                             exportOnlyLocals: isServer,
                         },
                         importLoaders: 1,
@@ -209,8 +206,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.d.ts

@@ -4,6 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Configuration } from 'webpack';
-import { Props } from '@docusaurus/types';
-export default function createClientConfig(props: Props, minify?: boolean): Configuration;
+import type { Props } from '@docusaurus/types';
+import type { Configuration } from 'webpack';
+export default function createClientConfig(props: Props, minify?: boolean): Promise<Configuration>;

package/lib/webpack/client.js

@@ -7,28 +7,20 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const path_1 = tslib_1.__importDefault(require("path"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
 const base_1 = require("./base");
 const ChunkAssetPlugin_1 = tslib_1.__importDefault(require("./plugins/ChunkAssetPlugin"));
 const LogPlugin_1 = tslib_1.__importDefault(require("./plugins/LogPlugin"));
-function createClientConfig(props, minify = true) {
-    var _a;
-    const isProd = process.env.NODE_ENV === 'production';
+async function createClientConfig(props, minify = true) {
     const isBuilding = process.argv[2] === 'build';
-    const config = base_1.createBaseConfig(props, false, minify);
-    const clientConfig = webpack_merge_1.default(config, {
-        // target: 'browserslist', //  useless, disabled on purpose (errors on existing sites with no browserslist cfg)
-        entry: [
-            // Instead of the default WebpackDevServer client, we use a custom one
-            // like CRA to bring better experience.
-            // note: the one in ./dev is modified to work with Docusaurus
-            // !isProd && require.resolve('react-dev-utils/hotDevServer.js'),
-            !isProd &&
-                require.resolve('./react-dev-utils-webpack5/webpackHotDevClient.js'),
-            path_1.default.resolve(__dirname, '../client/clientEntry.js'),
-        ].filter(Boolean),
+    const config = await (0, base_1.createBaseConfig)(props, false, minify);
+    const clientConfig = (0, webpack_merge_1.default)(config, {
+        // 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
             // https://twitter.com/wSokra/status/969679223278505985
@@ -42,13 +34,14 @@ 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({
+        clientConfig.plugins?.push({
             apply: (compiler) => {
                 compiler.hooks.done.tap('client:done', (stats) => {
                     if (stats.hasErrors()) {
-                        console.log(chalk_1.default.red('Client bundle compiled with errors therefore further build is impossible.'));
+                        logger_1.default.error('Client bundle compiled with errors therefore further build is impossible.');
                         process.exit(1);
                     }
                 });

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

@@ -4,8 +4,18 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Compiler } from 'webpack';
-declare class ChunkAssetPlugin {
+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;
 }
-export default ChunkAssetPlugin;

package/lib/webpack/plugins/ChunkAssetPlugin.js

@@ -6,37 +6,44 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const webpack_1 = require("webpack");
+const tslib_1 = require("tslib");
+const webpack_1 = tslib_1.__importDefault(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);
-                Object.keys(chunkIdToName).forEach((chunkId) => {
-                    const chunkName = chunkIdToName[chunkId];
-                    chunkNameToId[chunkName] = chunkId;
-                });
+                const chunkNameToId = Object.fromEntries(Object.entries(chunkIdToName).map(([chunkId, chunkName]) => [
+                    chunkName,
+                    chunkId,
+                ]));
                 const buf = [source];
                 buf.push('// function to get chunk asset');
                 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);
+                return webpack_1.default.Template.asString(buf);
             });
         });
     }

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

@@ -4,27 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/**
- * The MIT License (MIT)
- * Copyright (c) 2015 John Agan
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * 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 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
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-import { Compiler, Stats } from 'webpack';
-export interface Options {
+import type { Compiler, Stats } from 'webpack';
+export declare type Options = {
     /**
      * Write Logs to Console
      * (Always enabled when dry is true)
@@ -53,8 +34,8 @@ export interface Options {
      * default: ['**\/*']
      */
     cleanOnceBeforeBuildPatterns?: string[];
-}
-declare class CleanWebpackPlugin {
+};
+export default class CleanWebpackPlugin {
     private readonly verbose;
     private readonly cleanStaleWebpackAssets;
     private readonly protectWebpackAssets;
@@ -69,10 +50,10 @@ 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;
     removeFiles(patterns: string[]): void;
 }
-export default CleanWebpackPlugin;