@docusaurus/core 2.0.0-beta.15d451942 → 2.0.0-beta.18

package/lib/server/moduleShorthand.js

@@ -0,0 +1,46 @@
+"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.resolveModuleName = exports.getNamePatterns = void 0;
+function getNamePatterns(moduleName, moduleType) {
+    if (moduleName.startsWith('@')) {
+        // Pure scope: `@scope` => `@scope/docusaurus-plugin`
+        if (!moduleName.includes('/')) {
+            return [`${moduleName}/docusaurus-${moduleType}`];
+        }
+        const [scope, packageName] = moduleName.split(/\/(?<rest>.*)/);
+        return [
+            `${scope}/${packageName}`,
+            `${scope}/docusaurus-${moduleType}-${packageName}`,
+        ];
+    }
+    return [
+        moduleName,
+        `@docusaurus/${moduleType}-${moduleName}`,
+        `docusaurus-${moduleType}-${moduleName}`,
+    ];
+}
+exports.getNamePatterns = getNamePatterns;
+function resolveModuleName(moduleName, moduleRequire, moduleType) {
+    const modulePatterns = getNamePatterns(moduleName, moduleType);
+    const module = modulePatterns.find((m) => {
+        try {
+            moduleRequire.resolve(m);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    });
+    if (!module) {
+        throw new Error(`Docusaurus was unable to resolve the "${moduleName}" ${moduleType}. Make sure one of the following packages are installed:
+${modulePatterns.map((m) => `- ${m}`).join('\n')}`);
+    }
+    return module;
+}
+exports.resolveModuleName = resolveModuleName;

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

@@ -0,0 +1,9 @@
+/**
+ * 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 { RouteConfig } from '@docusaurus/types';
+import { type ApplyTrailingSlashParams } from '@docusaurus/utils-common';
+export default function applyRouteTrailingSlash(route: RouteConfig, params: ApplyTrailingSlashParams): RouteConfig;

package/lib/server/plugins/applyRouteTrailingSlash.js

@@ -0,0 +1,19 @@
+"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 utils_common_1 = require("@docusaurus/utils-common");
+function applyRouteTrailingSlash(route, params) {
+    return {
+        ...route,
+        path: (0, utils_common_1.applyTrailingSlash)(route.path, params),
+        ...(route.routes && {
+            routes: route.routes.map((subroute) => applyRouteTrailingSlash(subroute, params)),
+        }),
+    };
+}
+exports.default = applyRouteTrailingSlash;

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

@@ -4,15 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { LoadContext, PluginConfig, RouteConfig, ThemeConfig } from '@docusaurus/types';
-import { InitPlugin } from './init';
-export declare function sortConfig(routeConfigs: RouteConfig[]): void;
+import type { LoadContext, PluginConfig, RouteConfig, GlobalData, ThemeConfig, LoadedPlugin } from '@docusaurus/types';
+export declare function sortConfig(routeConfigs: RouteConfig[], baseUrl?: string): void;
 export declare function loadPlugins({ pluginConfigs, context, }: {
     pluginConfigs: PluginConfig[];
     context: LoadContext;
 }): Promise<{
-    plugins: InitPlugin[];
+    plugins: LoadedPlugin[];
     pluginsRouteConfigs: RouteConfig[];
-    globalData: unknown;
+    globalData: GlobalData;
     themeConfigTranslated: ThemeConfig;
 }>;

package/lib/server/plugins/index.js

@@ -12,14 +12,21 @@ const utils_1 = require("@docusaurus/utils");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const init_1 = tslib_1.__importDefault(require("./init"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const constants_1 = require("../../constants");
-const lodash_1 = require("lodash");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const translations_1 = require("../translations/translations");
-function sortConfig(routeConfigs) {
+const applyRouteTrailingSlash_1 = tslib_1.__importDefault(require("./applyRouteTrailingSlash"));
+function sortConfig(routeConfigs, baseUrl = '/') {
     // Sort the route config. This ensures that route with nested
     // routes is always placed last.
     routeConfigs.sort((a, b) => {
+        // Root route should get placed last.
+        if (a.path === baseUrl && b.path !== baseUrl) {
+            return 1;
+        }
+        if (a.path !== baseUrl && b.path === baseUrl) {
+            return -1;
+        }
         if (a.routes && !b.routes) {
             return 1;
         }
@@ -38,71 +45,89 @@ function sortConfig(routeConfigs) {
         return a.path.localeCompare(b.path);
     });
     routeConfigs.forEach((routeConfig) => {
-        var _a;
-        (_a = routeConfig.routes) === null || _a === void 0 ? void 0 : _a.sort((a, b) => a.path.localeCompare(b.path));
+        routeConfig.routes?.sort((a, b) => a.path.localeCompare(b.path));
     });
 }
 exports.sortConfig = sortConfig;
 async function loadPlugins({ pluginConfigs, context, }) {
     // 1. Plugin Lifecycle - Initialization/Constructor.
-    const plugins = init_1.default({
+    const plugins = await (0, init_1.default)({
         pluginConfigs,
         context,
     });
-    const contentLoadedPlugins = await Promise.all(plugins.map(async (plugin) => {
-        const content = plugin.loadContent ? await plugin.loadContent() : null;
-        return { plugin, content };
+    // 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.
+    const loadedPlugins = await Promise.all(plugins.map(async (plugin) => {
+        const content = await plugin.loadContent?.();
+        return { ...plugin, content };
     }));
-    const contentLoadedTranslatedPlugins = await Promise.all(contentLoadedPlugins.map(async (contentLoadedPlugin) => {
-        var _a, _b, _c;
-        const translationFiles = (_c = (await ((_b = (_a = contentLoadedPlugin.plugin) === null || _a === void 0 ? void 0 : _a.getTranslationFiles) === null || _b === void 0 ? void 0 : _b.call(_a, {
+    const contentLoadedTranslatedPlugins = await Promise.all(loadedPlugins.map(async (contentLoadedPlugin) => {
+        const translationFiles = (await contentLoadedPlugin?.getTranslationFiles?.({
             content: contentLoadedPlugin.content,
-        })))) !== null && _c !== void 0 ? _c : [];
-        const localizedTranslationFiles = await Promise.all(translationFiles.map((translationFile) => translations_1.localizePluginTranslationFile({
+        })) ?? [];
+        const localizedTranslationFiles = await Promise.all(translationFiles.map((translationFile) => (0, translations_1.localizePluginTranslationFile)({
             locale: context.i18n.currentLocale,
             siteDir: context.siteDir,
             translationFile,
-            plugin: contentLoadedPlugin.plugin,
+            plugin: contentLoadedPlugin,
         })));
         return {
             ...contentLoadedPlugin,
             translationFiles: localizedTranslationFiles,
         };
     }));
-    const allContent = lodash_1.chain(contentLoadedPlugins)
-        .groupBy((item) => item.plugin.name)
-        .mapValues((nameItems) => {
-        return lodash_1.chain(nameItems)
-            .groupBy((item) => { var _a; return (_a = item.plugin.options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID; })
-            .mapValues((idItems) => idItems[0].content)
-            .value();
-    })
+    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(contentLoadedTranslatedPlugins.map(async ({ plugin, content, translationFiles }) => {
-        var _a, _b, _c;
+    await Promise.all(contentLoadedTranslatedPlugins.map(async ({ content, translationFiles, ...plugin }) => {
         if (!plugin.contentLoaded) {
             return;
         }
-        const pluginId = (_a = plugin.options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID;
+        const pluginId = plugin.options.id;
         // plugins data files are namespaced by pluginName/pluginId
         const dataDirRoot = path_1.default.join(context.generatedFilesDir, plugin.name);
         const dataDir = path_1.default.join(dataDirRoot, pluginId);
-        const addRoute = (config) => pluginsRouteConfigs.push(config);
         const createData = async (name, data) => {
             const modulePath = path_1.default.join(dataDir, name);
             await fs_extra_1.default.ensureDir(path_1.default.dirname(modulePath));
-            await utils_1.generate(dataDir, name, data);
+            await (0, utils_1.generate)(dataDir, name, data);
             return modulePath;
         };
+        // TODO this would be better to do all that in the codegen phase
+        // TODO handle context for nested routes
+        const pluginRouteContext = {
+            plugin: { name: plugin.name, id: pluginId },
+            data: undefined, // TODO allow plugins to provide context data
+        };
+        const pluginRouteContextModulePath = await createData(`${(0, utils_1.docuHash)('pluginRouteContextModule')}.json`, JSON.stringify(pluginRouteContext, null, 2));
+        const addRoute = (initialRouteConfig) => {
+            // Trailing slash behavior is handled in a generic way for all plugins
+            const finalRouteConfig = (0, applyRouteTrailingSlash_1.default)(initialRouteConfig, {
+                trailingSlash: context.siteConfig.trailingSlash,
+                baseUrl: context.siteConfig.baseUrl,
+            });
+            pluginsRouteConfigs.push({
+                ...finalRouteConfig,
+                modules: {
+                    ...finalRouteConfig.modules,
+                    __routeContextModule: pluginRouteContextModulePath,
+                },
+            });
+        };
         // the plugins global data are namespaced to avoid data conflicts:
         // - by plugin name
         // - by plugin id (allow using multiple instances of the same plugin)
         const setGlobalData = (data) => {
-            var _a;
-            globalData[plugin.name] = (_a = globalData[plugin.name]) !== null && _a !== void 0 ? _a : {};
+            globalData[plugin.name] = globalData[plugin.name] ?? {};
             globalData[plugin.name][pluginId] = data;
         };
         const actions = {
@@ -110,7 +135,7 @@ async function loadPlugins({ pluginConfigs, context, }) {
             createData,
             setGlobalData,
         };
-        const translatedContent = (_c = (_b = plugin.translateContent) === null || _b === void 0 ? void 0 : _b.call(plugin, { content, translationFiles })) !== null && _c !== void 0 ? _c : content;
+        const translatedContent = plugin.translateContent?.({ content, translationFiles }) ?? content;
         await plugin.contentLoaded({
             content: translatedContent,
             actions,
@@ -118,29 +143,28 @@ async function loadPlugins({ pluginConfigs, context, }) {
         });
     }));
     // 4. Plugin Lifecycle - routesLoaded.
-    // 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.
-    await Promise.all(contentLoadedTranslatedPlugins.map(async ({ plugin }) => {
+    // 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.
+    await Promise.all(contentLoadedTranslatedPlugins.map(async (plugin) => {
         if (!plugin.routesLoaded) {
-            return null;
+            return;
         }
         // TODO remove this deprecated lifecycle soon
         // deprecated since alpha-60
         // TODO, 1 user reported usage of this lifecycle! https://github.com/facebook/docusaurus/issues/3918
-        console.error(chalk_1.default.red('plugin routesLoaded lifecycle is deprecated. If you think we should keep this lifecycle, please report here: https://github.com/facebook/docusaurus/issues/3918'));
-        return plugin.routesLoaded(pluginsRouteConfigs);
+        logger_1.default.error `Plugin code=${'routesLoaded'} lifecycle is deprecated. If you think we should keep this lifecycle, please report here: path=${'https://github.com/facebook/docusaurus/issues/3918'}`;
+        await plugin.routesLoaded(pluginsRouteConfigs);
     }));
     // Sort the route config. This ensures that route with nested
     // routes are always placed last.
-    sortConfig(pluginsRouteConfigs);
+    sortConfig(pluginsRouteConfigs, context.siteConfig.baseUrl);
     // Apply each plugin one after the other to translate the theme config
     function translateThemeConfig(untranslatedThemeConfig) {
-        return contentLoadedTranslatedPlugins.reduce((currentThemeConfig, { plugin, translationFiles }) => {
-            var _a;
-            const translatedThemeConfigSlice = (_a = plugin.translateThemeConfig) === null || _a === void 0 ? void 0 : _a.call(plugin, {
+        return contentLoadedTranslatedPlugins.reduce((currentThemeConfig, plugin) => {
+            const translatedThemeConfigSlice = plugin.translateThemeConfig?.({
                 themeConfig: currentThemeConfig,
-                translationFiles,
+                translationFiles: plugin.translationFiles,
             });
             return {
                 ...currentThemeConfig,
@@ -149,7 +173,7 @@ async function loadPlugins({ pluginConfigs, context, }) {
         }, untranslatedThemeConfig);
     }
     return {
-        plugins,
+        plugins: loadedPlugins,
         pluginsRouteConfigs,
         globalData,
         themeConfigTranslated: translateThemeConfig(context.siteConfig.themeConfig),

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

@@ -4,12 +4,22 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { DocusaurusPluginVersionInformation, LoadContext, Plugin, PluginConfig, PluginOptions } from '@docusaurus/types';
-export declare type InitPlugin = Plugin<unknown> & {
-    readonly options: PluginOptions;
-    readonly version: DocusaurusPluginVersionInformation;
+import type { ImportedPluginModule, LoadContext, PluginModule, PluginConfig, PluginOptions, InitializedPlugin } from '@docusaurus/types';
+export declare type NormalizedPluginConfig = {
+    plugin: PluginModule;
+    options: PluginOptions;
+    pluginModule?: {
+        path: string;
+        module: ImportedPluginModule;
+    };
+    /**
+     * Different from pluginModule.path, this one is always an absolute path used
+     * to resolve relative paths returned from lifecycles
+     */
+    entryPath: string;
 };
+export declare function normalizePluginConfigs(pluginConfigs: PluginConfig[], configPath: string): Promise<NormalizedPluginConfig[]>;
 export default function initPlugins({ pluginConfigs, context, }: {
     pluginConfigs: PluginConfig[];
     context: LoadContext;
-}): InitPlugin[];
+}): Promise<InitializedPlugin[]>;

package/lib/server/plugins/init.js

@@ -6,27 +6,30 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePluginConfigs = void 0;
 const tslib_1 = require("tslib");
-const module_1 = tslib_1.__importDefault(require("module"));
+const module_1 = require("module");
+const path_1 = tslib_1.__importDefault(require("path"));
 const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
-const constants_1 = require("../../constants");
+const utils_1 = require("@docusaurus/utils");
 const versions_1 = require("../versions");
 const pluginIds_1 = require("./pluginIds");
 const utils_validation_1 = require("@docusaurus/utils-validation");
-function normalizePluginConfig(pluginConfig, pluginRequire) {
-    var _a, _b, _c, _d;
+async function normalizePluginConfig(pluginConfig, configPath) {
+    const pluginRequire = (0, module_1.createRequire)(configPath);
     // plugins: ['./plugin']
     if (typeof pluginConfig === 'string') {
         const pluginModuleImport = pluginConfig;
         const pluginPath = pluginRequire.resolve(pluginModuleImport);
-        const pluginModule = import_fresh_1.default(pluginPath);
+        const pluginModule = (0, import_fresh_1.default)(pluginPath);
         return {
-            plugin: (_a = pluginModule === null || pluginModule === void 0 ? void 0 : pluginModule.default) !== null && _a !== void 0 ? _a : pluginModule,
+            plugin: pluginModule?.default ?? pluginModule,
             options: {},
             pluginModule: {
                 path: pluginModuleImport,
                 module: pluginModule,
             },
+            entryPath: pluginPath,
         };
     }
     // plugins: [function plugin() { }]
@@ -34,74 +37,67 @@ function normalizePluginConfig(pluginConfig, pluginRequire) {
         return {
             plugin: pluginConfig,
             options: {},
+            entryPath: configPath,
         };
     }
-    if (Array.isArray(pluginConfig)) {
-        // plugins: [
-        //   ['./plugin',options],
-        // ]
-        if (typeof pluginConfig[0] === 'string') {
-            const pluginModuleImport = pluginConfig[0];
-            const pluginPath = pluginRequire.resolve(pluginModuleImport);
-            const pluginModule = import_fresh_1.default(pluginPath);
-            return {
-                plugin: (_b = pluginModule === null || pluginModule === void 0 ? void 0 : pluginModule.default) !== null && _b !== void 0 ? _b : pluginModule,
-                options: (_c = pluginConfig[1]) !== null && _c !== void 0 ? _c : {},
-                pluginModule: {
-                    path: pluginModuleImport,
-                    module: pluginModule,
-                },
-            };
-        }
-        // plugins: [
-        //   [function plugin() { },options],
-        // ]
-        if (typeof pluginConfig[0] === 'function') {
-            return {
-                plugin: pluginConfig[0],
-                options: (_d = pluginConfig[1]) !== null && _d !== void 0 ? _d : {},
-            };
-        }
+    // plugins: [
+    //   ['./plugin',options],
+    // ]
+    if (typeof pluginConfig[0] === 'string') {
+        const pluginModuleImport = pluginConfig[0];
+        const pluginPath = pluginRequire.resolve(pluginModuleImport);
+        const pluginModule = (0, import_fresh_1.default)(pluginPath);
+        return {
+            plugin: pluginModule?.default ?? pluginModule,
+            options: pluginConfig[1],
+            pluginModule: {
+                path: pluginModuleImport,
+                module: pluginModule,
+            },
+            entryPath: pluginPath,
+        };
     }
-    throw new Error(`Unexpected: cant load plugin for plugin config = ${JSON.stringify(pluginConfig)}`);
+    // plugins: [
+    //   [function plugin() { },options],
+    // ]
+    return {
+        plugin: pluginConfig[0],
+        options: pluginConfig[1],
+        entryPath: configPath,
+    };
+}
+async function normalizePluginConfigs(pluginConfigs, configPath) {
+    return Promise.all(pluginConfigs.map((pluginConfig) => normalizePluginConfig(pluginConfig, configPath)));
 }
+exports.normalizePluginConfigs = normalizePluginConfigs;
 function getOptionValidationFunction(normalizedPluginConfig) {
-    var _a, _b, _c, _d;
     if (normalizedPluginConfig.pluginModule) {
         // support both commonjs and ES modules
-        return ((_c = (_b = (_a = normalizedPluginConfig.pluginModule.module) === null || _a === void 0 ? void 0 : _a.default) === null || _b === void 0 ? void 0 : _b.validateOptions) !== null && _c !== void 0 ? _c : (_d = normalizedPluginConfig.pluginModule.module) === null || _d === void 0 ? void 0 : _d.validateOptions);
-    }
-    else {
-        return normalizedPluginConfig.plugin.validateOptions;
+        return (normalizedPluginConfig.pluginModule.module?.default?.validateOptions ??
+            normalizedPluginConfig.pluginModule.module?.validateOptions);
     }
+    return normalizedPluginConfig.plugin.validateOptions;
 }
 function getThemeValidationFunction(normalizedPluginConfig) {
-    var _a, _b;
     if (normalizedPluginConfig.pluginModule) {
         // support both commonjs and ES modules
-        return ((_b = (_a = normalizedPluginConfig.pluginModule.module.default) === null || _a === void 0 ? void 0 : _a.validateThemeConfig) !== null && _b !== void 0 ? _b : normalizedPluginConfig.pluginModule.module.validateThemeConfig);
-    }
-    else {
-        return normalizedPluginConfig.plugin.validateThemeConfig;
+        return (normalizedPluginConfig.pluginModule.module.default?.validateThemeConfig ??
+            normalizedPluginConfig.pluginModule.module.validateThemeConfig);
     }
+    return normalizedPluginConfig.plugin.validateThemeConfig;
 }
-function initPlugins({ pluginConfigs, context, }) {
-    // We need to resolve plugins from the perspective of the siteDir, since the siteDir's package.json
-    // declares the dependency on these plugins.
-    // We need to fallback to createRequireFromPath since createRequire is only available in node v12.
-    // See: https://nodejs.org/api/modules.html#modules_module_createrequire_filename
-    const createRequire = module_1.default.createRequire || module_1.default.createRequireFromPath;
-    const pluginRequire = createRequire(context.siteConfigPath);
-    function doGetPluginVersion(normalizedPluginConfig) {
-        var _a, _b;
+async function initPlugins({ pluginConfigs, context, }) {
+    // We need to resolve plugins from the perspective of the siteDir, since the
+    // siteDir's package.json declares the dependency on these plugins.
+    const pluginRequire = (0, module_1.createRequire)(context.siteConfigPath);
+    const pluginConfigsNormalized = await normalizePluginConfigs(pluginConfigs, context.siteConfigPath);
+    async function doGetPluginVersion(normalizedPluginConfig) {
         // get plugin version
-        if ((_a = normalizedPluginConfig.pluginModule) === null || _a === void 0 ? void 0 : _a.path) {
-            const pluginPath = pluginRequire.resolve((_b = normalizedPluginConfig.pluginModule) === null || _b === void 0 ? void 0 : _b.path);
-            return versions_1.getPluginVersion(pluginPath, context.siteDir);
-        }
-        else {
-            return { type: 'local' };
+        if (normalizedPluginConfig.pluginModule?.path) {
+            const pluginPath = pluginRequire.resolve(normalizedPluginConfig.pluginModule?.path);
+            return (0, versions_1.getPluginVersion)(pluginPath, context.siteDir);
         }
+        return { type: 'local' };
     }
     function doValidateThemeConfig(normalizedPluginConfig) {
         const validateThemeConfig = getThemeValidationFunction(normalizedPluginConfig);
@@ -111,12 +107,9 @@ function initPlugins({ pluginConfigs, context, }) {
                 themeConfig: context.siteConfig.themeConfig,
             });
         }
-        else {
-            return context.siteConfig.themeConfig;
-        }
+        return context.siteConfig.themeConfig;
     }
     function doValidatePluginOptions(normalizedPluginConfig) {
-        var _a;
         const validateOptions = getOptionValidationFunction(normalizedPluginConfig);
         if (validateOptions) {
             return validateOptions({
@@ -124,37 +117,31 @@ function initPlugins({ pluginConfigs, context, }) {
                 options: normalizedPluginConfig.options,
             });
         }
-        else {
-            // Important to ensure all plugins have an id
-            // as we don't go through the Joi schema that adds it
-            return {
-                ...normalizedPluginConfig.options,
-                id: (_a = normalizedPluginConfig.options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID,
-            };
-        }
+        // Important to ensure all plugins have an id
+        // as we don't go through the Joi schema that adds it
+        return {
+            ...normalizedPluginConfig.options,
+            id: normalizedPluginConfig.options.id ?? utils_1.DEFAULT_PLUGIN_ID,
+        };
     }
-    const plugins = pluginConfigs
-        .map((pluginConfig) => {
-        if (!pluginConfig) {
-            return null;
-        }
-        const normalizedPluginConfig = normalizePluginConfig(pluginConfig, pluginRequire);
-        const pluginVersion = doGetPluginVersion(normalizedPluginConfig);
+    async function initializePlugin(normalizedPluginConfig) {
+        const pluginVersion = await doGetPluginVersion(normalizedPluginConfig);
         const pluginOptions = doValidatePluginOptions(normalizedPluginConfig);
         // Side-effect: merge the normalized theme config in the original one
         context.siteConfig.themeConfig = {
             ...context.siteConfig.themeConfig,
             ...doValidateThemeConfig(normalizedPluginConfig),
         };
-        const pluginInstance = normalizedPluginConfig.plugin(context, pluginOptions);
+        const pluginInstance = await normalizedPluginConfig.plugin(context, pluginOptions);
         return {
             ...pluginInstance,
             options: pluginOptions,
             version: pluginVersion,
+            path: path_1.default.dirname(normalizedPluginConfig.entryPath),
         };
-    })
-        .filter((item) => Boolean(item));
-    pluginIds_1.ensureUniquePluginInstanceIds(plugins);
+    }
+    const plugins = await Promise.all(pluginConfigsNormalized.map(initializePlugin));
+    (0, pluginIds_1.ensureUniquePluginInstanceIds)(plugins);
     return plugins;
 }
 exports.default = initPlugins;

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

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { InitPlugin } from './init';
-export declare function ensureUniquePluginInstanceIds(plugins: InitPlugin[]): void;
+import type { InitializedPlugin } from '@docusaurus/types';
+export declare function ensureUniquePluginInstanceIds(plugins: InitializedPlugin[]): void;

package/lib/server/plugins/pluginIds.js

@@ -7,17 +7,20 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureUniquePluginInstanceIds = void 0;
-const lodash_1 = require("lodash");
-const constants_1 = require("../../constants");
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
 // It is forbidden to have 2 plugins of the same name sharing the same id
 // this is required to support multi-instance plugins without conflict
 function ensureUniquePluginInstanceIds(plugins) {
-    const pluginsByName = lodash_1.groupBy(plugins, (p) => p.name);
+    const pluginsByName = lodash_1.default.groupBy(plugins, (p) => p.name);
     Object.entries(pluginsByName).forEach(([pluginName, pluginInstances]) => {
-        const pluginInstancesById = lodash_1.groupBy(pluginInstances, (p) => { var _a; return (_a = p.options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID; });
+        const pluginInstancesById = lodash_1.default.groupBy(pluginInstances, (p) => p.options.id ?? utils_1.DEFAULT_PLUGIN_ID);
         Object.entries(pluginInstancesById).forEach(([pluginId, pluginInstancesWithId]) => {
             if (pluginInstancesWithId.length !== 1) {
-                throw new Error(`Plugin ${pluginName} is used ${pluginInstancesWithId.length} times with id=${pluginId}.\nTo use the same plugin multiple times on a Docusaurus site, you need to assign a unique id to each plugin instance.`);
+                throw new Error(`Plugin "${pluginName}" is used ${pluginInstancesWithId.length} times with ID "${pluginId}".\nTo use the same plugin multiple times on a Docusaurus site, you need to assign a unique ID to each plugin instance.${pluginId === utils_1.DEFAULT_PLUGIN_ID
+                    ? `\n\nThe plugin ID is "${utils_1.DEFAULT_PLUGIN_ID}" by default. It's possible that the preset you are using already includes a plugin instance, in which case you either want to disable the plugin in the preset (to use a single instance), or assign another ID to your extra plugin instance (to use multiple instances).`
+                    : ''}`);
             }
         });
     });

package/lib/server/presets/index.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { LoadContext, PluginConfig } from '@docusaurus/types';
-export default function loadPresets(context: LoadContext): {
+import type { LoadContext, PluginConfig } from '@docusaurus/types';
+export default function loadPresets(context: LoadContext): Promise<{
     plugins: PluginConfig[];
     themes: PluginConfig[];
-};
+}>;