@docusaurus/core 3.7.0-canary-6268 → 3.7.0-canary-6269

package/lib/commands/build/buildLocale.js

@@ -19,6 +19,7 @@ const client_1 = require("../../webpack/client");
 const server_1 = tslib_1.__importDefault(require("../../webpack/server"));
 const configure_1 = require("../../webpack/configure");
 const ssgExecutor_1 = require("../../ssg/ssgExecutor");
+const clearPath_1 = tslib_1.__importDefault(require("../utils/clearPath"));
 async function buildLocale({ siteDir, locale, cliOptions, }) {
     // Temporary workaround to unlock the ability to translate the site config
     // We'll remove it if a better official API can be designed
@@ -47,6 +48,10 @@ async function buildLocale({ siteDir, locale, cliOptions, }) {
             props,
             configureWebpackUtils,
         }),
+        // We also clear website/build dir
+        // returns void, no useful result needed before compilation
+        // See also https://github.com/facebook/docusaurus/pull/11037
+        (0, clearPath_1.default)(outDir),
     ]));
     // Run webpack to build JS bundle (client) and static html files (server).
     await logger_1.PerfLogger.async(`Bundling with ${props.currentBundler.name}`, () => {

package/lib/commands/clear.js

@@ -12,12 +12,13 @@ const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
+const clearPath_1 = tslib_1.__importDefault(require("./utils/clearPath"));
 async function removePath(entry) {
     if (!(await fs_extra_1.default.pathExists(entry.path))) {
         return;
     }
     try {
-        await fs_extra_1.default.remove(entry.path);
+        await (0, clearPath_1.default)(entry.path);
         logger_1.default.success `Removed the ${entry.description} at path=${path_1.default.relative(process.cwd(), entry.path)}.`;
     }
     catch (err) {

package/lib/commands/utils/clearPath.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * @param pathToClear
+ */
+export default function clearPath(pathToClear: string): Promise<void>;

package/lib/commands/utils/clearPath.js

@@ -0,0 +1,21 @@
+"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.default = clearPath;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const promises_1 = require("fs/promises");
+const logger_1 = require("@docusaurus/logger");
+/**
+ * @param pathToClear
+ */
+async function clearPath(pathToClear) {
+    return logger_1.PerfLogger.async(`clearPath ${path_1.default.relative(process.cwd(), pathToClear)}`, async () => {
+        await (0, promises_1.rm)(pathToClear, { recursive: true, force: true });
+    });
+}

package/lib/webpack/client.js

@@ -17,7 +17,6 @@ const html_webpack_plugin_1 = tslib_1.__importDefault(require("html-webpack-plug
 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, faster, configureWebpackUtils, }) {
@@ -108,8 +107,6 @@ async function createBuildClientConfig({ props, minify, faster, configureWebpack
     }), {
         plugins: [
             new ForceTerminatePlugin_1.default(),
-            // Remove/clean build folders before building bundles.
-            new CleanWebpackPlugin_1.default({ verbose: false }),
             // Visualize size of webpack output files with an interactive zoomable
             // tree map.
             bundleAnalyzer && new webpack_bundle_analyzer_1.BundleAnalyzerPlugin(),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.7.0-canary-6268",
+  "version": "3.7.0-canary-6269",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.7.0-canary-6268",
-    "@docusaurus/bundler": "3.7.0-canary-6268",
-    "@docusaurus/logger": "3.7.0-canary-6268",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6268",
-    "@docusaurus/utils": "3.7.0-canary-6268",
-    "@docusaurus/utils-common": "3.7.0-canary-6268",
-    "@docusaurus/utils-validation": "3.7.0-canary-6268",
+    "@docusaurus/babel": "3.7.0-canary-6269",
+    "@docusaurus/bundler": "3.7.0-canary-6269",
+    "@docusaurus/logger": "3.7.0-canary-6269",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6269",
+    "@docusaurus/utils": "3.7.0-canary-6269",
+    "@docusaurus/utils-common": "3.7.0-canary-6269",
+    "@docusaurus/utils-validation": "3.7.0-canary-6269",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -47,7 +47,6 @@
     "combine-promises": "^1.1.0",
     "commander": "^5.1.0",
     "core-js": "^3.31.1",
-    "del": "^6.1.1",
     "detect-port": "^1.5.1",
     "escape-html": "^1.0.3",
     "eta": "^2.2.0",
@@ -78,8 +77,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.7.0-canary-6268",
-    "@docusaurus/types": "3.7.0-canary-6268",
+    "@docusaurus/module-type-aliases": "3.7.0-canary-6269",
+    "@docusaurus/types": "3.7.0-canary-6269",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -99,5 +98,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "c89bf6ccb376f002475ce694c433fa7b5c7c1b89"
+  "gitHead": "deb4953b7b273312e2a139a205440810786d4228"
 }

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

@@ -1,59 +0,0 @@
-/**
- * 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 { Compiler, Stats } from 'webpack';
-export type Options = {
-    /**
-     * Write Logs to Console
-     * (Always enabled when dry is true)
-     *
-     * default: false
-     */
-    verbose?: boolean;
-    /**
-     * Automatically remove all unused webpack assets on rebuild
-     *
-     * default: true
-     */
-    cleanStaleWebpackAssets?: boolean;
-    /**
-     * Do not allow removal of current webpack assets
-     *
-     * default: true
-     */
-    protectWebpackAssets?: boolean;
-    /**
-     * Removes files once prior to Webpack compilation
-     *   Not included in rebuilds (watch mode)
-     *
-     * Use !negative patterns to exclude files
-     *
-     * default: ['**\/*']
-     */
-    cleanOnceBeforeBuildPatterns?: string[];
-};
-export default class CleanWebpackPlugin {
-    private readonly verbose;
-    private readonly cleanStaleWebpackAssets;
-    private readonly protectWebpackAssets;
-    private readonly cleanOnceBeforeBuildPatterns;
-    private currentAssets;
-    private initialClean;
-    private outputPath;
-    constructor(options?: Options);
-    apply(compiler: Compiler): void;
-    /**
-     * Initially remove files from output directory prior to build.
-     *
-     * Only happens once.
-     *
-     * 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;
-}

package/lib/webpack/plugins/CleanWebpackPlugin.js

@@ -1,177 +0,0 @@
-"use strict";
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-/**
- * 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.
- */
-// Forked from https://github.com/johnagan/clean-webpack-plugin
-// Modified to optimize performance for Docusaurus specific use case
-// More context: https://github.com/facebook/docusaurus/pull/1839
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const del_1 = require("del");
-class CleanWebpackPlugin {
-    constructor(options = {}) {
-        this.verbose = options.verbose === true || false;
-        this.cleanStaleWebpackAssets =
-            options.cleanStaleWebpackAssets === true ||
-                options.cleanStaleWebpackAssets === false
-                ? options.cleanStaleWebpackAssets
-                : true;
-        this.protectWebpackAssets =
-            options.protectWebpackAssets === true ||
-                options.protectWebpackAssets === false
-                ? options.protectWebpackAssets
-                : true;
-        this.cleanOnceBeforeBuildPatterns = Array.isArray(options.cleanOnceBeforeBuildPatterns)
-            ? options.cleanOnceBeforeBuildPatterns
-            : ['**/*'];
-        /**
-         * Store webpack build assets
-         */
-        this.currentAssets = [];
-        /**
-         * Only used with cleanOnceBeforeBuildPatterns
-         */
-        this.initialClean = false;
-        this.outputPath = '';
-        this.apply = this.apply.bind(this);
-        this.handleInitial = this.handleInitial.bind(this);
-        this.handleDone = this.handleDone.bind(this);
-        this.removeFiles = this.removeFiles.bind(this);
-    }
-    apply(compiler) {
-        if (!compiler.options.output.path) {
-            console.warn('clean-webpack-plugin: options.output.path not defined. Plugin disabled...');
-            return;
-        }
-        this.outputPath = compiler.options.output.path;
-        const { hooks } = compiler;
-        if (this.cleanOnceBeforeBuildPatterns.length !== 0) {
-            hooks.compile.tap('clean-webpack-plugin', () => {
-                this.handleInitial();
-            });
-        }
-        hooks.done.tap('clean-webpack-plugin', (stats) => {
-            this.handleDone(stats);
-        });
-    }
-    /**
-     * Initially remove files from output directory prior to build.
-     *
-     * Only happens once.
-     *
-     * Warning: It is recommended to initially clean your build directory outside
-     * of webpack to minimize unexpected behavior.
-     */
-    handleInitial() {
-        if (this.initialClean) {
-            return;
-        }
-        if (
-        // eslint-disable-next-line no-restricted-properties
-        fs_extra_1.default.pathExistsSync(this.outputPath) &&
-            // eslint-disable-next-line no-restricted-properties
-            fs_extra_1.default.statSync(this.outputPath).isFile()) {
-            throw new Error(`A file '${this.outputPath}' already exists. Docusaurus needs this directory to save the build output. Either remove/change the file or choose a different build directory via '--out-dir'.`);
-        }
-        this.initialClean = true;
-        this.removeFiles(this.cleanOnceBeforeBuildPatterns);
-    }
-    handleDone(stats) {
-        /**
-         * Do nothing if there is a webpack error
-         */
-        if (stats.hasErrors()) {
-            if (this.verbose) {
-                console.warn('clean-webpack-plugin: pausing due to webpack errors');
-            }
-            return;
-        }
-        /**
-         * Fetch Webpack's output asset files
-         */
-        const statsAssets = stats.toJson({
-            all: false,
-            assets: true,
-        }).assets ?? [];
-        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) => !assets.includes(previousAsset));
-        /**
-         * Save assets for next compilation
-         */
-        this.currentAssets = assets.sort();
-        const removePatterns = [];
-        /**
-         * Remove unused webpack assets
-         */
-        if (this.cleanStaleWebpackAssets && staleFiles.length !== 0) {
-            removePatterns.push(...staleFiles);
-        }
-        if (removePatterns.length !== 0) {
-            this.removeFiles(removePatterns);
-        }
-    }
-    removeFiles(patterns) {
-        try {
-            const deleted = (0, del_1.sync)(patterns, {
-                force: false,
-                // Change context to build directory
-                cwd: this.outputPath,
-                dryRun: false,
-                dot: true,
-                ignore: this.protectWebpackAssets ? this.currentAssets : [],
-            });
-            /**
-             * Log if verbose is enabled
-             */
-            if (this.verbose) {
-                deleted.forEach((file) => {
-                    const filename = path_1.default.relative(process.cwd(), file);
-                    /**
-                     * Use console.warn over .log
-                     * https://github.com/webpack/webpack/issues/1904
-                     * https://github.com/johnagan/clean-webpack-plugin/issues/11
-                     */
-                    console.warn(`clean-webpack-plugin: removed ${filename}`);
-                });
-            }
-        }
-        catch (err) {
-            const needsForce = err.message.includes('Cannot delete files/folders outside the current working directory.');
-            if (needsForce) {
-                const message = 'clean-webpack-plugin: Cannot delete files/folders outside the current working directory. Can be overridden with the "dangerouslyAllowCleanPatternsOutsideProject" option.';
-                throw new Error(message);
-            }
-            throw err;
-        }
-    }
-}
-exports.default = CleanWebpackPlugin;