@docusaurus/core 2.0.0-beta.2 → 2.0.0-beta.22

package/lib/server/plugins/configs.js

@@ -0,0 +1,101 @@
+"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.loadPluginConfigs = void 0;
+const tslib_1 = require("tslib");
+const module_1 = require("module");
+const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
+const presets_1 = require("./presets");
+const moduleShorthand_1 = require("./moduleShorthand");
+async function normalizePluginConfig(pluginConfig, configPath, pluginRequire) {
+    // plugins: ["./plugin"]
+    if (typeof pluginConfig === 'string') {
+        const pluginModuleImport = pluginConfig;
+        const pluginPath = pluginRequire.resolve(pluginModuleImport);
+        const pluginModule = (0, import_fresh_1.default)(pluginPath);
+        return {
+            plugin: pluginModule.default ?? pluginModule,
+            options: {},
+            pluginModule: {
+                path: pluginModuleImport,
+                module: pluginModule,
+            },
+            entryPath: pluginPath,
+        };
+    }
+    // plugins: [() => {...}]
+    if (typeof pluginConfig === 'function') {
+        return {
+            plugin: pluginConfig,
+            options: {},
+            entryPath: configPath,
+        };
+    }
+    // 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,
+        };
+    }
+    // plugins: [
+    //   [() => {...}, options],
+    // ]
+    return {
+        plugin: pluginConfig[0],
+        options: pluginConfig[1],
+        entryPath: configPath,
+    };
+}
+/**
+ * Reads the site config's `presets`, `themes`, and `plugins`, imports them, and
+ * normalizes the return value. Plugin configs are ordered, mostly for theme
+ * alias shadowing. Site themes have the highest priority, and preset plugins
+ * are the lowest.
+ */
+async function loadPluginConfigs(context) {
+    const preset = await (0, presets_1.loadPresets)(context);
+    const { siteConfig, siteConfigPath } = context;
+    const pluginRequire = (0, module_1.createRequire)(siteConfigPath);
+    function normalizeShorthand(pluginConfig, pluginType) {
+        if (typeof pluginConfig === 'string') {
+            return (0, moduleShorthand_1.resolveModuleName)(pluginConfig, pluginRequire, pluginType);
+        }
+        else if (Array.isArray(pluginConfig) &&
+            typeof pluginConfig[0] === 'string') {
+            return [
+                (0, moduleShorthand_1.resolveModuleName)(pluginConfig[0], pluginRequire, pluginType),
+                pluginConfig[1] ?? {},
+            ];
+        }
+        return pluginConfig;
+    }
+    preset.plugins = preset.plugins.map((plugin) => normalizeShorthand(plugin, 'plugin'));
+    preset.themes = preset.themes.map((theme) => normalizeShorthand(theme, 'theme'));
+    const standalonePlugins = siteConfig.plugins.map((plugin) => normalizeShorthand(plugin, 'plugin'));
+    const standaloneThemes = siteConfig.themes.map((theme) => normalizeShorthand(theme, 'theme'));
+    const pluginConfigs = [
+        ...preset.plugins,
+        ...preset.themes,
+        // Site config should be the highest priority.
+        ...standalonePlugins,
+        ...standaloneThemes,
+    ].filter((x) => Boolean(x));
+    return Promise.all(pluginConfigs.map((pluginConfig) => normalizePluginConfig(pluginConfig, context.siteConfigPath, pluginRequire)));
+}
+exports.loadPluginConfigs = loadPluginConfigs;

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

@@ -4,14 +4,15 @@
  * 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, LoadedPlugin } from '@docusaurus/types';
-export declare function sortConfig(routeConfigs: RouteConfig[]): void;
-export declare function loadPlugins({ pluginConfigs, context, }: {
-    pluginConfigs: PluginConfig[];
-    context: LoadContext;
-}): Promise<{
+import type { LoadContext, RouteConfig, GlobalData, LoadedPlugin } from '@docusaurus/types';
+/**
+ * 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.
+ */
+export declare function loadPlugins(context: LoadContext): Promise<{
     plugins: LoadedPlugin[];
     pluginsRouteConfigs: RouteConfig[];
-    globalData: unknown;
-    themeConfigTranslated: ThemeConfig;
+    globalData: GlobalData;
 }>;

package/lib/server/plugins/index.js

@@ -6,162 +6,101 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadPlugins = exports.sortConfig = void 0;
+exports.loadPlugins = void 0;
 const tslib_1 = require("tslib");
-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 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 applyRouteTrailingSlash_1 = tslib_1.__importDefault(require("./applyRouteTrailingSlash"));
-function sortConfig(routeConfigs) {
-    // Sort the route config. This ensures that route with nested
-    // routes is always placed last.
-    routeConfigs.sort((a, b) => {
-        if (a.routes && !b.routes) {
-            return 1;
-        }
-        if (!a.routes && b.routes) {
-            return -1;
-        }
-        // Higher priority get placed first.
-        if (a.priority || b.priority) {
-            const priorityA = a.priority || 0;
-            const priorityB = b.priority || 0;
-            const score = priorityB - priorityA;
-            if (score !== 0) {
-                return score;
-            }
-        }
-        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));
-    });
-}
-exports.sortConfig = sortConfig;
-async function loadPlugins({ pluginConfigs, context, }) {
+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 = init_1.default({
-        pluginConfigs,
-        context,
-    });
+    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.
+    // 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 = plugin.loadContent ? await plugin.loadContent() : null;
-        return { ...plugin, content };
-    }));
-    const contentLoadedTranslatedPlugins = await Promise.all(loadedPlugins.map(async (contentLoadedPlugin) => {
-        var _a, _b;
-        const translationFiles = (_b = (await ((_a = contentLoadedPlugin === null || contentLoadedPlugin === void 0 ? void 0 : contentLoadedPlugin.getTranslationFiles) === null || _a === void 0 ? void 0 : _a.call(contentLoadedPlugin, {
-            content: contentLoadedPlugin.content,
-        })))) !== null && _b !== void 0 ? _b : [];
-        const localizedTranslationFiles = await Promise.all(translationFiles.map((translationFile) => translations_1.localizePluginTranslationFile({
-            locale: context.i18n.currentLocale,
-            siteDir: context.siteDir,
+        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: contentLoadedPlugin,
+            plugin,
         })));
-        return {
-            ...contentLoadedPlugin,
-            translationFiles: localizedTranslationFiles,
-        };
+        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.chain(loadedPlugins)
+    const allContent = lodash_1.default.chain(loadedPlugins)
         .groupBy((item) => item.name)
-        .mapValues((nameItems) => {
-        return lodash_1.chain(nameItems)
-            .groupBy((item) => { var _a; return (_a = item.options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID; })
-            .mapValues((idItems) => idItems[0].content)
-            .value();
-    })
+        .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 ({ content, translationFiles, ...plugin }) => {
-        var _a, _b, _c;
+    await Promise.all(loadedPlugins.map(async ({ content, ...plugin }) => {
         if (!plugin.contentLoaded) {
             return;
         }
-        const pluginId = (_a = plugin.options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_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 = (initialRouteConfig) => {
-            // Trailing slash behavior is handled in a generic way for all plugins
-            const finalRouteConfig = applyRouteTrailingSlash_1.default(initialRouteConfig, context.siteConfig.trailingSlash);
-            pluginsRouteConfigs.push(finalRouteConfig);
-        };
-        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);
-            return modulePath;
-        };
-        // 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][pluginId] = data;
+        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,
-            createData,
-            setGlobalData,
+            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;
+            },
         };
-        const translatedContent = (_c = (_b = plugin.translateContent) === null || _b === void 0 ? void 0 : _b.call(plugin, { content, translationFiles })) !== null && _c !== void 0 ? _c : content;
-        await plugin.contentLoaded({
-            content: translatedContent,
-            actions,
-            allContent,
-        });
-    }));
-    // 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) => {
-        if (!plugin.routesLoaded) {
-            return null;
-        }
-        // 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);
+        await plugin.contentLoaded({ content, actions, allContent });
     }));
     // Sort the route config. This ensures that route with nested
     // routes are always placed last.
-    sortConfig(pluginsRouteConfigs);
-    // Apply each plugin one after the other to translate the theme config
-    function translateThemeConfig(untranslatedThemeConfig) {
-        return contentLoadedTranslatedPlugins.reduce((currentThemeConfig, plugin) => {
-            var _a;
-            const translatedThemeConfigSlice = (_a = plugin.translateThemeConfig) === null || _a === void 0 ? void 0 : _a.call(plugin, {
-                themeConfig: currentThemeConfig,
-                translationFiles: plugin.translationFiles,
-            });
-            return {
-                ...currentThemeConfig,
-                ...translatedThemeConfigSlice,
-            };
-        }, untranslatedThemeConfig);
-    }
-    return {
-        plugins: loadedPlugins,
-        pluginsRouteConfigs,
-        globalData,
-        themeConfigTranslated: translateThemeConfig(context.siteConfig.themeConfig),
-    };
+    (0, routeConfig_1.sortConfig)(pluginsRouteConfigs, context.siteConfig.baseUrl);
+    return { plugins: loadedPlugins, pluginsRouteConfigs, globalData };
 }
 exports.loadPlugins = loadPlugins;

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

@@ -4,8 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { LoadContext, PluginConfig, InitializedPlugin } from '@docusaurus/types';
-export default function initPlugins({ pluginConfigs, context, }: {
-    pluginConfigs: PluginConfig[];
-    context: LoadContext;
-}): InitializedPlugin[];
+import type { LoadContext, InitializedPlugin } from '@docusaurus/types';
+/**
+ * Runs the plugin constructors and returns their return values. It would load
+ * plugin configs from `plugins`, `themes`, and `presets`.
+ */
+export declare function initPlugins(context: LoadContext): Promise<InitializedPlugin[]>;

package/lib/server/plugins/init.js

@@ -6,102 +6,46 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.initPlugins = void 0;
 const tslib_1 = require("tslib");
-const module_1 = tslib_1.__importDefault(require("module"));
-const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
-const constants_1 = require("../../constants");
-const versions_1 = require("../versions");
-const pluginIds_1 = require("./pluginIds");
+const module_1 = require("module");
+const path_1 = tslib_1.__importDefault(require("path"));
+const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
-function normalizePluginConfig(pluginConfig, pluginRequire) {
-    var _a, _b, _c, _d;
-    // plugins: ['./plugin']
-    if (typeof pluginConfig === 'string') {
-        const pluginModuleImport = pluginConfig;
-        const pluginPath = pluginRequire.resolve(pluginModuleImport);
-        const pluginModule = import_fresh_1.default(pluginPath);
-        return {
-            plugin: (_a = pluginModule === null || pluginModule === void 0 ? void 0 : pluginModule.default) !== null && _a !== void 0 ? _a : pluginModule,
-            options: {},
-            pluginModule: {
-                path: pluginModuleImport,
-                module: pluginModule,
-            },
-        };
-    }
-    // plugins: [function plugin() { }]
-    if (typeof pluginConfig === 'function') {
-        return {
-            plugin: pluginConfig,
-            options: {},
-        };
-    }
-    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 : {},
-            };
-        }
-    }
-    throw new Error(`Unexpected: can't load plugin for following plugin config.\n${JSON.stringify(pluginConfig)}`);
-}
+const siteMetadata_1 = require("../siteMetadata");
+const pluginIds_1 = require("./pluginIds");
+const configs_1 = require("./configs");
 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;
+        // Support both CommonJS and ES modules
+        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;
+        // Support both CommonJS and ES modules
+        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;
-        // 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' };
+/**
+ * Runs the plugin constructors and returns their return values. It would load
+ * plugin configs from `plugins`, `themes`, and `presets`.
+ */
+async function initPlugins(context) {
+    // 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 doGetPluginVersion(normalizedPluginConfig) {
+        if (normalizedPluginConfig.pluginModule?.path) {
+            const pluginPath = pluginRequire.resolve(normalizedPluginConfig.pluginModule.path);
+            return (0, siteMetadata_1.getPluginVersion)(pluginPath, context.siteDir);
         }
+        return { type: 'local' };
     }
     function doValidateThemeConfig(normalizedPluginConfig) {
         const validateThemeConfig = getThemeValidationFunction(normalizedPluginConfig);
@@ -111,12 +55,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 +65,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(pluginConfigs.map(initializePlugin));
+    (0, pluginIds_1.ensureUniquePluginInstanceIds)(plugins);
     return plugins;
 }
-exports.default = initPlugins;
+exports.initPlugins = initPlugins;

package/lib/server/plugins/moduleShorthand.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.
+ */
+/// <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

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

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