@docusaurus/core 0.0.0-5857 → 0.0.0-5860

package/lib/commands/start.js

@@ -1,242 +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.start = 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 logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const utils_1 = require("@docusaurus/utils");
-const chokidar_1 = tslib_1.__importDefault(require("chokidar"));
-const openBrowser_1 = tslib_1.__importDefault(require("react-dev-utils/openBrowser"));
-const WebpackDevServerUtils_1 = require("react-dev-utils/WebpackDevServerUtils");
-const evalSourceMapMiddleware_1 = tslib_1.__importDefault(require("react-dev-utils/evalSourceMapMiddleware"));
-const webpack_1 = tslib_1.__importDefault(require("webpack"));
-const webpack_dev_server_1 = tslib_1.__importDefault(require("webpack-dev-server"));
-const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
-const server_1 = require("../server");
-const client_1 = require("../webpack/client");
-const utils_2 = require("../webpack/utils");
-const getHostPort_1 = require("../server/getHostPort");
-const utils_3 = require("../utils");
-async function start(siteDirParam = '.', cliOptions = {}) {
-    // Temporary workaround to unlock the ability to translate the site config
-    // We'll remove it if a better official API can be designed
-    // See https://github.com/facebook/docusaurus/issues/4542
-    process.env.DOCUSAURUS_CURRENT_LOCALE = cliOptions.locale;
-    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
-    logger_1.default.info('Starting the development server...');
-    async function loadSite() {
-        utils_3.PerfLogger.start('Loading site');
-        const result = await (0, server_1.load)({
-            siteDir,
-            config: cliOptions.config,
-            locale: cliOptions.locale,
-            localizePath: undefined, // Should this be configurable?
-        });
-        utils_3.PerfLogger.end('Loading site');
-        return result;
-    }
-    // Process all related files as a prop.
-    const props = await loadSite();
-    const { host, port, getOpenUrl } = await createUrlUtils({ cliOptions });
-    const openUrl = getOpenUrl({ baseUrl: props.baseUrl });
-    logger_1.default.success `Docusaurus website is running at: url=${openUrl}`;
-    // Reload files processing.
-    const reload = lodash_1.default.debounce(() => {
-        loadSite()
-            .then(({ baseUrl: newBaseUrl }) => {
-            const newOpenUrl = getOpenUrl({ baseUrl: newBaseUrl });
-            if (newOpenUrl !== openUrl) {
-                logger_1.default.success `Docusaurus website is running at: url=${newOpenUrl}`;
-            }
-        })
-            .catch((err) => {
-            logger_1.default.error(err.stack);
-        });
-    }, 500);
-    // TODO this is historically not optimized!
-    //  When any site file changes, we reload absolutely everything :/
-    //  At least we should try to reload only one plugin individually?
-    setupFileWatchers({
-        props,
-        cliOptions,
-        onFileChange: () => {
-            reload();
-        },
-    });
-    const config = await getStartClientConfig({
-        props,
-        minify: cliOptions.minify ?? true,
-        poll: cliOptions.poll,
-    });
-    const compiler = (0, webpack_1.default)(config);
-    registerE2ETestHook(compiler);
-    const defaultDevServerConfig = await createDevServerConfig({
-        cliOptions,
-        props,
-        host,
-        port,
-    });
-    // Allow plugin authors to customize/override devServer config
-    const devServerConfig = (0, webpack_merge_1.default)([defaultDevServerConfig, config.devServer].filter(Boolean));
-    const devServer = new webpack_dev_server_1.default(devServerConfig, compiler);
-    devServer.startCallback(() => {
-        if (cliOptions.open) {
-            (0, openBrowser_1.default)(openUrl);
-        }
-    });
-    ['SIGINT', 'SIGTERM'].forEach((sig) => {
-        process.on(sig, () => {
-            devServer.stop();
-            process.exit();
-        });
-    });
-}
-exports.start = start;
-function createPollingOptions({ cliOptions }) {
-    return {
-        usePolling: !!cliOptions.poll,
-        interval: Number.isInteger(cliOptions.poll)
-            ? cliOptions.poll
-            : undefined,
-    };
-}
-function setupFileWatchers({ props, cliOptions, onFileChange, }) {
-    const { siteDir } = props;
-    const pathsToWatch = getPathsToWatch({ props });
-    const pollingOptions = createPollingOptions({ cliOptions });
-    const fsWatcher = chokidar_1.default.watch(pathsToWatch, {
-        cwd: siteDir,
-        ignoreInitial: true,
-        ...{ pollingOptions },
-    });
-    ['add', 'change', 'unlink', 'addDir', 'unlinkDir'].forEach((event) => fsWatcher.on(event, onFileChange));
-}
-function getPathsToWatch({ props }) {
-    const { siteDir, siteConfigPath, plugins, localizationDir } = props;
-    const normalizeToSiteDir = (filepath) => {
-        if (filepath && path_1.default.isAbsolute(filepath)) {
-            return (0, utils_1.posixPath)(path_1.default.relative(siteDir, filepath));
-        }
-        return (0, utils_1.posixPath)(filepath);
-    };
-    const pluginsPaths = plugins
-        .flatMap((plugin) => plugin.getPathsToWatch?.() ?? [])
-        .filter(Boolean)
-        .map(normalizeToSiteDir);
-    return [...pluginsPaths, siteConfigPath, localizationDir];
-}
-async function createUrlUtils({ cliOptions }) {
-    const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
-    const { host, port } = await (0, getHostPort_1.getHostPort)(cliOptions);
-    if (port === null) {
-        return process.exit();
-    }
-    const getOpenUrl = ({ baseUrl }) => {
-        const urls = (0, WebpackDevServerUtils_1.prepareUrls)(protocol, host, port);
-        return (0, utils_1.normalizeUrl)([urls.localUrlForBrowser, baseUrl]);
-    };
-    return { host, port, getOpenUrl };
-}
-async function createDevServerConfig({ cliOptions, props, host, port, }) {
-    const { baseUrl, siteDir, siteConfig } = props;
-    const pollingOptions = createPollingOptions({ cliOptions });
-    const httpsConfig = await (0, utils_2.getHttpsConfig)();
-    // https://webpack.js.org/configuration/dev-server
-    return {
-        hot: cliOptions.hotOnly ? 'only' : true,
-        liveReload: false,
-        client: {
-            progress: true,
-            overlay: {
-                warnings: false,
-                errors: true,
-            },
-            webSocketURL: {
-                hostname: '0.0.0.0',
-                port: 0,
-            },
-        },
-        headers: {
-            'access-control-allow-origin': '*',
-        },
-        devMiddleware: {
-            publicPath: baseUrl,
-            // Reduce log verbosity, see https://github.com/facebook/docusaurus/pull/5420#issuecomment-906613105
-            stats: 'summary',
-        },
-        static: siteConfig.staticDirectories.map((dir) => ({
-            publicPath: baseUrl,
-            directory: path_1.default.resolve(siteDir, dir),
-            watch: {
-                // Useful options for our own monorepo using symlinks!
-                // See https://github.com/webpack/webpack/issues/11612#issuecomment-879259806
-                followSymlinks: true,
-                ignored: /node_modules\/(?!@docusaurus)/,
-                ...{ pollingOptions },
-            },
-        })),
-        ...(httpsConfig && {
-            server: typeof httpsConfig === 'object'
-                ? {
-                    type: 'https',
-                    options: httpsConfig,
-                }
-                : 'https',
-        }),
-        historyApiFallback: {
-            rewrites: [{ from: /\/*/, to: baseUrl }],
-        },
-        allowedHosts: 'all',
-        host,
-        port,
-        setupMiddlewares: (middlewares, devServer) => {
-            // This lets us fetch source contents from webpack for the error overlay.
-            middlewares.unshift((0, evalSourceMapMiddleware_1.default)(devServer));
-            return middlewares;
-        },
-    };
-}
-// E2E_TEST=true docusaurus start
-// Makes "docusaurus start" exit immediately on success/error, for E2E test
-function registerE2ETestHook(compiler) {
-    compiler.hooks.done.tap('done', (stats) => {
-        const errorsWarnings = stats.toJson('errors-warnings');
-        const statsErrorMessage = (0, utils_2.formatStatsErrorMessage)(errorsWarnings);
-        if (statsErrorMessage) {
-            console.error(statsErrorMessage);
-        }
-        (0, utils_2.printStatsWarnings)(errorsWarnings);
-        if (process.env.E2E_TEST) {
-            if (stats.hasErrors()) {
-                logger_1.default.error('E2E_TEST: Project has compiler errors.');
-                process.exit(1);
-            }
-            logger_1.default.success('E2E_TEST: Project can compile.');
-            process.exit(0);
-        }
-    });
-}
-async function getStartClientConfig({ props, minify, poll, }) {
-    const { plugins, siteConfig } = props;
-    let { clientConfig: config } = await (0, client_1.createStartClientConfig)({
-        props,
-        minify,
-        poll,
-    });
-    config = (0, utils_2.executePluginsConfigurePostCss)({ plugins, config });
-    config = (0, utils_2.executePluginsConfigureWebpack)({
-        plugins,
-        config,
-        isServer: false,
-        jsLoader: siteConfig.webpack?.jsLoader,
-    });
-    return config;
-}

package/lib/server/index.js

@@ -1,154 +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.load = exports.loadContext = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const utils_1 = require("@docusaurus/utils");
-const config_1 = require("./config");
-const clientModules_1 = require("./clientModules");
-const plugins_1 = require("./plugins");
-const routes_1 = require("./routes");
-const htmlTags_1 = require("./htmlTags");
-const siteMetadata_1 = require("./siteMetadata");
-const i18n_1 = require("./i18n");
-const translations_1 = require("./translations/translations");
-/**
- * Loading context is the very first step in site building. Its options are
- * directly acquired from CLI options. It mainly loads `siteConfig` and the i18n
- * context (which includes code translations). The `LoadContext` will be passed
- * to plugin constructors.
- */
-async function loadContext(options) {
-    const { siteDir, outDir: baseOutDir = utils_1.DEFAULT_BUILD_DIR_NAME, locale, config: customConfigFilePath, } = options;
-    const generatedFilesDir = path_1.default.resolve(siteDir, utils_1.GENERATED_FILES_DIR_NAME);
-    const { siteConfig: initialSiteConfig, siteConfigPath } = await (0, config_1.loadSiteConfig)({
-        siteDir,
-        customConfigFilePath,
-    });
-    const i18n = await (0, i18n_1.loadI18n)(initialSiteConfig, { locale });
-    const baseUrl = (0, utils_1.localizePath)({
-        path: initialSiteConfig.baseUrl,
-        i18n,
-        options,
-        pathType: 'url',
-    });
-    const outDir = (0, utils_1.localizePath)({
-        path: path_1.default.resolve(siteDir, baseOutDir),
-        i18n,
-        options,
-        pathType: 'fs',
-    });
-    const siteConfig = { ...initialSiteConfig, baseUrl };
-    const localizationDir = path_1.default.resolve(siteDir, i18n.path, i18n.localeConfigs[i18n.currentLocale].path);
-    const codeTranslationFileContent = (await (0, translations_1.readCodeTranslationFileContent)({ localizationDir })) ?? {};
-    // We only need key->message for code translations
-    const codeTranslations = lodash_1.default.mapValues(codeTranslationFileContent, (value) => value.message);
-    return {
-        siteDir,
-        generatedFilesDir,
-        localizationDir,
-        siteConfig,
-        siteConfigPath,
-        outDir,
-        baseUrl,
-        i18n,
-        codeTranslations,
-    };
-}
-exports.loadContext = loadContext;
-/**
- * This is the crux of the Docusaurus server-side. It reads everything it needs—
- * code translations, config file, plugin modules... Plugins then use their
- * lifecycles to generate content and other data. It is side-effect-ful because
- * it generates temp files in the `.docusaurus` folder for the bundler.
- */
-async function load(options) {
-    const { siteDir } = options;
-    const context = await loadContext(options);
-    const { generatedFilesDir, siteConfig, siteConfigPath, outDir, baseUrl, i18n, localizationDir, codeTranslations: siteCodeTranslations, } = context;
-    const { plugins, pluginsRouteConfigs, globalData } = await (0, plugins_1.loadPlugins)(context);
-    const clientModules = (0, clientModules_1.loadClientModules)(plugins);
-    const { headTags, preBodyTags, postBodyTags } = (0, htmlTags_1.loadHtmlTags)(plugins);
-    const { registry, routesChunkNames, routesConfig, routesPaths } = (0, routes_1.loadRoutes)(pluginsRouteConfigs, baseUrl, siteConfig.onDuplicateRoutes);
-    const codeTranslations = {
-        ...(await (0, translations_1.getPluginsDefaultCodeTranslationMessages)(plugins)),
-        ...siteCodeTranslations,
-    };
-    const siteMetadata = await (0, siteMetadata_1.loadSiteMetadata)({ plugins, siteDir });
-    // === Side-effects part ===
-    const genWarning = (0, utils_1.generate)(generatedFilesDir, 
-    // cSpell:ignore DONT
-    'DONT-EDIT-THIS-FOLDER', `This folder stores temp files that Docusaurus' client bundler accesses.
-
-DO NOT hand-modify files in this folder because they will be overwritten in the
-next build. You can clear all build artifacts (including this folder) with the
-\`docusaurus clear\` command.
-`);
-    const genSiteConfig = (0, utils_1.generate)(generatedFilesDir, `${utils_1.DEFAULT_CONFIG_FILE_NAME}.mjs`, `/*
- * AUTOGENERATED - DON'T EDIT
- * Your edits in this file will be overwritten in the next build!
- * Modify the docusaurus.config.js file at your site's root instead.
- */
-export default ${JSON.stringify(siteConfig, null, 2)};
-`);
-    const genClientModules = (0, utils_1.generate)(generatedFilesDir, 'client-modules.js', `export default [
-${clientModules
-        // Use `require()` because `import()` is async but client modules can have CSS
-        // and the order matters for loading CSS.
-        .map((clientModule) => `  require("${(0, utils_1.escapePath)(clientModule)}"),`)
-        .join('\n')}
-];
-`);
-    const genRegistry = (0, utils_1.generate)(generatedFilesDir, 'registry.js', `export default {
-${Object.entries(registry)
-        .sort((a, b) => a[0].localeCompare(b[0]))
-        .map(([chunkName, modulePath]) => 
-    // modulePath is already escaped by escapePath
-    `  "${chunkName}": [() => import(/* webpackChunkName: "${chunkName}" */ "${modulePath}"), "${modulePath}", require.resolveWeak("${modulePath}")],`)
-        .join('\n')}};
-`);
-    const genRoutesChunkNames = (0, utils_1.generate)(generatedFilesDir, 'routesChunkNames.json', JSON.stringify(routesChunkNames, null, 2));
-    const genRoutes = (0, utils_1.generate)(generatedFilesDir, 'routes.js', routesConfig);
-    const genGlobalData = (0, utils_1.generate)(generatedFilesDir, 'globalData.json', JSON.stringify(globalData, null, 2));
-    const genI18n = (0, utils_1.generate)(generatedFilesDir, 'i18n.json', JSON.stringify(i18n, null, 2));
-    const genCodeTranslations = (0, utils_1.generate)(generatedFilesDir, 'codeTranslations.json', JSON.stringify(codeTranslations, null, 2));
-    const genSiteMetadata = (0, utils_1.generate)(generatedFilesDir, 'site-metadata.json', JSON.stringify(siteMetadata, null, 2));
-    await Promise.all([
-        genWarning,
-        genClientModules,
-        genSiteConfig,
-        genRegistry,
-        genRoutesChunkNames,
-        genRoutes,
-        genGlobalData,
-        genSiteMetadata,
-        genI18n,
-        genCodeTranslations,
-    ]);
-    return {
-        siteConfig,
-        siteConfigPath,
-        siteMetadata,
-        siteDir,
-        outDir,
-        baseUrl,
-        i18n,
-        localizationDir,
-        generatedFilesDir,
-        routes: pluginsRouteConfigs,
-        routesPaths,
-        plugins,
-        headTags,
-        preBodyTags,
-        postBodyTags,
-        codeTranslations,
-    };
-}
-exports.load = load;

package/lib/server/plugins/index.js

@@ -1,106 +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.loadPlugins = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const utils_1 = require("@docusaurus/utils");
-const init_1 = require("./init");
-const synthetic_1 = require("./synthetic");
-const translations_1 = require("../translations/translations");
-const routeConfig_1 = require("./routeConfig");
-/**
- * Initializes the plugins, runs `loadContent`, `translateContent`,
- * `contentLoaded`, and `translateThemeConfig`. Because `contentLoaded` is
- * side-effect-ful (it generates temp files), so is this function. This function
- * would also mutate `context.siteConfig.themeConfig` to translate it.
- */
-async function loadPlugins(context) {
-    // 1. Plugin Lifecycle - Initialization/Constructor.
-    const plugins = await (0, init_1.initPlugins)(context);
-    plugins.push((0, synthetic_1.createBootstrapPlugin)(context), (0, synthetic_1.createMDXFallbackPlugin)(context));
-    // 2. Plugin Lifecycle - loadContent.
-    // Currently plugins run lifecycle methods in parallel and are not
-    // order-dependent. We could change this in future if there are plugins which
-    // need to run in certain order or depend on others for data.
-    // This would also translate theme config and content upfront, given the
-    // translation files that the plugin declares.
-    const loadedPlugins = await Promise.all(plugins.map(async (plugin) => {
-        const content = await plugin.loadContent?.();
-        const rawTranslationFiles = (await plugin.getTranslationFiles?.({ content })) ?? [];
-        const translationFiles = await Promise.all(rawTranslationFiles.map((translationFile) => (0, translations_1.localizePluginTranslationFile)({
-            localizationDir: context.localizationDir,
-            translationFile,
-            plugin,
-        })));
-        const translatedContent = plugin.translateContent?.({ content, translationFiles }) ?? content;
-        const translatedThemeConfigSlice = plugin.translateThemeConfig?.({
-            themeConfig: context.siteConfig.themeConfig,
-            translationFiles,
-        });
-        // Side-effect to merge theme config translations. A plugin should only
-        // translate its own slice of theme config and should make no assumptions
-        // about other plugins' keys, so this is safe to run in parallel.
-        Object.assign(context.siteConfig.themeConfig, translatedThemeConfigSlice);
-        return { ...plugin, content: translatedContent };
-    }));
-    const allContent = lodash_1.default.chain(loadedPlugins)
-        .groupBy((item) => item.name)
-        .mapValues((nameItems) => lodash_1.default.chain(nameItems)
-        .groupBy((item) => item.options.id)
-        .mapValues((idItems) => idItems[0].content)
-        .value())
-        .value();
-    // 3. Plugin Lifecycle - contentLoaded.
-    const pluginsRouteConfigs = [];
-    const globalData = {};
-    await Promise.all(loadedPlugins.map(async ({ content, ...plugin }) => {
-        if (!plugin.contentLoaded) {
-            return;
-        }
-        const pluginId = plugin.options.id;
-        // Plugins data files are namespaced by pluginName/pluginId
-        const dataDir = path_1.default.join(context.generatedFilesDir, plugin.name, pluginId);
-        const pluginRouteContextModulePath = path_1.default.join(dataDir, `${(0, utils_1.docuHash)('pluginRouteContextModule')}.json`);
-        const pluginRouteContext = {
-            name: plugin.name,
-            id: pluginId,
-        };
-        await (0, utils_1.generate)('/', pluginRouteContextModulePath, JSON.stringify(pluginRouteContext, null, 2));
-        const actions = {
-            addRoute(initialRouteConfig) {
-                // Trailing slash behavior is handled generically for all plugins
-                const finalRouteConfig = (0, routeConfig_1.applyRouteTrailingSlash)(initialRouteConfig, context.siteConfig);
-                pluginsRouteConfigs.push({
-                    ...finalRouteConfig,
-                    context: {
-                        ...(finalRouteConfig.context && { data: finalRouteConfig.context }),
-                        plugin: pluginRouteContextModulePath,
-                    },
-                });
-            },
-            async createData(name, data) {
-                const modulePath = path_1.default.join(dataDir, name);
-                await (0, utils_1.generate)(dataDir, name, data);
-                return modulePath;
-            },
-            setGlobalData(data) {
-                var _a;
-                globalData[_a = plugin.name] ?? (globalData[_a] = {});
-                globalData[plugin.name][pluginId] = data;
-            },
-        };
-        await plugin.contentLoaded({ content, actions, allContent });
-    }));
-    // Sort the route config. This ensures that route with nested
-    // routes are always placed last.
-    (0, routeConfig_1.sortConfig)(pluginsRouteConfigs, context.siteConfig.baseUrl);
-    return { plugins: loadedPlugins, pluginsRouteConfigs, globalData };
-}
-exports.loadPlugins = loadPlugins;