@docusaurus/core 2.0.0-beta.ff31de0ff → 2.0.1

package/lib/webpack/plugins/CleanWebpackPlugin.js

@@ -7,6 +7,28 @@
  */
 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 del_1 = require("del");
 class CleanWebpackPlugin {
@@ -40,8 +62,7 @@ class CleanWebpackPlugin {
         this.removeFiles = this.removeFiles.bind(this);
     }
     apply(compiler) {
-        if (!compiler.options.output || !compiler.options.output.path) {
-            // eslint-disable-next-line no-console
+        if (!compiler.options.output.path) {
             console.warn('clean-webpack-plugin: options.output.path not defined. Plugin disabled...');
             return;
         }
@@ -61,7 +82,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) {
@@ -76,7 +98,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;
@@ -87,18 +108,14 @@ class CleanWebpackPlugin {
         const statsAssets = stats.toJson({
             all: false,
             assets: true,
-        }).assets || [];
-        const assets = statsAssets.map((asset) => {
-            return asset.name;
-        });
+        }).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) => {
-            return assets.includes(previousAsset) === false;
-        });
+        const staleFiles = this.currentAssets.filter((previousAsset) => !assets.includes(previousAsset));
         /**
          * Save assets for next compilation
          */
@@ -107,7 +124,7 @@ class CleanWebpackPlugin {
         /**
          * Remove unused webpack assets
          */
-        if (this.cleanStaleWebpackAssets === true && staleFiles.length !== 0) {
+        if (this.cleanStaleWebpackAssets && staleFiles.length !== 0) {
             removePatterns.push(...staleFiles);
         }
         if (removePatterns.length !== 0) {
@@ -116,7 +133,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,18 +152,17 @@ 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}`);
                 });
             }
         }
-        catch (error) {
-            const needsForce = /Cannot delete files\/folders outside the current working directory\./.test(error.message);
+        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.';
+                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 error;
+            throw err;
         }
     }
 }

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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import WebpackBar from 'webpackbar';
-import { Compiler } from 'webpack';
+import type { Compiler } from 'webpack';
 export default class LogPlugin extends WebpackBar {
     apply(compiler: Compiler): void;
 }

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.
  */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 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"));
+const formatWebpackMessages_1 = 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.d.ts

@@ -4,10 +4,10 @@
  * 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';
-interface WaitPluginOptions {
+import type { Compiler } from 'webpack';
+declare type WaitPluginOptions = {
     filepath: string;
-}
+};
 export default class WaitPlugin {
     filepath: string;
     constructor(options: WaitPluginOptions);

package/lib/webpack/plugins/WaitPlugin.js

@@ -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.d.ts

@@ -4,9 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Configuration } from 'webpack';
-import { Props } from '@docusaurus/types';
-export default function createServerConfig({ props, onLinksCollected, }: {
+import { type Locals } from '@slorber/static-site-generator-webpack-plugin';
+import type { Props } from '@docusaurus/types';
+import type { Configuration } from 'webpack';
+export default function createServerConfig({ props, onLinksCollected, onHeadTagsCollected, }: Pick<Locals, 'onLinksCollected' | 'onHeadTagsCollected'> & {
     props: Props;
-    onLinksCollected?: (staticPagePath: string, links: string[]) => void;
-}): Configuration;
+}): Promise<Configuration>;

package/lib/webpack/server.js

@@ -8,15 +8,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
-const static_site_generator_webpack_plugin_1 = tslib_1.__importDefault(require("@endiliey/static-site-generator-webpack-plugin"));
 const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
+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 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");
-function createServerConfig({ props, onLinksCollected = () => { }, }) {
-    const { baseUrl, routesPaths, generatedFilesDir, headTags, preBodyTags, postBodyTags, ssrTemplate, siteConfig: { noIndex }, } = props;
-    const config = base_1.createBaseConfig(props, true);
+const ssr_html_template_1 = tslib_1.__importDefault(require("./templates/ssr.html.template"));
+async function createServerConfig({ props, onLinksCollected, onHeadTagsCollected, }) {
+    const { baseUrl, routesPaths, generatedFilesDir, headTags, preBodyTags, postBodyTags, siteConfig: { noIndex, trailingSlash, ssrTemplate }, } = props;
+    const config = await (0, base_1.createBaseConfig)(props, true);
     const routesLocation = {};
     // Array of paths to be rendered. Relative to output directory
     const ssgPaths = routesPaths.map((str) => {
@@ -24,8 +26,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'),
         },
@@ -51,10 +53,23 @@ function createServerConfig({ props, onLinksCollected = () => { }, }) {
                     preBodyTags,
                     postBodyTags,
                     onLinksCollected,
-                    ssrTemplate,
+                    onHeadTagsCollected,
+                    ssrTemplate: ssrTemplate ?? ssr_html_template_1.default,
                     noIndex,
+                    DOCUSAURUS_VERSION: utils_1.DOCUSAURUS_VERSION,
                 },
                 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
+                globals: { __filename: '' },
+                // Secret way to set SSR plugin concurrency option
+                // Waiting for feedback before documenting this officially?
+                concurrency: process.env.DOCUSAURUS_SSR_CONCURRENCY
+                    ? parseInt(process.env.DOCUSAURUS_SSR_CONCURRENCY, 10)
+                    : undefined,
             }),
             // Show compilation progress bar.
             new LogPlugin_1.default({

package/lib/webpack/templates/ssr.html.template.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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.
+ */
+declare const _default: "\n<!DOCTYPE html>\n<html <%~ it.htmlAttributes %>>\n  <head>\n    <meta charset=\"UTF-8\">\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n    <meta name=\"generator\" content=\"Docusaurus v<%= it.version %>\">\n    <% if (it.noIndex) { %>\n      <meta name=\"robots\" content=\"noindex, nofollow\" />\n    <% } %>\n    <%~ it.headTags %>\n    <% it.metaAttributes.forEach((metaAttribute) => { %>\n      <%~ metaAttribute %>\n    <% }); %>\n    <% it.stylesheets.forEach((stylesheet) => { %>\n      <link rel=\"stylesheet\" href=\"<%= it.baseUrl %><%= stylesheet %>\" />\n    <% }); %>\n    <% it.scripts.forEach((script) => { %>\n      <link rel=\"preload\" href=\"<%= it.baseUrl %><%= script %>\" as=\"script\">\n    <% }); %>\n  </head>\n  <body <%~ it.bodyAttributes %>>\n    <%~ it.preBodyTags %>\n    <div id=\"__docusaurus\">\n      <%~ it.appHtml %>\n    </div>\n    <% it.scripts.forEach((script) => { %>\n      <script src=\"<%= it.baseUrl %><%= script %>\"></script>\n    <% }); %>\n    <%~ it.postBodyTags %>\n  </body>\n</html>\n";
+export default _default;

package/lib/{client → webpack}/templates/ssr.html.template.js

@@ -1,11 +1,12 @@
+"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.
  */
-
-module.exports = `
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = `
 <!DOCTYPE html>
 <html <%~ it.htmlAttributes %>>
   <head>
@@ -20,7 +21,7 @@ module.exports = `
       <%~ metaAttribute %>
     <% }); %>
     <% it.stylesheets.forEach((stylesheet) => { %>
-      <link rel="stylesheet" type="text/css" href="<%= it.baseUrl %><%= stylesheet %>" />
+      <link rel="stylesheet" href="<%= it.baseUrl %><%= stylesheet %>" />
     <% }); %>
     <% it.scripts.forEach((script) => { %>
       <link rel="preload" href="<%= it.baseUrl %><%= script %>" as="script">
@@ -32,7 +33,7 @@ module.exports = `
       <%~ it.appHtml %>
     </div>
     <% it.scripts.forEach((script) => { %>
-      <script type="text/javascript" src="<%= it.baseUrl %><%= script %>"></script>
+      <script src="<%= it.baseUrl %><%= script %>"></script>
     <% }); %>
     <%~ it.postBodyTags %>
   </body>

package/lib/webpack/utils.d.ts

@@ -5,13 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference types="node" />
-import { Configuration, RuleSetRule, WebpackPluginInstance } from 'webpack';
-import { TransformOptions } from '@babel/core';
-import { ConfigureWebpackFn, ConfigurePostCssFn } from '@docusaurus/types';
-export declare function getStyleLoaders(isServer: boolean, cssOptions?: {
+import { type Configuration, type RuleSetRule, type WebpackPluginInstance } from 'webpack';
+import type { TransformOptions } from '@babel/core';
+import type { Plugin } from '@docusaurus/types';
+export declare function getStyleLoaders(isServer: boolean, cssOptionsArg?: {
     [key: string]: unknown;
 }): RuleSetRule[];
-export declare function getCustomBabelConfigFilePath(siteDir: string): string | undefined;
+export declare function getCustomBabelConfigFilePath(siteDir: string): Promise<string | undefined>;
 export declare function getBabelOptions({ isServer, babelOptions, }?: {
     isServer?: boolean;
     babelOptions?: TransformOptions | string;
@@ -26,35 +26,20 @@ export declare const getCustomizableJSLoader: (jsLoader?: "babel" | ((isServer:
  * @param config initial webpack config
  * @param isServer indicates if this is a server webpack configuration
  * @param jsLoader custom js loader config
+ * @param content content loaded by the plugin
  * @returns final/ modified webpack config
  */
-export declare function applyConfigureWebpack(configureWebpack: ConfigureWebpackFn, config: Configuration, isServer: boolean, jsLoader?: 'babel' | ((isServer: boolean) => RuleSetRule)): Configuration;
-export declare function applyConfigurePostCss(configurePostCss: NonNullable<ConfigurePostCssFn>, config: Configuration): Configuration;
+export declare function applyConfigureWebpack(configureWebpack: NonNullable<Plugin['configureWebpack']>, config: Configuration, isServer: boolean, jsLoader: 'babel' | ((isServer: boolean) => RuleSetRule) | undefined, content: unknown): Configuration;
+export declare function applyConfigurePostCss(configurePostCss: NonNullable<Plugin['configurePostCss']>, config: Configuration): Configuration;
+declare global {
+    interface Error {
+        /** @see https://webpack.js.org/api/node/#error-handling */
+        details: unknown;
+    }
+}
 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 | {
+export declare function getHttpsConfig(): Promise<boolean | {
     cert: Buffer;
     key: Buffer;
-};
+}>;
 export declare function getMinimizer(useSimpleCssMinifier?: boolean): WebpackPluginInstance[];
-export {};