@docusaurus/core 2.0.0-beta.12faed89d → 2.0.0-beta.14

package/lib/server/versions/__tests/index.test.js

@@ -10,16 +10,16 @@ const __1 = require("..");
 const path_1 = require("path");
 describe('getPluginVersion', () => {
     it('Can detect external packages plugins versions of correctly.', () => {
-        expect(__1.getPluginVersion(path_1.join(__dirname, '..', '__fixtures__', 'dummy-plugin.js'), 
+        expect((0, __1.getPluginVersion)((0, path_1.join)(__dirname, '..', '__fixtures__', 'dummy-plugin.js'), 
         // Make the plugin appear external.
-        path_1.join(__dirname, '..', '..', '..', '..', '..', '..', 'website'))).toEqual({ type: 'package', version: 'random-version' });
+        (0, path_1.join)(__dirname, '..', '..', '..', '..', '..', '..', 'website'))).toEqual({ type: 'package', version: 'random-version' });
     });
     it('Can detect project plugins versions correctly.', () => {
-        expect(__1.getPluginVersion(path_1.join(__dirname, '..', '__fixtures__', 'dummy-plugin.js'), 
+        expect((0, __1.getPluginVersion)((0, path_1.join)(__dirname, '..', '__fixtures__', 'dummy-plugin.js'), 
         // Make the plugin appear project local.
-        path_1.join(__dirname, '..', '__fixtures__'))).toEqual({ type: 'project' });
+        (0, path_1.join)(__dirname, '..', '__fixtures__'))).toEqual({ type: 'project' });
     });
     it('Can detect local packages versions correctly.', () => {
-        expect(__1.getPluginVersion('/', '/')).toEqual({ type: 'local' });
+        expect((0, __1.getPluginVersion)('/', '/')).toEqual({ type: 'local' });
     });
 });

package/lib/server/versions/index.js

@@ -10,7 +10,7 @@ exports.getPluginVersion = exports.getPackageJsonName = exports.getPackageJsonVe
 const fs_extra_1 = require("fs-extra");
 const path_1 = require("path");
 function getPackageJsonVersion(packageJsonPath) {
-    if (fs_extra_1.existsSync(packageJsonPath)) {
+    if ((0, fs_extra_1.existsSync)(packageJsonPath)) {
         // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
         const { version } = require(packageJsonPath);
         return typeof version === 'string' ? version : undefined;
@@ -19,7 +19,7 @@ function getPackageJsonVersion(packageJsonPath) {
 }
 exports.getPackageJsonVersion = getPackageJsonVersion;
 function getPackageJsonName(packageJsonPath) {
-    if (fs_extra_1.existsSync(packageJsonPath)) {
+    if ((0, fs_extra_1.existsSync)(packageJsonPath)) {
         // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
         const { name } = require(packageJsonPath);
         return typeof name === 'string' ? name : undefined;
@@ -28,10 +28,10 @@ function getPackageJsonName(packageJsonPath) {
 }
 exports.getPackageJsonName = getPackageJsonName;
 function getPluginVersion(pluginPath, siteDir) {
-    let potentialPluginPackageJsonDirectory = path_1.dirname(pluginPath);
+    let potentialPluginPackageJsonDirectory = (0, path_1.dirname)(pluginPath);
     while (potentialPluginPackageJsonDirectory !== '/') {
-        const packageJsonPath = path_1.join(potentialPluginPackageJsonDirectory, 'package.json');
-        if (fs_extra_1.existsSync(packageJsonPath) && fs_extra_1.lstatSync(packageJsonPath).isFile()) {
+        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.
                 return { type: 'project' };
@@ -42,7 +42,7 @@ function getPluginVersion(pluginPath, siteDir) {
                 version: getPackageJsonVersion(packageJsonPath),
             };
         }
-        potentialPluginPackageJsonDirectory = path_1.dirname(potentialPluginPackageJsonDirectory);
+        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.
     return { type: 'local' };

package/lib/webpack/base.js

@@ -8,12 +8,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBaseConfig = exports.getDocusaurusAliases = 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 fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const mini_css_extract_plugin_1 = (0, tslib_1.__importDefault)(require("mini-css-extract-plugin"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const utils_1 = require("./utils");
-const constants_1 = require("../constants");
-const sharedModuleAliases_1 = tslib_1.__importDefault(require("./sharedModuleAliases"));
 const themes_1 = require("../server/themes");
 const utils_2 = require("@docusaurus/utils");
 const CSS_REGEX = /\.css$/;
@@ -55,10 +53,10 @@ function createBaseConfig(props, isServer, minify = true) {
     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_2.getFileLoaderUtils)();
     const name = isServer ? 'server' : 'client';
     const mode = isProd ? 'production' : 'development';
-    const themeAliases = themes_1.loadPluginsThemeAliases({ siteDir, plugins });
+    const themeAliases = (0, themes_1.loadPluginsThemeAliases)({ siteDir, plugins });
     return {
         mode,
         name,
@@ -73,7 +71,7 @@ function createBaseConfig(props, isServer, minify = true) {
                 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
-                utils_2.md5Hash(JSON.stringify(themeAliases)),
+                (0, utils_2.md5Hash)(JSON.stringify(themeAliases)),
             ].join('-'),
             // When one of those modules/dependencies change (including transitive deps), cache is invalidated
             buildDependencies: {
@@ -94,6 +92,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: {
@@ -103,17 +102,16 @@ function createBaseConfig(props, isServer, minify = true) {
         resolve: {
             unsafeCache: false,
             extensions: ['.wasm', '.mjs', '.js', '.jsx', '.ts', '.tsx', '.json'],
-            symlinks: false,
+            symlinks: true,
             roots: [
                 // 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,
@@ -140,7 +138,7 @@ function createBaseConfig(props, isServer, minify = true) {
             // 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_1.getMinimizer)(useSimpleCssMinifier)
                 : undefined,
             splitChunks: isServer
                 ? false
@@ -180,16 +178,16 @@ function createBaseConfig(props, isServer, minify = true) {
                     test: /\.(j|t)sx?$/,
                     exclude: excludeJS,
                     use: [
-                        utils_1.getCustomizableJSLoader((_a = siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader)({
+                        (0, utils_1.getCustomizableJSLoader)((_a = siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader)({
                             isServer,
-                            babelOptions: utils_1.getCustomBabelConfigFilePath(siteDir),
+                            babelOptions: (0, utils_1.getCustomBabelConfigFilePath)(siteDir),
                         }),
                     ],
                 },
                 {
                     test: CSS_REGEX,
                     exclude: CSS_MODULE_REGEX,
-                    use: utils_1.getStyleLoaders(isServer, {
+                    use: (0, utils_1.getStyleLoaders)(isServer, {
                         importLoaders: 1,
                         sourceMap: !isProd,
                     }),
@@ -198,7 +196,7 @@ function createBaseConfig(props, isServer, minify = true) {
                 // using the extension .module.css
                 {
                     test: CSS_MODULE_REGEX,
-                    use: utils_1.getStyleLoaders(isServer, {
+                    use: (0, utils_1.getStyleLoaders)(isServer, {
                         modules: {
                             localIdentName: isProd
                                 ? `[local]_[contenthash:base64:4]`

package/lib/webpack/client.js

@@ -7,28 +7,19 @@
  */
 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 webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const webpack_merge_1 = (0, 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"));
+const ChunkAssetPlugin_1 = (0, tslib_1.__importDefault)(require("./plugins/ChunkAssetPlugin"));
+const LogPlugin_1 = (0, tslib_1.__importDefault)(require("./plugins/LogPlugin"));
 function createClientConfig(props, minify = true) {
     var _a;
-    const isProd = process.env.NODE_ENV === 'production';
     const isBuilding = process.argv[2] === 'build';
-    const config = base_1.createBaseConfig(props, false, minify);
-    const clientConfig = webpack_merge_1.default(config, {
+    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)
-        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),
+        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
@@ -48,7 +39,7 @@ function createClientConfig(props, minify = true) {
             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/CleanWebpackPlugin.js

@@ -7,7 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const del_1 = require("del");
 class CleanWebpackPlugin {
     constructor(options = {}) {
@@ -41,7 +41,6 @@ class CleanWebpackPlugin {
     }
     apply(compiler) {
         if (!compiler.options.output || !compiler.options.output.path) {
-            // eslint-disable-next-line no-console
             console.warn('clean-webpack-plugin: options.output.path not defined. Plugin disabled...');
             return;
         }
@@ -76,7 +75,6 @@ class CleanWebpackPlugin {
          */
         if (stats.hasErrors()) {
             if (this.verbose) {
-                // eslint-disable-next-line no-console
                 console.warn('clean-webpack-plugin: pausing due to webpack errors');
             }
             return;
@@ -88,17 +86,13 @@ class CleanWebpackPlugin {
             all: false,
             assets: true,
         }).assets || [];
-        const assets = statsAssets.map((asset) => {
-            return asset.name;
-        });
+        const assets = statsAssets.map((asset) => asset.name);
         /**
          * Get all files that were in the previous build but not the current
          *
          * (relies on del's cwd: outputPath option)
          */
-        const staleFiles = this.currentAssets.filter((previousAsset) => {
-            return assets.includes(previousAsset) === false;
-        });
+        const staleFiles = this.currentAssets.filter((previousAsset) => assets.includes(previousAsset) === false);
         /**
          * Save assets for next compilation
          */
@@ -116,7 +110,7 @@ class CleanWebpackPlugin {
     }
     removeFiles(patterns) {
         try {
-            const deleted = del_1.sync(patterns, {
+            const deleted = (0, del_1.sync)(patterns, {
                 force: false,
                 // Change context to build directory
                 cwd: this.outputPath,
@@ -135,7 +129,6 @@ class CleanWebpackPlugin {
                      * https://github.com/webpack/webpack/issues/1904
                      * https://github.com/johnagan/clean-webpack-plugin/issues/11
                      */
-                    // eslint-disable-next-line no-console
                     console.warn(`clean-webpack-plugin: removed ${filename}`);
                 });
             }

package/lib/webpack/plugins/LogPlugin.js

@@ -1,15 +1,14 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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 webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
-// import formatWebpackMessages from 'react-dev-utils/formatWebpackMessages';
-const formatWebpackMessages_1 = tslib_1.__importDefault(require("../react-dev-utils-webpack5/formatWebpackMessages"));
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const webpackbar_1 = (0, tslib_1.__importDefault)(require("webpackbar"));
+const formatWebpackMessages_1 = (0, tslib_1.__importDefault)(require("react-dev-utils/formatWebpackMessages"));
 function showError(arr) {
     console.log(`\n\n${arr.join('\n')}`);
 }
@@ -23,7 +22,7 @@ class LogPlugin extends webpackbar_1.default {
                 // TODO do we really want to keep this legacy logic?
                 // let's wait and see how the react-dev-utils support Webpack5
                 // we probably want to print the error stacktraces here
-                const messages = formatWebpackMessages_1.default(errorsWarnings);
+                const messages = (0, formatWebpackMessages_1.default)(errorsWarnings);
                 if (messages.errors.length) {
                     showError(messages.errors);
                 }

package/lib/webpack/plugins/WaitPlugin.js

@@ -7,9 +7,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const wait_on_1 = tslib_1.__importDefault(require("wait-on"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const wait_on_1 = (0, tslib_1.__importDefault)(require("wait-on"));
 class WaitPlugin {
     constructor(options) {
         this.filepath = options.filepath;
@@ -20,7 +20,7 @@ class WaitPlugin {
             // To prevent 'waitFile' error on waiting non-existing directory
             fs_extra_1.default.ensureDir(path_1.default.dirname(this.filepath), {}, () => {
                 // Wait until file exist
-                wait_on_1.default({
+                (0, wait_on_1.default)({
                     resources: [this.filepath],
                     interval: 300,
                 })

package/lib/webpack/server.js

@@ -7,17 +7,17 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const webpack_merge_1 = (0, tslib_1.__importDefault)(require("webpack-merge"));
 const base_1 = require("./base");
-const WaitPlugin_1 = tslib_1.__importDefault(require("./plugins/WaitPlugin"));
-const LogPlugin_1 = tslib_1.__importDefault(require("./plugins/LogPlugin"));
-const constants_1 = require("../constants");
+const WaitPlugin_1 = (0, tslib_1.__importDefault)(require("./plugins/WaitPlugin"));
+const LogPlugin_1 = (0, tslib_1.__importDefault)(require("./plugins/LogPlugin"));
+const utils_1 = require("@docusaurus/utils");
 // Forked for Docusaurus: https://github.com/slorber/static-site-generator-webpack-plugin
-const static_site_generator_webpack_plugin_1 = tslib_1.__importDefault(require("@slorber/static-site-generator-webpack-plugin"));
+const static_site_generator_webpack_plugin_1 = (0, tslib_1.__importDefault)(require("@slorber/static-site-generator-webpack-plugin"));
 function createServerConfig({ props, onLinksCollected = () => { }, }) {
     const { baseUrl, routesPaths, generatedFilesDir, headTags, preBodyTags, postBodyTags, ssrTemplate, siteConfig: { noIndex, trailingSlash }, } = props;
-    const config = base_1.createBaseConfig(props, true);
+    const config = (0, base_1.createBaseConfig)(props, true);
     const routesLocation = {};
     // Array of paths to be rendered. Relative to output directory
     const ssgPaths = routesPaths.map((str) => {
@@ -25,8 +25,8 @@ function createServerConfig({ props, onLinksCollected = () => { }, }) {
         routesLocation[ssgPath] = str;
         return ssgPath;
     });
-    const serverConfig = webpack_merge_1.default(config, {
-        target: `node${constants_1.NODE_MAJOR_VERSION}.${constants_1.NODE_MINOR_VERSION}`,
+    const serverConfig = (0, webpack_merge_1.default)(config, {
+        target: `node${utils_1.NODE_MAJOR_VERSION}.${utils_1.NODE_MINOR_VERSION}`,
         entry: {
             main: path_1.default.resolve(__dirname, '../client/serverEntry.js'),
         },

package/lib/webpack/utils.d.ts

@@ -32,30 +32,8 @@ export declare const getCustomizableJSLoader: (jsLoader?: "babel" | ((isServer:
 export declare function applyConfigureWebpack(configureWebpack: ConfigureWebpackFn, config: Configuration, isServer: boolean, jsLoader: 'babel' | ((isServer: boolean) => RuleSetRule) | undefined, content: unknown): Configuration;
 export declare function applyConfigurePostCss(configurePostCss: NonNullable<ConfigurePostCssFn>, config: Configuration): Configuration;
 export declare function compile(config: Configuration[]): Promise<void>;
-declare type AssetFolder = 'images' | 'files' | 'fonts' | 'medias';
-declare type FileLoaderUtils = {
-    loaders: {
-        file: (options: {
-            folder: AssetFolder;
-        }) => RuleSetRule;
-        url: (options: {
-            folder: AssetFolder;
-        }) => RuleSetRule;
-        inlineMarkdownImageFileLoader: string;
-        inlineMarkdownLinkFileLoader: string;
-    };
-    rules: {
-        images: () => RuleSetRule;
-        fonts: () => RuleSetRule;
-        media: () => RuleSetRule;
-        svg: () => RuleSetRule;
-        otherAssets: () => RuleSetRule;
-    };
-};
-export declare function getFileLoaderUtils(): FileLoaderUtils;
 export declare function getHttpsConfig(): boolean | {
     cert: Buffer;
     key: Buffer;
 };
 export declare function getMinimizer(useSimpleCssMinifier?: boolean): WebpackPluginInstance[];
-export {};