@docusaurus/core 3.3.2 → 3.5.0

package/lib/server/codegen/codegenRoutes.js

@@ -6,7 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateRouteFiles = exports.generateRoutesCode = exports.genChunkName = void 0;
+exports.genChunkName = genChunkName;
+exports.generateRoutesCode = generateRoutesCode;
+exports.generateRoutePropFilename = generateRoutePropFilename;
+exports.generateRouteFiles = generateRouteFiles;
 const tslib_1 = require("tslib");
 const querystring_1 = tslib_1.__importDefault(require("querystring"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -53,7 +56,6 @@ function genChunkName(modulePath, prefix, preferredName, shortId = process.env.N
     }
     return chunkName;
 }
-exports.genChunkName = genChunkName;
 /**
  * Takes a piece of route config, and serializes it into raw JS code. The shape
  * is the same as react-router's `RouteConfig`. Formatting is similar to
@@ -169,7 +171,6 @@ ${indent(routeConfigSerialized)},
 `;
     return res;
 }
-exports.generateRoutesCode = generateRoutesCode;
 const genRegistry = ({ generatedFilesDir, registry, }) => (0, utils_1.generate)(generatedFilesDir, 'registry.js', `export default {
 ${Object.entries(registry)
     .sort((a, b) => a[0].localeCompare(b[0]))
@@ -180,12 +181,25 @@ ${Object.entries(registry)
 `);
 const genRoutesChunkNames = ({ generatedFilesDir, routesChunkNames, }) => (0, utils_1.generate)(generatedFilesDir, 'routesChunkNames.json', JSON.stringify(routesChunkNames, null, 2));
 const genRoutes = ({ generatedFilesDir, routesConfig, }) => (0, utils_1.generate)(generatedFilesDir, 'routes.js', routesConfig);
+// The generated filename per route must be unique to avoid conflicts
+// See also https://github.com/facebook/docusaurus/issues/10125
+function generateRoutePropFilename(route) {
+    // TODO if possible, we could try to shorten the filename by removing
+    //  the plugin routeBasePath prefix from the name
+    return `${(0, utils_1.docuHash)(route.path, 
+    // Note: using hash(route.path + route.component) is not technically
+    // as robust as hashing the entire prop content object.
+    // But it's faster and should be good enough considering it's very unlikely
+    // anyone would have 2 routes on the same path also rendering the exact
+    // same component.
+    { hashExtra: route.component })}.json`;
+}
 async function generateRoutePropModule({ generatedFilesDir, route, plugin, }) {
     ensureNoPropsConflict(route);
     const moduleContent = JSON.stringify(route.props);
     // TODO we should aim to reduce this path length
     // This adds bytes to the global module registry
-    const relativePath = path_1.default.posix.join(plugin.name, plugin.id, 'p', `${(0, utils_1.docuHash)(route.path)}.json`);
+    const relativePath = path_1.default.posix.join(plugin.name, plugin.id, 'p', generateRoutePropFilename(route));
     const modulePath = path_1.default.posix.join(generatedFilesDir, relativePath);
     const aliasedPath = path_1.default.posix.join('@generated', relativePath);
     await (0, utils_1.generate)(generatedFilesDir, modulePath, moduleContent);
@@ -201,14 +215,14 @@ function ensureNoPropsConflict(route) {
     }
 }
 async function preprocessRouteProps({ generatedFilesDir, route, plugin, }) {
-    const propsModulePathPromise = route.props
+    const getPropsModulePathPromise = () => route.props
         ? generateRoutePropModule({
             generatedFilesDir,
             route,
             plugin,
         })
         : undefined;
-    const subRoutesPromise = route.routes
+    const getSubRoutesPromise = () => route.routes
         ? Promise.all(route.routes.map((subRoute) => {
             return preprocessRouteProps({
                 generatedFilesDir,
@@ -218,8 +232,8 @@ async function preprocessRouteProps({ generatedFilesDir, route, plugin, }) {
         }))
         : undefined;
     const [propsModulePath, subRoutes] = await Promise.all([
-        propsModulePathPromise,
-        subRoutesPromise,
+        getPropsModulePathPromise(),
+        getSubRoutesPromise(),
     ]);
     const newRoute = {
         ...route,
@@ -256,4 +270,3 @@ async function generateRouteFiles({ generatedFilesDir, routes: initialRoutes, })
         genRoutes({ generatedFilesDir, routesConfig }),
     ]);
 }
-exports.generateRouteFiles = generateRouteFiles;

package/lib/server/config.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadSiteConfig = void 0;
+exports.loadSiteConfig = loadSiteConfig;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
@@ -39,4 +39,3 @@ async function loadSiteConfig({ siteDir, customConfigFilePath, }) {
     const siteConfig = (0, configValidation_1.validateConfig)(loadedConfig, path_1.default.relative(siteDir, siteConfigPath));
     return { siteConfig, siteConfigPath };
 }
-exports.loadSiteConfig = loadSiteConfig;

package/lib/server/configValidation.d.ts

@@ -5,9 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
+import type { FutureConfig, StorageConfig } from '@docusaurus/types/src/config';
 import type { DocusaurusConfig, I18nConfig, MarkdownConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
+export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
+export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
 export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
-export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
+export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
 export declare const ConfigSchema: Joi.ObjectSchema<DocusaurusConfig>;
 export declare function validateConfig(config: unknown, siteConfigPath: string): DocusaurusConfig;

package/lib/server/configValidation.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateConfig = exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.validateConfig = validateConfig;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_common_1 = require("@docusaurus/utils-common");
@@ -17,6 +18,14 @@ exports.DEFAULT_I18N_CONFIG = {
     locales: [DEFAULT_I18N_LOCALE],
     localeConfigs: {},
 };
+exports.DEFAULT_STORAGE_CONFIG = {
+    type: 'localStorage',
+    namespace: false,
+};
+exports.DEFAULT_FUTURE_CONFIG = {
+    experimental_storage: exports.DEFAULT_STORAGE_CONFIG,
+    experimental_router: 'browser',
+};
 exports.DEFAULT_MARKDOWN_CONFIG = {
     format: 'mdx', // TODO change this to "detect" in Docusaurus v4?
     mermaid: false,
@@ -34,6 +43,7 @@ exports.DEFAULT_MARKDOWN_CONFIG = {
 };
 exports.DEFAULT_CONFIG = {
     i18n: exports.DEFAULT_I18N_CONFIG,
+    future: exports.DEFAULT_FUTURE_CONFIG,
     onBrokenLinks: 'throw',
     onBrokenAnchors: 'warn', // TODO Docusaurus v4: change to throw
     onBrokenMarkdownLinks: 'warn',
@@ -120,6 +130,24 @@ const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
 })
     .optional()
     .default(exports.DEFAULT_I18N_CONFIG);
+const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
+    type: utils_validation_1.Joi.string()
+        .equal('localStorage', 'sessionStorage')
+        .default(exports.DEFAULT_STORAGE_CONFIG.type),
+    namespace: utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.string(), utils_validation_1.Joi.boolean())
+        .default(exports.DEFAULT_STORAGE_CONFIG.namespace),
+})
+    .optional()
+    .default(exports.DEFAULT_STORAGE_CONFIG);
+const FUTURE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
+    experimental_storage: STORAGE_CONFIG_SCHEMA,
+    experimental_router: utils_validation_1.Joi.string()
+        .equal('browser', 'hash')
+        .default(exports.DEFAULT_FUTURE_CONFIG.experimental_router),
+})
+    .optional()
+    .default(exports.DEFAULT_FUTURE_CONFIG);
 const SiteUrlSchema = utils_validation_1.Joi.string()
     .required()
     .custom((value, helpers) => {
@@ -152,6 +180,7 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
     url: SiteUrlSchema,
     trailingSlash: utils_validation_1.Joi.boolean(), // No default value! undefined = retrocompatible legacy behavior!
     i18n: I18N_CONFIG_SCHEMA,
+    future: FUTURE_CONFIG_SCHEMA,
     onBrokenLinks: utils_validation_1.Joi.string()
         .equal('ignore', 'log', 'warn', 'throw')
         .default(exports.DEFAULT_CONFIG.onBrokenLinks),
@@ -273,4 +302,3 @@ function validateConfig(config, siteConfigPath) {
         return value;
     }
 }
-exports.validateConfig = validateConfig;

package/lib/server/getHostPort.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHostPort = void 0;
+exports.getHostPort = getHostPort;
 const tslib_1 = require("tslib");
 const child_process_1 = require("child_process");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -79,4 +79,3 @@ async function getHostPort(options) {
     const port = await choosePort(host, basePort);
     return { host, port };
 }
-exports.getHostPort = getHostPort;

package/lib/server/htmlTags.d.ts

@@ -4,9 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { Props, LoadedPlugin } from '@docusaurus/types';
+import type { Props, LoadedPlugin, RouterType } from '@docusaurus/types';
 /**
  * Runs the `injectHtmlTags` lifecycle, and aggregates all plugins' tags into
  * directly render-able HTML markup.
  */
-export declare function loadHtmlTags(plugins: LoadedPlugin[]): Pick<Props, 'headTags' | 'preBodyTags' | 'postBodyTags'>;
+export declare function loadHtmlTags({ plugins, router, }: {
+    plugins: LoadedPlugin[];
+    router: RouterType;
+}): Pick<Props, 'headTags' | 'preBodyTags' | 'postBodyTags'>;

package/lib/server/htmlTags.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadHtmlTags = void 0;
+exports.loadHtmlTags = loadHtmlTags;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const html_tags_1 = tslib_1.__importDefault(require("html-tags"));
@@ -23,16 +23,25 @@ function assertIsHtmlTagObject(val) {
         throw new Error(`Error loading ${JSON.stringify(val)}, "${val.tagName}" is not a valid HTML tag.`);
     }
 }
-function htmlTagObjectToString(tag) {
+function hashRouterAbsoluteToRelativeTagAttribute(name, value) {
+    if ((name === 'src' || name === 'href') && value.startsWith('/')) {
+        return `.${value}`;
+    }
+    return value;
+}
+function htmlTagObjectToString({ tag, router, }) {
     assertIsHtmlTagObject(tag);
     const isVoidTag = void_1.default.includes(tag.tagName);
     const tagAttributes = tag.attributes ?? {};
     const attributes = Object.keys(tagAttributes)
         .map((attr) => {
-        const value = tagAttributes[attr];
+        let value = tagAttributes[attr];
         if (typeof value === 'boolean') {
             return value ? attr : undefined;
         }
+        if (router === 'hash') {
+            value = hashRouterAbsoluteToRelativeTagAttribute(attr, value);
+        }
         return `${attr}="${(0, escape_html_1.default)(value)}"`;
     })
         .filter((str) => Boolean(str));
@@ -41,22 +50,21 @@ function htmlTagObjectToString(tag) {
     const closingTag = isVoidTag ? '' : `</${tag.tagName}>`;
     return openingTag + innerHTML + closingTag;
 }
-function createHtmlTagsString(tags) {
+function createHtmlTagsString({ tags, router, }) {
     return (Array.isArray(tags) ? tags : [tags])
         .filter(Boolean)
-        .map((val) => (typeof val === 'string' ? val : htmlTagObjectToString(val)))
+        .map((val) => typeof val === 'string' ? val : htmlTagObjectToString({ tag: val, router }))
         .join('\n');
 }
 /**
  * Runs the `injectHtmlTags` lifecycle, and aggregates all plugins' tags into
  * directly render-able HTML markup.
  */
-function loadHtmlTags(plugins) {
+function loadHtmlTags({ plugins, router, }) {
     const pluginHtmlTags = plugins.map((plugin) => plugin.injectHtmlTags?.({ content: plugin.content }) ?? {});
     const tagTypes = ['headTags', 'preBodyTags', 'postBodyTags'];
     return Object.fromEntries(lodash_1.default.zip(tagTypes, tagTypes.map((type) => pluginHtmlTags
-        .map((tags) => createHtmlTagsString(tags[type]))
+        .map((tags) => createHtmlTagsString({ tags: tags[type], router }))
         .join('\n')
         .trim())));
 }
-exports.loadHtmlTags = loadHtmlTags;

package/lib/server/i18n.js

@@ -6,12 +6,37 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadI18n = exports.getDefaultLocaleConfig = void 0;
+exports.getDefaultLocaleConfig = getDefaultLocaleConfig;
+exports.loadI18n = loadI18n;
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const rtl_detect_1 = require("rtl-detect");
+function inferLanguageDisplayName(locale) {
+    const tryLocale = (l) => {
+        try {
+            return new Intl.DisplayNames(l, {
+                type: 'language',
+                fallback: 'code',
+            }).of(l);
+        }
+        catch (e) {
+            // This is to compensate "of()" that is a bit strict
+            // Looks like starting Node 22, this locale throws: "en-US-u-ca-buddhist"
+            // RangeError: invalid_argument
+            return null;
+        }
+    };
+    const parts = locale.split('-');
+    // This is a best effort, we try various locale forms that could give a result
+    return (tryLocale(locale) ??
+        tryLocale(`${parts[0]}-${parts[1]}`) ??
+        tryLocale(parts[0]));
+}
 function getDefaultLocaleLabel(locale) {
-    const languageName = new Intl.DisplayNames(locale, { type: 'language' }).of(locale);
+    const languageName = inferLanguageDisplayName(locale);
+    if (!languageName) {
+        return locale;
+    }
     return (languageName.charAt(0).toLocaleUpperCase(locale) + languageName.substring(1));
 }
 function getDefaultCalendar(localeStr) {
@@ -34,15 +59,19 @@ function getDefaultCalendar(localeStr) {
     return 'gregory';
 }
 function getDefaultLocaleConfig(locale) {
-    return {
-        label: getDefaultLocaleLabel(locale),
-        direction: (0, rtl_detect_1.getLangDir)(locale),
-        htmlLang: locale,
-        calendar: getDefaultCalendar(locale),
-        path: locale,
-    };
+    try {
+        return {
+            label: getDefaultLocaleLabel(locale),
+            direction: (0, rtl_detect_1.getLangDir)(locale),
+            htmlLang: locale,
+            calendar: getDefaultCalendar(locale),
+            path: locale,
+        };
+    }
+    catch (e) {
+        throw new Error(`Docusaurus couldn't get default locale config for ${locale}`, { cause: e });
+    }
 }
-exports.getDefaultLocaleConfig = getDefaultLocaleConfig;
 async function loadI18n(config, options) {
     const { i18n: i18nConfig } = config;
     const currentLocale = options.locale ?? i18nConfig.defaultLocale;
@@ -68,4 +97,3 @@ Note: Docusaurus only support running one locale at a time.`;
         localeConfigs,
     };
 }
-exports.loadI18n = loadI18n;

package/lib/server/plugins/actions.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPluginActionsUtils = void 0;
+exports.createPluginActionsUtils = createPluginActionsUtils;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
@@ -67,4 +67,3 @@ async function createPluginActionsUtils({ plugin, generatedFilesDir, baseUrl, tr
         getActions: () => actions,
     };
 }
-exports.createPluginActionsUtils = createPluginActionsUtils;

package/lib/server/plugins/configs.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadPluginConfigs = void 0;
+exports.loadPluginConfigs = loadPluginConfigs;
 const module_1 = require("module");
 const utils_1 = require("@docusaurus/utils");
 const presets_1 = require("./presets");
@@ -97,4 +97,3 @@ async function loadPluginConfigs(context) {
     ].filter((x) => Boolean(x));
     return Promise.all(pluginConfigs.map((pluginConfig) => normalizePluginConfig(pluginConfig, context.siteConfigPath, pluginRequire)));
 }
-exports.loadPluginConfigs = loadPluginConfigs;

package/lib/server/plugins/init.d.ts

@@ -4,9 +4,20 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import { type NormalizedPluginConfig } from './configs';
 import type { LoadContext, InitializedPlugin } from '@docusaurus/types';
+type PluginConfigInitResult = {
+    config: NormalizedPluginConfig;
+    plugin: InitializedPlugin | null;
+};
 /**
  * Runs the plugin constructors and returns their return values. It would load
  * plugin configs from `plugins`, `themes`, and `presets`.
  */
+export declare function initPluginsConfigs(context: LoadContext, pluginConfigs: NormalizedPluginConfig[]): Promise<PluginConfigInitResult[]>;
+/**
+ * Runs the plugin constructors and returns their return values
+ * for all the site context plugins that do not return null to self-disable.
+ */
 export declare function initPlugins(context: LoadContext): Promise<InitializedPlugin[]>;
+export {};

package/lib/server/plugins/init.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initPlugins = void 0;
+exports.initPluginsConfigs = initPluginsConfigs;
+exports.initPlugins = initPlugins;
 const tslib_1 = require("tslib");
 const module_1 = require("module");
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -31,15 +32,20 @@ function getThemeValidationFunction(normalizedPluginConfig) {
     }
     return normalizedPluginConfig.plugin.validateThemeConfig;
 }
+// This filters self-disabling plugins and returns only the initialized ones
+function onlyInitializedPlugins(initPluginsConfigsResults) {
+    return initPluginsConfigsResults
+        .map((results) => results.plugin)
+        .filter((p) => p !== null);
+}
 /**
  * Runs the plugin constructors and returns their return values. It would load
  * plugin configs from `plugins`, `themes`, and `presets`.
  */
-async function initPlugins(context) {
+async function initPluginsConfigs(context, pluginConfigs) {
     // We need to resolve plugins from the perspective of the site config, as if
     // we are using `require.resolve` on those module names.
     const pluginRequire = (0, module_1.createRequire)(context.siteConfigPath);
-    const pluginConfigs = await (0, configs_1.loadPluginConfigs)(context);
     async function doLoadPluginVersion(normalizedPluginConfig) {
         if (normalizedPluginConfig.pluginModule?.path) {
             const pluginPath = pluginRequire.resolve(normalizedPluginConfig.pluginModule.path);
@@ -76,20 +82,49 @@ async function initPlugins(context) {
         const pluginVersion = await doLoadPluginVersion(normalizedPluginConfig);
         const pluginOptions = doValidatePluginOptions(normalizedPluginConfig);
         // Side-effect: merge the normalized theme config in the original one
+        // Note: it's important to do this before calling the plugin constructor
+        // Example: the theme classic plugin will read siteConfig.themeConfig
         context.siteConfig.themeConfig = {
             ...context.siteConfig.themeConfig,
             ...doValidateThemeConfig(normalizedPluginConfig),
         };
         const pluginInstance = await normalizedPluginConfig.plugin(context, pluginOptions);
-        return {
+        // Returning null has been explicitly allowed
+        // It's a way for plugins to self-disable depending on context
+        // See https://github.com/facebook/docusaurus/pull/10286
+        if (pluginInstance === null) {
+            return { config: normalizedPluginConfig, plugin: null };
+        }
+        if (pluginInstance === undefined) {
+            throw new Error(`A Docusaurus plugin returned 'undefined', which is forbidden.
+A plugin is expected to return an object having at least a 'name' property.
+If you want a plugin to self-disable depending on context/options, you can explicitly return 'null' instead of 'undefined'`);
+        }
+        if (!pluginInstance?.name) {
+            throw new Error(`A Docusaurus plugin is missing a 'name' property.
+Note that even inline/anonymous plugin functions require a 'name' property.`);
+        }
+        const plugin = {
             ...pluginInstance,
             options: pluginOptions,
             version: pluginVersion,
             path: path_1.default.dirname(normalizedPluginConfig.entryPath),
         };
+        return {
+            config: normalizedPluginConfig,
+            plugin,
+        };
     }
-    const plugins = await Promise.all(pluginConfigs.map(initializePlugin));
-    (0, pluginIds_1.ensureUniquePluginInstanceIds)(plugins);
+    const plugins = (await Promise.all(pluginConfigs.map(initializePlugin))).filter((p) => p !== null);
+    (0, pluginIds_1.ensureUniquePluginInstanceIds)(onlyInitializedPlugins(plugins));
     return plugins;
 }
-exports.initPlugins = initPlugins;
+/**
+ * Runs the plugin constructors and returns their return values
+ * for all the site context plugins that do not return null to self-disable.
+ */
+async function initPlugins(context) {
+    const pluginConfigs = await (0, configs_1.loadPluginConfigs)(context);
+    const initPluginsConfigsResults = await initPluginsConfigs(context, pluginConfigs);
+    return onlyInitializedPlugins(initPluginsConfigsResults);
+}

package/lib/server/plugins/moduleShorthand.d.ts

@@ -4,6 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="node" />
 export declare function getNamePatterns(moduleName: string, moduleType: 'preset' | 'theme' | 'plugin'): string[];
 export declare function resolveModuleName(moduleName: string, moduleRequire: NodeRequire, moduleType: 'preset' | 'theme' | 'plugin'): string;

package/lib/server/plugins/moduleShorthand.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveModuleName = exports.getNamePatterns = void 0;
+exports.getNamePatterns = getNamePatterns;
+exports.resolveModuleName = resolveModuleName;
 function getNamePatterns(moduleName, moduleType) {
     if (moduleName.startsWith('@')) {
         // Pure scope: `@scope` => `@scope/docusaurus-plugin`
@@ -25,7 +26,6 @@ function getNamePatterns(moduleName, moduleType) {
         `docusaurus-${moduleType}-${moduleName}`,
     ];
 }
-exports.getNamePatterns = getNamePatterns;
 function resolveModuleName(moduleName, moduleRequire, moduleType) {
     const modulePatterns = getNamePatterns(moduleName, moduleType);
     const module = modulePatterns.find((m) => {
@@ -43,4 +43,3 @@ ${modulePatterns.map((m) => `- ${m}`).join('\n')}`);
     }
     return module;
 }
-exports.resolveModuleName = resolveModuleName;

package/lib/server/plugins/pluginIds.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureUniquePluginInstanceIds = void 0;
+exports.ensureUniquePluginInstanceIds = ensureUniquePluginInstanceIds;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
@@ -27,4 +27,3 @@ function ensureUniquePluginInstanceIds(plugins) {
         });
     });
 }
-exports.ensureUniquePluginInstanceIds = ensureUniquePluginInstanceIds;

package/lib/server/plugins/plugins.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reloadPlugin = exports.loadPlugins = void 0;
+exports.loadPlugins = loadPlugins;
+exports.reloadPlugin = reloadPlugin;
 const init_1 = require("./init");
 const synthetic_1 = require("./synthetic");
 const translations_1 = require("../translations/translations");
@@ -152,7 +153,6 @@ async function loadPlugins(context) {
         return { plugins, routes, globalData };
     });
 }
-exports.loadPlugins = loadPlugins;
 async function reloadPlugin({ pluginIdentifier, plugins: previousPlugins, context, }) {
     return utils_1.PerfLogger.async(`Reload plugin ${(0, pluginsUtils_1.formatPluginName)(pluginIdentifier)}`, async () => {
         const previousPlugin = (0, pluginsUtils_1.getPluginByIdentifier)({
@@ -184,4 +184,3 @@ async function reloadPlugin({ pluginIdentifier, plugins: previousPlugins, contex
         return { plugins, routes, globalData };
     });
 }
-exports.reloadPlugin = reloadPlugin;

package/lib/server/plugins/pluginsUtils.js

@@ -6,7 +6,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatPluginName = exports.mergeGlobalData = exports.aggregateGlobalData = exports.aggregateRoutes = exports.toPluginRoute = exports.aggregateAllContent = exports.getPluginByIdentifier = void 0;
+exports.getPluginByIdentifier = getPluginByIdentifier;
+exports.aggregateAllContent = aggregateAllContent;
+exports.toPluginRoute = toPluginRoute;
+exports.aggregateRoutes = aggregateRoutes;
+exports.aggregateGlobalData = aggregateGlobalData;
+exports.mergeGlobalData = mergeGlobalData;
+exports.formatPluginName = formatPluginName;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -17,7 +23,6 @@ function getPluginByIdentifier({ plugins, pluginIdentifier, }) {
     }
     return plugin;
 }
-exports.getPluginByIdentifier = getPluginByIdentifier;
 function aggregateAllContent(loadedPlugins) {
     return lodash_1.default.chain(loadedPlugins)
         .groupBy((item) => item.name)
@@ -27,15 +32,12 @@ function aggregateAllContent(loadedPlugins) {
         .value())
         .value();
 }
-exports.aggregateAllContent = aggregateAllContent;
 function toPluginRoute({ plugin, route, }) {
     return { plugin: { name: plugin.name, id: plugin.options.id }, ...route };
 }
-exports.toPluginRoute = toPluginRoute;
 function aggregateRoutes(loadedPlugins) {
     return loadedPlugins.flatMap((plugin) => plugin.routes.map((route) => toPluginRoute({ plugin, route })));
 }
-exports.aggregateRoutes = aggregateRoutes;
 function aggregateGlobalData(loadedPlugins) {
     const globalData = {};
     loadedPlugins.forEach((plugin) => {
@@ -47,7 +49,6 @@ function aggregateGlobalData(loadedPlugins) {
     });
     return globalData;
 }
-exports.aggregateGlobalData = aggregateGlobalData;
 function mergeGlobalData(...globalDataList) {
     const result = {};
     const allPluginIdentifiers = globalDataList.flatMap((gd) => Object.keys(gd).flatMap((name) => Object.keys(gd[name]).map((id) => ({ name, id }))));
@@ -61,7 +62,6 @@ function mergeGlobalData(...globalDataList) {
     });
     return result;
 }
-exports.mergeGlobalData = mergeGlobalData;
 // This is primarily useful for colored logging purpose
 // Do not rely on this for logic
 function formatPluginName(plugin) {
@@ -76,4 +76,3 @@ function formatPluginName(plugin) {
     const formattedId = logger_1.default.subdue(id);
     return `${formattedName}@${formattedId}`;
 }
-exports.formatPluginName = formatPluginName;

package/lib/server/plugins/presets.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadPresets = void 0;
+exports.loadPresets = loadPresets;
 const module_1 = require("module");
 const utils_1 = require("@docusaurus/utils");
 const moduleShorthand_1 = require("./moduleShorthand");
@@ -39,4 +39,3 @@ async function loadPresets(context) {
     const themes = loadedPresets.flatMap((preset) => preset.themes ?? []);
     return { plugins, themes };
 }
-exports.loadPresets = loadPresets;

package/lib/server/plugins/routeConfig.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sortRoutes = exports.applyRouteTrailingSlash = void 0;
+exports.applyRouteTrailingSlash = applyRouteTrailingSlash;
+exports.sortRoutes = sortRoutes;
 const utils_common_1 = require("@docusaurus/utils-common");
 /** Recursively applies trailing slash config to all nested routes. */
 function applyRouteTrailingSlash(route, params) {
@@ -18,7 +19,6 @@ function applyRouteTrailingSlash(route, params) {
         }),
     };
 }
-exports.applyRouteTrailingSlash = applyRouteTrailingSlash;
 function sortRoutes(routesToSort, baseUrl) {
     const routeConfigs = [...routesToSort];
     // Sort the route config. This ensures that route with nested
@@ -71,4 +71,3 @@ function sortRoutes(routesToSort, baseUrl) {
     });
     return routeConfigs;
 }
-exports.sortRoutes = sortRoutes;