@docusaurus/core 3.5.2 → 3.6.0

package/lib/server/utils.js

@@ -1,20 +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 });
-exports.safeGlobby = safeGlobby;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const utils_1 = require("@docusaurus/utils");
-// Globby that fix Windows path patterns
-// See https://github.com/facebook/docusaurus/pull/4222#issuecomment-795517329
-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) => (0, utils_1.posixPath)(path_1.default.relative(process.cwd(), dirPath)));
-    return (0, utils_1.Globby)(globPaths, options);
-}

package/lib/ssg.d.ts

@@ -1,35 +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 { AppRenderer, SiteCollectedData } from './common';
-import type { Manifest } from 'react-loadable-ssr-addon-v5-slorber';
-import type { SSRTemplateCompiled } from './templates/templates';
-export type SSGParams = {
-    trailingSlash: boolean | undefined;
-    manifest: Manifest;
-    headTags: string;
-    preBodyTags: string;
-    postBodyTags: string;
-    outDir: string;
-    baseUrl: string;
-    noIndex: boolean;
-    DOCUSAURUS_VERSION: string;
-    ssrTemplate: SSRTemplateCompiled;
-};
-export declare function loadAppRenderer({ serverBundlePath, }: {
-    serverBundlePath: string;
-}): Promise<AppRenderer>;
-export declare function generateStaticFiles({ pathnames, renderer, params, }: {
-    pathnames: string[];
-    renderer: AppRenderer;
-    params: SSGParams;
-}): Promise<{
-    collectedData: SiteCollectedData;
-}>;
-export declare function generateHashRouterEntrypoint({ content, params, }: {
-    content: string;
-    params: SSGParams;
-}): Promise<void>;

package/lib/utils.d.ts

@@ -1,9 +0,0 @@
-export declare const PerfDebuggingEnabled: boolean;
-type PerfLoggerAPI = {
-    start: (label: string) => void;
-    end: (label: string) => void;
-    log: (message: string) => void;
-    async: <Result>(label: string, asyncFn: () => Result | Promise<Result>) => Promise<Result>;
-};
-export declare const PerfLogger: PerfLoggerAPI;
-export {};

package/lib/utils.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PerfLogger = exports.PerfDebuggingEnabled = 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 async_hooks_1 = require("async_hooks");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-// For now this is a private env variable we use internally
-// But we'll want to expose this feature officially some day
-exports.PerfDebuggingEnabled = !!process.env.DOCUSAURUS_PERF_LOGGER;
-const Thresholds = {
-    min: 5,
-    yellow: 100,
-    red: 1000,
-};
-const PerfPrefix = logger_1.default.yellow(`[PERF] `);
-// This is what enables to "see the parent stack" for each log
-// Parent1 > Parent2 > Parent3 > child trace
-const ParentPrefix = new async_hooks_1.AsyncLocalStorage();
-function applyParentPrefix(label) {
-    const parentPrefix = ParentPrefix.getStore();
-    return parentPrefix ? `${parentPrefix} > ${label}` : label;
-}
-function createPerfLogger() {
-    if (!exports.PerfDebuggingEnabled) {
-        const noop = () => { };
-        return {
-            start: noop,
-            end: noop,
-            log: noop,
-            async: async (_label, asyncFn) => asyncFn(),
-        };
-    }
-    const formatDuration = (duration) => {
-        if (duration > Thresholds.red) {
-            return logger_1.default.red(`${(duration / 1000).toFixed(2)} seconds!`);
-        }
-        else if (duration > Thresholds.yellow) {
-            return logger_1.default.yellow(`${duration.toFixed(2)} ms`);
-        }
-        else {
-            return logger_1.default.green(`${duration.toFixed(2)} ms`);
-        }
-    };
-    const logDuration = (label, duration) => {
-        if (duration < Thresholds.min) {
-            return;
-        }
-        console.log(`${PerfPrefix + label} - ${formatDuration(duration)}`);
-    };
-    const start = (label) => performance.mark(label);
-    const end = (label) => {
-        const { duration } = performance.measure(label);
-        performance.clearMarks(label);
-        logDuration(applyParentPrefix(label), duration);
-    };
-    const log = (label) => console.log(PerfPrefix + applyParentPrefix(label));
-    const async = async (label, asyncFn) => {
-        const finalLabel = applyParentPrefix(label);
-        const before = performance.now();
-        const result = await ParentPrefix.run(finalLabel, () => asyncFn());
-        const duration = performance.now() - before;
-        logDuration(finalLabel, duration);
-        return result;
-    };
-    return {
-        start,
-        end,
-        log,
-        async,
-    };
-}
-exports.PerfLogger = createPerfLogger();

package/lib/webpack/minification.js

@@ -1,96 +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 });
-exports.getMinimizer = getMinimizer;
-const tslib_1 = require("tslib");
-const terser_webpack_plugin_1 = tslib_1.__importDefault(require("terser-webpack-plugin"));
-const css_minimizer_webpack_plugin_1 = tslib_1.__importDefault(require("css-minimizer-webpack-plugin"));
-// See https://github.com/webpack-contrib/terser-webpack-plugin#parallel
-function getTerserParallel() {
-    let terserParallel = true;
-    if (process.env.TERSER_PARALLEL === 'false') {
-        terserParallel = false;
-    }
-    else if (process.env.TERSER_PARALLEL &&
-        parseInt(process.env.TERSER_PARALLEL, 10) > 0) {
-        terserParallel = parseInt(process.env.TERSER_PARALLEL, 10);
-    }
-    return terserParallel;
-}
-function getJsMinifierPlugin() {
-    return new terser_webpack_plugin_1.default({
-        parallel: getTerserParallel(),
-        terserOptions: {
-            parse: {
-                // We want uglify-js to parse ecma 8 code. However, we don't want it
-                // to apply any minification steps that turns valid ecma 5 code
-                // into invalid ecma 5 code. This is why the 'compress' and 'output'
-                // sections only apply transformations that are ecma 5 safe
-                // https://github.com/facebook/create-react-app/pull/4234
-                ecma: 2020,
-            },
-            compress: {
-                ecma: 5,
-            },
-            mangle: {
-                safari10: true,
-            },
-            output: {
-                ecma: 5,
-                comments: false,
-                // Turned on because emoji and regex is not minified properly using
-                // default. See https://github.com/facebook/create-react-app/issues/2488
-                ascii_only: true,
-            },
-        },
-    });
-}
-function getAdvancedCssMinifier() {
-    // Using the array syntax to add 2 minimizers
-    // see https://github.com/webpack-contrib/css-minimizer-webpack-plugin#array
-    return new css_minimizer_webpack_plugin_1.default({
-        minimizerOptions: [
-            // CssNano options
-            {
-                preset: require.resolve('@docusaurus/cssnano-preset'),
-            },
-            // CleanCss options
-            {
-                inline: false,
-                level: {
-                    1: {
-                        all: false,
-                        removeWhitespace: true,
-                    },
-                    2: {
-                        all: true,
-                        restructureRules: true,
-                        removeUnusedAtRules: false,
-                    },
-                },
-            },
-        ],
-        minify: [
-            css_minimizer_webpack_plugin_1.default.cssnanoMinify,
-            css_minimizer_webpack_plugin_1.default.cleanCssMinify,
-        ],
-    });
-}
-function getMinimizer() {
-    // This is an historical env variable to opt-out of the advanced minifier
-    // Sometimes there's a bug in it and people are happy to disable it
-    const useSimpleCssMinifier = process.env.USE_SIMPLE_CSS_MINIFIER === 'true';
-    const minimizer = [getJsMinifierPlugin()];
-    if (useSimpleCssMinifier) {
-        minimizer.push(new css_minimizer_webpack_plugin_1.default());
-    }
-    else {
-        minimizer.push(getAdvancedCssMinifier());
-    }
-    return minimizer;
-}

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

@@ -1,16 +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 } from 'webpack';
-type WaitPluginOptions = {
-    filepath: string;
-};
-export default class WaitPlugin {
-    filepath: string;
-    constructor(options: WaitPluginOptions);
-    apply(compiler: Compiler): void;
-}
-export {};

package/lib/webpack/plugins/WaitPlugin.js

@@ -1,47 +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");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-class WaitPlugin {
-    constructor(options) {
-        this.filepath = options.filepath;
-    }
-    apply(compiler) {
-        // Before finishing the compilation step
-        compiler.hooks.make.tapPromise('WaitPlugin', () => waitOn(this.filepath));
-    }
-}
-exports.default = WaitPlugin;
-// This is a re-implementation of the algorithm used by the "wait-on" package
-// https://github.com/jeffbski/wait-on/blob/master/lib/wait-on.js#L200
-async function waitOn(filepath) {
-    const pollingIntervalMs = 300;
-    const stabilityWindowMs = 750;
-    let lastFileSize = -1;
-    let lastFileTime = -1;
-    for (;;) {
-        let size = -1;
-        try {
-            size = (await fs_extra_1.default.stat(filepath)).size;
-        }
-        catch (err) { }
-        if (size !== -1) {
-            if (lastFileTime === -1 || size !== lastFileSize) {
-                lastFileSize = size;
-                lastFileTime = performance.now();
-            }
-            else if (performance.now() - lastFileTime >= stabilityWindowMs) {
-                return;
-            }
-        }
-        await new Promise((resolve) => {
-            setTimeout(resolve, pollingIntervalMs);
-        });
-    }
-}

package/lib/webpack/utils.d.ts

@@ -1,33 +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 webpack, { type Configuration, type RuleSetRule } from 'webpack';
-import type { TransformOptions } from '@babel/core';
-export declare function formatStatsErrorMessage(statsJson: ReturnType<webpack.Stats['toJson']> | undefined): string | undefined;
-export declare function printStatsWarnings(statsJson: ReturnType<webpack.Stats['toJson']> | undefined): void;
-export declare function getStyleLoaders(isServer: boolean, cssOptionsArg?: {
-    [key: string]: unknown;
-}): RuleSetRule[];
-export declare function getCustomBabelConfigFilePath(siteDir: string): Promise<string | undefined>;
-export declare function getBabelOptions({ isServer, babelOptions, }?: {
-    isServer?: boolean;
-    babelOptions?: TransformOptions | string;
-}): TransformOptions;
-export declare const getCustomizableJSLoader: (jsLoader?: "babel" | ((isServer: boolean) => RuleSetRule)) => ({ isServer, babelOptions, }: {
-    isServer: boolean;
-    babelOptions?: TransformOptions | string;
-}) => RuleSetRule;
-declare global {
-    interface Error {
-        /** @see https://webpack.js.org/api/node/#error-handling */
-        details: unknown;
-    }
-}
-export declare function compile(config: Configuration[]): Promise<webpack.MultiStats>;
-export declare function getHttpsConfig(): Promise<boolean | {
-    cert: Buffer;
-    key: Buffer;
-}>;

package/lib/webpack/utils.js

@@ -1,215 +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 });
-exports.getCustomizableJSLoader = void 0;
-exports.formatStatsErrorMessage = formatStatsErrorMessage;
-exports.printStatsWarnings = printStatsWarnings;
-exports.getStyleLoaders = getStyleLoaders;
-exports.getCustomBabelConfigFilePath = getCustomBabelConfigFilePath;
-exports.getBabelOptions = getBabelOptions;
-exports.compile = compile;
-exports.getHttpsConfig = getHttpsConfig;
-const tslib_1 = require("tslib");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const crypto_1 = tslib_1.__importDefault(require("crypto"));
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const utils_1 = require("@docusaurus/utils");
-const mini_css_extract_plugin_1 = tslib_1.__importDefault(require("mini-css-extract-plugin"));
-const webpack_1 = tslib_1.__importDefault(require("webpack"));
-const formatWebpackMessages_1 = tslib_1.__importDefault(require("react-dev-utils/formatWebpackMessages"));
-function formatStatsErrorMessage(statsJson) {
-    if (statsJson?.errors?.length) {
-        // TODO formatWebpackMessages does not print stack-traces
-        // Also the error causal chain is lost here
-        // We log the stacktrace inside serverEntry.tsx for now (not ideal)
-        const { errors } = (0, formatWebpackMessages_1.default)(statsJson);
-        return errors
-            .map((str) => logger_1.default.red(str))
-            .join(`\n\n${logger_1.default.yellow('--------------------------')}\n\n`);
-    }
-    return undefined;
-}
-function printStatsWarnings(statsJson) {
-    if (statsJson?.warnings?.length) {
-        statsJson.warnings?.forEach((warning) => {
-            logger_1.default.warn(warning);
-        });
-    }
-}
-// Utility method to get style loaders
-function getStyleLoaders(isServer, cssOptionsArg = {}) {
-    const cssOptions = {
-        // TODO turn esModule on later, see https://github.com/facebook/docusaurus/pull/6424
-        esModule: false,
-        ...cssOptionsArg,
-    };
-    if (isServer) {
-        return cssOptions.modules
-            ? [
-                {
-                    loader: require.resolve('css-loader'),
-                    options: cssOptions,
-                },
-            ]
-            : [
-                {
-                    loader: mini_css_extract_plugin_1.default.loader,
-                    options: {
-                        // Don't emit CSS files for SSR (previously used null-loader)
-                        // See https://github.com/webpack-contrib/mini-css-extract-plugin/issues/90#issuecomment-811991738
-                        emit: false,
-                    },
-                },
-                {
-                    loader: require.resolve('css-loader'),
-                    options: cssOptions,
-                },
-            ];
-    }
-    return [
-        {
-            loader: mini_css_extract_plugin_1.default.loader,
-            options: {
-                esModule: true,
-            },
-        },
-        {
-            loader: require.resolve('css-loader'),
-            options: cssOptions,
-        },
-        {
-            // Options for PostCSS as we reference these options twice
-            // Adds vendor prefixing based on your specified browser support in
-            // package.json
-            loader: require.resolve('postcss-loader'),
-            options: {
-                postcssOptions: {
-                    // Necessary for external CSS imports to work
-                    // https://github.com/facebook/create-react-app/issues/2677
-                    ident: 'postcss',
-                    plugins: [
-                        // eslint-disable-next-line global-require
-                        require('autoprefixer'),
-                    ],
-                },
-            },
-        },
-    ];
-}
-async function getCustomBabelConfigFilePath(siteDir) {
-    const customBabelConfigurationPath = path_1.default.join(siteDir, utils_1.BABEL_CONFIG_FILE_NAME);
-    return (await fs_extra_1.default.pathExists(customBabelConfigurationPath))
-        ? customBabelConfigurationPath
-        : undefined;
-}
-function getBabelOptions({ isServer, babelOptions, } = {}) {
-    if (typeof babelOptions === 'string') {
-        return {
-            babelrc: false,
-            configFile: babelOptions,
-            caller: { name: isServer ? 'server' : 'client' },
-        };
-    }
-    return {
-        ...(babelOptions ?? { presets: [require.resolve('../babel/preset')] }),
-        babelrc: false,
-        configFile: false,
-        caller: { name: isServer ? 'server' : 'client' },
-    };
-}
-// Name is generic on purpose
-// we want to support multiple js loader implementations (babel + esbuild)
-function getDefaultBabelLoader({ isServer, babelOptions, }) {
-    return {
-        loader: require.resolve('babel-loader'),
-        options: getBabelOptions({ isServer, babelOptions }),
-    };
-}
-const getCustomizableJSLoader = (jsLoader = 'babel') => ({ isServer, babelOptions, }) => jsLoader === 'babel'
-    ? getDefaultBabelLoader({ isServer, babelOptions })
-    : jsLoader(isServer);
-exports.getCustomizableJSLoader = getCustomizableJSLoader;
-function compile(config) {
-    return new Promise((resolve, reject) => {
-        const compiler = (0, webpack_1.default)(config);
-        compiler.run((err, stats) => {
-            if (err) {
-                logger_1.default.error(err.stack ?? err);
-                if (err.details) {
-                    logger_1.default.error(err.details);
-                }
-                reject(err);
-            }
-            // Let plugins consume all the stats
-            const errorsWarnings = stats?.toJson('errors-warnings');
-            if (stats?.hasErrors()) {
-                const statsErrorMessage = formatStatsErrorMessage(errorsWarnings);
-                reject(new Error(`Failed to compile due to Webpack errors.\n${statsErrorMessage}`));
-            }
-            printStatsWarnings(errorsWarnings);
-            // Webpack 5 requires calling close() so that persistent caching works
-            // See https://github.com/webpack/webpack.js.org/pull/4775
-            compiler.close((errClose) => {
-                if (errClose) {
-                    logger_1.default.error(`Error while closing Webpack compiler: ${errClose}`);
-                    reject(errClose);
-                }
-                else {
-                    resolve(stats);
-                }
-            });
-        });
-    });
-}
-// Ensure the certificate and key provided are valid and if not
-// throw an easy to debug error
-function validateKeyAndCerts({ cert, key, keyFile, crtFile, }) {
-    let encrypted;
-    try {
-        // publicEncrypt will throw an error with an invalid cert
-        encrypted = crypto_1.default.publicEncrypt(cert, Buffer.from('test'));
-    }
-    catch (err) {
-        logger_1.default.error `The certificate path=${crtFile} is invalid.`;
-        throw err;
-    }
-    try {
-        // privateDecrypt will throw an error with an invalid key
-        crypto_1.default.privateDecrypt(key, encrypted);
-    }
-    catch (err) {
-        logger_1.default.error `The certificate key path=${keyFile} is invalid.`;
-        throw err;
-    }
-}
-// Read file and throw an error if it doesn't exist
-async function readEnvFile(file, type) {
-    if (!(await fs_extra_1.default.pathExists(file))) {
-        throw new Error(`You specified ${type} in your env, but the file "${file}" can't be found.`);
-    }
-    return fs_extra_1.default.readFile(file);
-}
-// Get the https config
-// Return cert files if provided in env, otherwise just true or false
-async function getHttpsConfig() {
-    const appDirectory = await fs_extra_1.default.realpath(process.cwd());
-    const { SSL_CRT_FILE, SSL_KEY_FILE, HTTPS } = process.env;
-    const isHttps = HTTPS === 'true';
-    if (isHttps && SSL_CRT_FILE && SSL_KEY_FILE) {
-        const crtFile = path_1.default.resolve(appDirectory, SSL_CRT_FILE);
-        const keyFile = path_1.default.resolve(appDirectory, SSL_KEY_FILE);
-        const config = {
-            cert: await readEnvFile(crtFile, 'SSL_CRT_FILE'),
-            key: await readEnvFile(keyFile, 'SSL_KEY_FILE'),
-        };
-        validateKeyAndCerts({ ...config, keyFile, crtFile });
-        return config;
-    }
-    return isHttps;
-}