@docusaurus/core 2.0.0-beta.17 → 2.0.0-beta.18

package/lib/server/client-modules/index.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 type { Plugin } from '@docusaurus/types';
-export default function loadClientModules(plugins: Plugin<unknown>[]): string[];
+import type { LoadedPlugin } from '@docusaurus/types';
+export default function loadClientModules(plugins: LoadedPlugin<unknown>[]): string[];

package/lib/server/client-modules/index.js

@@ -6,7 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
 function loadClientModules(plugins) {
-    return plugins.flatMap((plugin) => plugin.getClientModules?.() ?? []);
+    return plugins.flatMap((plugin) => plugin.getClientModules?.().map((p) => path_1.default.resolve(plugin.path, p)) ??
+        []);
 }
 exports.default = loadClientModules;

package/lib/server/config.js

@@ -15,7 +15,7 @@ async function loadConfig(configPath) {
         throw new Error(`Config file at "${configPath}" not found.`);
     }
     const importedConfig = (0, import_fresh_1.default)(configPath);
-    const loadedConfig = importedConfig instanceof Function
+    const loadedConfig = typeof importedConfig === 'function'
         ? await importedConfig()
         : await importedConfig;
     return (0, configValidation_1.validateConfig)(loadedConfig);

package/lib/server/configValidation.d.ts

@@ -7,6 +7,6 @@
 import type { DocusaurusConfig, I18nConfig } from '@docusaurus/types';
 import { Joi } from '@docusaurus/utils-validation';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
-export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories'>;
+export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories'>;
 export declare const ConfigSchema: Joi.ObjectSchema<any>;
 export declare function validateConfig(config: Partial<DocusaurusConfig>): DocusaurusConfig;

package/lib/server/configValidation.js

@@ -23,17 +23,22 @@ exports.DEFAULT_CONFIG = {
     plugins: [],
     themes: [],
     presets: [],
+    stylesheets: [],
+    scripts: [],
+    clientModules: [],
     customFields: {},
     themeConfig: {},
     titleDelimiter: '|',
     noIndex: false,
     tagline: '',
     baseUrlIssueBanner: true,
-    staticDirectories: [utils_1.STATIC_DIR_NAME],
+    staticDirectories: [utils_1.DEFAULT_STATIC_DIR_NAME],
 };
-function createPluginSchema(theme = false) {
+function createPluginSchema(theme) {
     return (utils_validation_1.Joi.alternatives()
-        .try(utils_validation_1.Joi.function(), utils_validation_1.Joi.array().ordered(utils_validation_1.Joi.function().required(), utils_validation_1.Joi.object().required()), utils_validation_1.Joi.string(), utils_validation_1.Joi.array()
+        .try(utils_validation_1.Joi.function(), utils_validation_1.Joi.array()
+        .ordered(utils_validation_1.Joi.function().required(), utils_validation_1.Joi.object().required())
+        .length(2), utils_validation_1.Joi.string(), utils_validation_1.Joi.array()
         .ordered(utils_validation_1.Joi.string().required(), utils_validation_1.Joi.object().required())
         .length(2), utils_validation_1.Joi.bool().equal(false))
         // @ts-expect-error: bad lib def, doesn't recognize an array of reports
@@ -69,7 +74,15 @@ ${validConfigExample}
 }
 const PluginSchema = createPluginSchema(false);
 const ThemeSchema = createPluginSchema(true);
-const PresetSchema = utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required(), utils_validation_1.Joi.object().required()).length(2));
+const PresetSchema = utils_validation_1.Joi.alternatives()
+    .try(utils_validation_1.Joi.string(), utils_validation_1.Joi.array()
+    .items(utils_validation_1.Joi.string().required(), utils_validation_1.Joi.object().required())
+    .length(2))
+    .messages({
+    'alternatives.types': `{#label} does not look like a valid preset config. A preset config entry should be one of:
+- A tuple of [presetName, options], like \`["classic", \\{ blog: false \\}]\`, or
+- A simple string, like \`"classic"\``,
+});
 const LocaleConfigSchema = utils_validation_1.Joi.object({
     label: utils_validation_1.Joi.string(),
     htmlLang: utils_validation_1.Joi.string(),
@@ -129,19 +142,31 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
     themes: utils_validation_1.Joi.array().items(ThemeSchema).default(exports.DEFAULT_CONFIG.themes),
     presets: utils_validation_1.Joi.array().items(PresetSchema).default(exports.DEFAULT_CONFIG.presets),
     themeConfig: utils_validation_1.Joi.object().unknown().default(exports.DEFAULT_CONFIG.themeConfig),
-    scripts: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
+    scripts: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
         src: utils_validation_1.Joi.string().required(),
         async: utils_validation_1.Joi.bool(),
         defer: utils_validation_1.Joi.bool(),
     })
         // See https://github.com/facebook/docusaurus/issues/3378
-        .unknown()),
+        .unknown())
+        .messages({
+        'array.includes': '{#label} is invalid. A script must be a plain string (the src), or an object with at least a "src" property.',
+    })
+        .default(exports.DEFAULT_CONFIG.scripts),
     ssrTemplate: utils_validation_1.Joi.string(),
-    stylesheets: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
+    stylesheets: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
         href: utils_validation_1.Joi.string().required(),
         type: utils_validation_1.Joi.string(),
-    }).unknown()),
-    clientModules: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()),
+    }).unknown())
+        .messages({
+        'array.includes': '{#label} is invalid. A stylesheet must be a plain string (the href), or an object with at least a "href" property.',
+    })
+        .default(exports.DEFAULT_CONFIG.stylesheets),
+    clientModules: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.string())
+        .default(exports.DEFAULT_CONFIG.clientModules),
     tagline: utils_validation_1.Joi.string().allow('').default(exports.DEFAULT_CONFIG.tagline),
     titleDelimiter: utils_validation_1.Joi.string().default('|'),
     noIndex: utils_validation_1.Joi.bool().default(false),

package/lib/server/duplicateRoutes.d.ts

@@ -5,6 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { ReportingSeverity, RouteConfig } from '@docusaurus/types';
-export declare function getAllDuplicateRoutes(pluginsRouteConfigs: RouteConfig[]): string[];
-export declare function getDuplicateRoutesMessage(allDuplicateRoutes: string[]): string;
 export declare function handleDuplicateRoutes(pluginsRouteConfigs: RouteConfig[], onDuplicateRoutes: ReportingSeverity): void;

package/lib/server/duplicateRoutes.js

@@ -6,28 +6,26 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleDuplicateRoutes = exports.getDuplicateRoutesMessage = exports.getAllDuplicateRoutes = void 0;
+exports.handleDuplicateRoutes = void 0;
 const utils_1 = require("@docusaurus/utils");
 const utils_2 = require("./utils");
 function getAllDuplicateRoutes(pluginsRouteConfigs) {
     const allRoutes = (0, utils_2.getAllFinalRoutes)(pluginsRouteConfigs).map((routeConfig) => routeConfig.path);
-    const seenRoutes = {};
+    const seenRoutes = new Set();
     return allRoutes.filter((route) => {
-        if (Object.prototype.hasOwnProperty.call(seenRoutes, route)) {
+        if (seenRoutes.has(route)) {
             return true;
         }
-        seenRoutes[route] = true;
+        seenRoutes.add(route);
         return false;
     });
 }
-exports.getAllDuplicateRoutes = getAllDuplicateRoutes;
 function getDuplicateRoutesMessage(allDuplicateRoutes) {
     const message = allDuplicateRoutes
-        .map((duplicateRoute) => `Attempting to create page at ${duplicateRoute}, but a page already exists at this route`)
+        .map((duplicateRoute) => `- Attempting to create page at ${duplicateRoute}, but a page already exists at this route.`)
         .join('\n');
     return message;
 }
-exports.getDuplicateRoutesMessage = getDuplicateRoutesMessage;
 function handleDuplicateRoutes(pluginsRouteConfigs, onDuplicateRoutes) {
     if (onDuplicateRoutes === 'ignore') {
         return;
@@ -35,7 +33,9 @@ function handleDuplicateRoutes(pluginsRouteConfigs, onDuplicateRoutes) {
     const duplicatePaths = getAllDuplicateRoutes(pluginsRouteConfigs);
     const message = getDuplicateRoutesMessage(duplicatePaths);
     if (message) {
-        const finalMessage = `Duplicate routes found!\n${message}\nThis could lead to non-deterministic routing behavior`;
+        const finalMessage = `Duplicate routes found!
+${message}
+This could lead to non-deterministic routing behavior.`;
         (0, utils_1.reportMessage)(finalMessage, onDuplicateRoutes);
     }
 }

package/lib/server/html-tags/htmlTags.js

@@ -24,7 +24,7 @@ function htmlTagObjectToString(tagDefinition) {
         throw new Error(`Error loading ${JSON.stringify(tagDefinition)}, "${tagDefinition.tagName}" is not a valid HTML tags.`);
     }
     const isVoidTag = void_1.default.indexOf(tagDefinition.tagName) !== -1;
-    const tagAttributes = tagDefinition.attributes || {};
+    const tagAttributes = tagDefinition.attributes ?? {};
     const attributes = Object.keys(tagAttributes)
         .filter((attributeName) => tagAttributes[attributeName] !== false)
         .map((attributeName) => {

package/lib/server/html-tags/index.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.
  */
-import type { InjectedHtmlTags, HtmlTags, LoadedPlugin } from '@docusaurus/types';
-export declare function createHtmlTagsString(tags: HtmlTags): string;
+import type { InjectedHtmlTags, LoadedPlugin } from '@docusaurus/types';
 export declare function loadHtmlTags(plugins: LoadedPlugin[]): InjectedHtmlTags;

package/lib/server/html-tags/index.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadHtmlTags = exports.createHtmlTagsString = void 0;
+exports.loadHtmlTags = void 0;
 const tslib_1 = require("tslib");
 const htmlTags_1 = tslib_1.__importDefault(require("./htmlTags"));
 function toString(val) {
@@ -15,13 +15,12 @@ function toString(val) {
 function createHtmlTagsString(tags) {
     return Array.isArray(tags) ? tags.map(toString).join('\n') : toString(tags);
 }
-exports.createHtmlTagsString = createHtmlTagsString;
 function loadHtmlTags(plugins) {
     const htmlTags = plugins.reduce((acc, plugin) => {
         if (!plugin.injectHtmlTags) {
             return acc;
         }
-        const { headTags, preBodyTags, postBodyTags } = plugin.injectHtmlTags({ content: plugin.content }) || {};
+        const { headTags, preBodyTags, postBodyTags } = plugin.injectHtmlTags({ content: plugin.content }) ?? {};
         return {
             headTags: headTags
                 ? `${acc.headTags}\n${createHtmlTagsString(headTags)}`

package/lib/server/i18n.d.ts

@@ -6,7 +6,7 @@
  */
 import type { I18n, DocusaurusConfig, I18nLocaleConfig } from '@docusaurus/types';
 export declare function getDefaultLocaleConfig(locale: string): I18nLocaleConfig;
-export declare function loadI18n(config: DocusaurusConfig, options?: {
+export declare function loadI18n(config: DocusaurusConfig, options: {
     locale?: string;
 }): Promise<I18n>;
 export declare function localizePath({ pathType, path: originalPath, i18n, options, }: {

package/lib/server/i18n.js

@@ -14,9 +14,6 @@ const rtl_detect_1 = require("rtl-detect");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 function getDefaultLocaleLabel(locale) {
     const languageName = new Intl.DisplayNames(locale, { type: 'language' }).of(locale);
-    if (!languageName) {
-        return locale;
-    }
     return (languageName.charAt(0).toLocaleUpperCase(locale) + languageName.substring(1));
 }
 function getDefaultLocaleConfig(locale) {
@@ -27,7 +24,7 @@ function getDefaultLocaleConfig(locale) {
     };
 }
 exports.getDefaultLocaleConfig = getDefaultLocaleConfig;
-async function loadI18n(config, options = {}) {
+async function loadI18n(config, options) {
     const { i18n: i18nConfig } = config;
     const currentLocale = options.locale ?? i18nConfig.defaultLocale;
     if (!i18nConfig.locales.includes(currentLocale)) {
@@ -64,10 +61,6 @@ function localizePath({ pathType, path: originalPath, i18n, options = {}, }) {
         return path_1.default.join(originalPath, i18n.currentLocale);
     }
     // Url paths; add a trailing slash so it's a valid base URL
-    if (pathType === 'url') {
-        return (0, utils_1.normalizeUrl)([originalPath, i18n.currentLocale, '/']);
-    }
-    // should never happen
-    throw new Error(`Unhandled path type "${pathType}".`);
+    return (0, utils_1.normalizeUrl)([originalPath, i18n.currentLocale, '/']);
 }
 exports.localizePath = localizePath;

package/lib/server/index.js

@@ -27,27 +27,20 @@ const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions
 const module_1 = require("module");
 const moduleShorthand_1 = require("./moduleShorthand");
 async function loadSiteConfig({ siteDir, customConfigFilePath, }) {
-    const siteConfigPathUnresolved = customConfigFilePath ?? utils_1.DEFAULT_CONFIG_FILE_NAME;
-    const siteConfigPath = path_1.default.isAbsolute(siteConfigPathUnresolved)
-        ? siteConfigPathUnresolved
-        : path_1.default.resolve(siteDir, siteConfigPathUnresolved);
+    const siteConfigPath = path_1.default.resolve(siteDir, customConfigFilePath ?? utils_1.DEFAULT_CONFIG_FILE_NAME);
     const siteConfig = await (0, config_1.default)(siteConfigPath);
     return { siteConfig, siteConfigPath };
 }
 exports.loadSiteConfig = loadSiteConfig;
 async function loadContext(siteDir, options = {}) {
     const { customOutDir, locale, customConfigFilePath } = options;
-    const generatedFilesDir = path_1.default.isAbsolute(utils_1.GENERATED_FILES_DIR_NAME)
-        ? utils_1.GENERATED_FILES_DIR_NAME
-        : path_1.default.resolve(siteDir, utils_1.GENERATED_FILES_DIR_NAME);
+    const generatedFilesDir = path_1.default.resolve(siteDir, utils_1.GENERATED_FILES_DIR_NAME);
     const { siteConfig: initialSiteConfig, siteConfigPath } = await loadSiteConfig({
         siteDir,
         customConfigFilePath,
     });
     const { ssrTemplate } = initialSiteConfig;
-    const baseOutDir = customOutDir
-        ? path_1.default.resolve(customOutDir)
-        : path_1.default.resolve(siteDir, utils_1.DEFAULT_BUILD_DIR_NAME);
+    const baseOutDir = path_1.default.resolve(siteDir, customOutDir ?? utils_1.DEFAULT_BUILD_DIR_NAME);
     const i18n = await (0, i18n_1.loadI18n)(initialSiteConfig, { locale });
     const baseUrl = (0, i18n_1.localizePath)({
         path: initialSiteConfig.baseUrl,
@@ -100,8 +93,8 @@ async function loadPluginConfigs(context) {
     }
     presetPlugins = presetPlugins.map((plugin) => normalizeShorthand(plugin, 'plugin'));
     presetThemes = presetThemes.map((theme) => normalizeShorthand(theme, 'theme'));
-    const standalonePlugins = (siteConfig.plugins || []).map((plugin) => normalizeShorthand(plugin, 'plugin'));
-    const standaloneThemes = (siteConfig.themes || []).map((theme) => normalizeShorthand(theme, 'theme'));
+    const standalonePlugins = siteConfig.plugins.map((plugin) => normalizeShorthand(plugin, 'plugin'));
+    const standaloneThemes = siteConfig.themes.map((theme) => normalizeShorthand(theme, 'theme'));
     return [
         ...presetPlugins,
         ...presetThemes,
@@ -114,13 +107,16 @@ exports.loadPluginConfigs = loadPluginConfigs;
 // Make a fake plugin to:
 // - Resolve aliased theme components
 // - Inject scripts/stylesheets
-function createBootstrapPlugin({ siteConfig, }) {
-    const { stylesheets = [], scripts = [], clientModules: siteConfigClientModules = [], } = siteConfig;
+function createBootstrapPlugin({ siteDir, siteConfig, }) {
+    const { stylesheets, scripts, clientModules: siteConfigClientModules, } = siteConfig;
     return {
         name: 'docusaurus-bootstrap-plugin',
         content: null,
-        options: {},
+        options: {
+            id: 'default',
+        },
         version: { type: 'synthetic' },
+        path: siteDir,
         getClientModules() {
             return siteConfigClientModules;
         },
@@ -158,8 +154,12 @@ function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
     return {
         name: 'docusaurus-mdx-fallback-plugin',
         content: null,
-        options: {},
+        options: {
+            id: 'default',
+        },
         version: { type: 'synthetic' },
+        // Synthetic, the path doesn't matter much
+        path: '.',
         configureWebpack(config, isServer, { getJSLoader }) {
             // We need the mdx fallback loader to exclude files that were already
             // processed by content plugins mdx loaders. This works, but a bit
@@ -184,7 +184,7 @@ function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
                                     options: {
                                         staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
                                         siteDir,
-                                        isMDXPartial: (_filename) => true,
+                                        isMDXPartial: () => true,
                                         isMDXPartialFrontMatterWarningDisabled: true,
                                         remarkPlugins: [remark_admonitions_1.default],
                                     },
@@ -208,6 +208,7 @@ async function load(siteDir, options = {}) {
     context.siteConfig.themeConfig = themeConfigTranslated;
     (0, duplicateRoutes_1.handleDuplicateRoutes)(pluginsRouteConfigs, siteConfig.onDuplicateRoutes);
     const genWarning = (0, utils_1.generate)(generatedFilesDir, '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.
@@ -215,29 +216,33 @@ next build. You can clear all build artifacts (including this folder) with the
     // Site config must be generated after plugins
     // We want the generated config to have been normalized by the plugins!
     const genSiteConfig = (0, utils_1.generate)(generatedFilesDir, utils_1.DEFAULT_CONFIG_FILE_NAME, `/*
-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)};`);
-    plugins.push(createBootstrapPlugin({ siteConfig }));
-    plugins.push(createMDXFallbackPlugin({ siteDir, siteConfig }));
+ * 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)};
+`);
+    plugins.push(createBootstrapPlugin({ siteDir, siteConfig }), createMDXFallbackPlugin({ siteDir, siteConfig }));
     // Load client modules.
     const clientModules = (0, client_modules_1.default)(plugins);
-    const genClientModules = (0, utils_1.generate)(generatedFilesDir, 'client-modules.js', `export default [\n${clientModules
+    const genClientModules = (0, utils_1.generate)(generatedFilesDir, 'client-modules.js', `export default [
+${clientModules
         // import() is async so we use require() because client modules can have
         // CSS and the order matters for loading CSS.
         .map((module) => `  require('${(0, utils_1.escapePath)(module)}'),`)
-        .join('\n')}\n];\n`);
+        .join('\n')}
+];
+`);
     // Load extra head & body html tags.
     const { headTags, preBodyTags, postBodyTags } = (0, html_tags_1.loadHtmlTags)(plugins);
     // Routing.
     const { registry, routesChunkNames, routesConfig, routesPaths } = await (0, routes_1.default)(pluginsRouteConfigs, baseUrl);
     const genRegistry = (0, utils_1.generate)(generatedFilesDir, 'registry.js', `export default {
-${Object.keys(registry)
-        .sort()
-        .map((key) => `  '${key}': [${registry[key].loader}, '${(0, utils_1.escapePath)(registry[key].modulePath)}', require.resolveWeak('${(0, utils_1.escapePath)(registry[key].modulePath)}')],`)
-        .join('\n')}};\n`);
+${Object.entries(registry)
+        .sort((a, b) => a[0].localeCompare(b[0]))
+        .map(([key, chunk]) => `  '${key}': [${chunk.loader}, '${(0, utils_1.escapePath)(chunk.modulePath)}', require.resolveWeak('${(0, utils_1.escapePath)(chunk.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));
@@ -293,7 +298,7 @@ ${Object.keys(registry)
     return props;
 }
 exports.load = load;
-// We want all @docusaurus/* packages  to have the exact same version!
+// We want all @docusaurus/* packages to have the exact same version!
 // See https://github.com/facebook/docusaurus/issues/3371
 // See https://github.com/facebook/docusaurus/pull/3386
 function checkDocusaurusPackagesVersion(siteMetadata) {

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

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { LoadContext, PluginConfig, RouteConfig, ThemeConfig, LoadedPlugin } from '@docusaurus/types';
+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[];
@@ -12,6 +12,6 @@ export declare function loadPlugins({ pluginConfigs, context, }: {
 }): Promise<{
     plugins: LoadedPlugin[];
     pluginsRouteConfigs: RouteConfig[];
-    globalData: unknown;
+    globalData: GlobalData;
     themeConfigTranslated: ThemeConfig;
 }>;

package/lib/server/plugins/index.js

@@ -60,7 +60,7 @@ async function loadPlugins({ pluginConfigs, context, }) {
     // 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 = plugin.loadContent ? await plugin.loadContent() : null;
+        const content = await plugin.loadContent?.();
         return { ...plugin, content };
     }));
     const contentLoadedTranslatedPlugins = await Promise.all(loadedPlugins.map(async (contentLoadedPlugin) => {
@@ -81,7 +81,7 @@ async function loadPlugins({ pluginConfigs, context, }) {
     const allContent = lodash_1.default.chain(loadedPlugins)
         .groupBy((item) => item.name)
         .mapValues((nameItems) => lodash_1.default.chain(nameItems)
-        .groupBy((item) => item.options.id ?? utils_1.DEFAULT_PLUGIN_ID)
+        .groupBy((item) => item.options.id)
         .mapValues((idItems) => idItems[0].content)
         .value())
         .value();
@@ -92,23 +92,36 @@ async function loadPlugins({ pluginConfigs, context, }) {
         if (!plugin.contentLoaded) {
             return;
         }
-        const pluginId = plugin.options.id ?? utils_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 createData = async (name, data) => {
+            const modulePath = path_1.default.join(dataDir, name);
+            await fs_extra_1.default.ensureDir(path_1.default.dirname(modulePath));
+            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);
-        };
-        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 (0, utils_1.generate)(dataDir, name, data);
-            return modulePath;
+            pluginsRouteConfigs.push({
+                ...finalRouteConfig,
+                modules: {
+                    ...finalRouteConfig.modules,
+                    __routeContextModule: pluginRouteContextModulePath,
+                },
+            });
         };
         // the plugins global data are namespaced to avoid data conflicts:
         // - by plugin name
@@ -135,13 +148,13 @@ async function loadPlugins({ pluginConfigs, context, }) {
     // 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
         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'}`;
-        return plugin.routesLoaded(pluginsRouteConfigs);
+        await plugin.routesLoaded(pluginsRouteConfigs);
     }));
     // Sort the route config. This ensures that route with nested
     // routes are always placed last.

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

@@ -4,7 +4,6 @@
  * 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" />
 import type { ImportedPluginModule, LoadContext, PluginModule, PluginConfig, PluginOptions, InitializedPlugin } from '@docusaurus/types';
 export declare type NormalizedPluginConfig = {
     plugin: PluginModule;
@@ -13,8 +12,13 @@ export declare type NormalizedPluginConfig = {
         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[], pluginRequire: NodeRequire): Promise<NormalizedPluginConfig[]>;
+export declare function normalizePluginConfigs(pluginConfigs: PluginConfig[], configPath: string): Promise<NormalizedPluginConfig[]>;
 export default function initPlugins({ pluginConfigs, context, }: {
     pluginConfigs: PluginConfig[];
     context: LoadContext;

package/lib/server/plugins/init.js

@@ -9,12 +9,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizePluginConfigs = void 0;
 const tslib_1 = require("tslib");
 const module_1 = require("module");
+const path_1 = tslib_1.__importDefault(require("path"));
 const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
 const utils_1 = require("@docusaurus/utils");
 const versions_1 = require("../versions");
 const pluginIds_1 = require("./pluginIds");
 const utils_validation_1 = require("@docusaurus/utils-validation");
-async function normalizePluginConfig(pluginConfig, pluginRequire) {
+async function normalizePluginConfig(pluginConfig, configPath) {
+    const pluginRequire = (0, module_1.createRequire)(configPath);
     // plugins: ['./plugin']
     if (typeof pluginConfig === 'string') {
         const pluginModuleImport = pluginConfig;
@@ -27,6 +29,7 @@ async function normalizePluginConfig(pluginConfig, pluginRequire) {
                 path: pluginModuleImport,
                 module: pluginModule,
             },
+            entryPath: pluginPath,
         };
     }
     // plugins: [function plugin() { }]
@@ -34,39 +37,37 @@ async 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 = (0, import_fresh_1.default)(pluginPath);
-            return {
-                plugin: pluginModule?.default ?? pluginModule,
-                options: pluginConfig[1] ?? {},
-                pluginModule: {
-                    path: pluginModuleImport,
-                    module: pluginModule,
-                },
-            };
-        }
-        // plugins: [
-        //   [function plugin() { },options],
-        // ]
-        if (typeof pluginConfig[0] === 'function') {
-            return {
-                plugin: pluginConfig[0],
-                options: pluginConfig[1] ?? {},
-            };
-        }
+    // 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: can't load plugin for following plugin config.\n${JSON.stringify(pluginConfig)}`);
+    // plugins: [
+    //   [function plugin() { },options],
+    // ]
+    return {
+        plugin: pluginConfig[0],
+        options: pluginConfig[1],
+        entryPath: configPath,
+    };
 }
-async function normalizePluginConfigs(pluginConfigs, pluginRequire) {
-    return Promise.all(pluginConfigs.map((pluginConfig) => normalizePluginConfig(pluginConfig, pluginRequire)));
+async function normalizePluginConfigs(pluginConfigs, configPath) {
+    return Promise.all(pluginConfigs.map((pluginConfig) => normalizePluginConfig(pluginConfig, configPath)));
 }
 exports.normalizePluginConfigs = normalizePluginConfigs;
 function getOptionValidationFunction(normalizedPluginConfig) {
@@ -89,7 +90,7 @@ 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, pluginRequire);
+    const pluginConfigsNormalized = await normalizePluginConfigs(pluginConfigs, context.siteConfigPath);
     async function doGetPluginVersion(normalizedPluginConfig) {
         // get plugin version
         if (normalizedPluginConfig.pluginModule?.path) {
@@ -136,14 +137,10 @@ async function initPlugins({ pluginConfigs, context, }) {
             ...pluginInstance,
             options: pluginOptions,
             version: pluginVersion,
+            path: path_1.default.dirname(normalizedPluginConfig.entryPath),
         };
     }
-    const plugins = (await Promise.all(pluginConfigsNormalized.map((pluginConfig) => {
-        if (!pluginConfig) {
-            return null;
-        }
-        return initializePlugin(pluginConfig);
-    }))).filter((item) => Boolean(item));
+    const plugins = await Promise.all(pluginConfigsNormalized.map(initializePlugin));
     (0, pluginIds_1.ensureUniquePluginInstanceIds)(plugins);
     return plugins;
 }