@docusaurus/core 0.0.0-4807 → 0.0.0-4812

package/lib/server/index.js

@@ -76,9 +76,7 @@ async function load(options) {
     const { siteDir } = options;
     const context = await loadContext(options);
     const { generatedFilesDir, siteConfig, siteConfigPath, outDir, baseUrl, i18n, ssrTemplate, codeTranslations: siteCodeTranslations, } = context;
-    const { plugins, pluginsRouteConfigs, globalData, themeConfigTranslated } = await (0, plugins_1.loadPlugins)(context);
-    // Side-effect to replace the untranslated themeConfig by the translated one
-    context.siteConfig.themeConfig = themeConfigTranslated;
+    const { plugins, pluginsRouteConfigs, globalData } = await (0, plugins_1.loadPlugins)(context);
     const clientModules = (0, clientModules_1.loadClientModules)(plugins);
     const { headTags, preBodyTags, postBodyTags } = (0, htmlTags_1.loadHtmlTags)(plugins);
     const { registry, routesChunkNames, routesConfig, routesPaths } = await (0, routes_1.loadRoutes)(pluginsRouteConfigs, baseUrl, siteConfig.onDuplicateRoutes);

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

@@ -4,15 +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 type { LoadContext, RouteConfig, GlobalData, ThemeConfig, LoadedPlugin } from '@docusaurus/types';
+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.
+ * 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: GlobalData;
-    themeConfigTranslated: ThemeConfig;
 }>;

package/lib/server/plugins/index.js

@@ -19,7 +19,8 @@ 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.
+ * 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.
@@ -29,24 +30,27 @@ async function loadPlugins(context) {
     // Currently plugins run lifecycle methods in parallel and are not
     // order-dependent. We could change this in future if there are plugins which
     // need to run in certain order or depend on others for data.
+    // This would also translate theme config and content upfront, given the
+    // translation files that the plugin declares.
     const loadedPlugins = await Promise.all(plugins.map(async (plugin) => {
         const content = await plugin.loadContent?.();
-        return { ...plugin, content };
-    }));
-    const contentLoadedTranslatedPlugins = await Promise.all(loadedPlugins.map(async (plugin) => {
-        const translationFiles = (await plugin?.getTranslationFiles?.({
-            content: plugin.content,
-        })) ?? [];
-        const localizedTranslationFiles = await Promise.all(translationFiles.map((translationFile) => (0, translations_1.localizePluginTranslationFile)({
+        const rawTranslationFiles = (await plugin?.getTranslationFiles?.({ content })) ?? [];
+        const translationFiles = await Promise.all(rawTranslationFiles.map((translationFile) => (0, translations_1.localizePluginTranslationFile)({
             locale: context.i18n.currentLocale,
             siteDir: context.siteDir,
             translationFile,
             plugin,
         })));
-        return {
-            ...plugin,
-            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.default.chain(loadedPlugins)
         .groupBy((item) => item.name)
@@ -58,7 +62,7 @@ async function loadPlugins(context) {
     // 3. Plugin Lifecycle - contentLoaded.
     const pluginsRouteConfigs = [];
     const globalData = {};
-    await Promise.all(contentLoadedTranslatedPlugins.map(async ({ content, translationFiles, ...plugin }) => {
+    await Promise.all(loadedPlugins.map(async ({ content, ...plugin }) => {
         if (!plugin.contentLoaded) {
             return;
         }
@@ -96,43 +100,21 @@ async function loadPlugins(context) {
                 globalData[plugin.name][pluginId] = data;
             },
         };
-        const translatedContent = plugin.translateContent?.({ content, translationFiles }) ?? content;
-        await plugin.contentLoaded({
-            content: translatedContent,
-            actions,
-            allContent,
-        });
+        await plugin.contentLoaded({ content, actions, allContent });
     }));
     // 4. Plugin Lifecycle - routesLoaded.
-    await Promise.all(contentLoadedTranslatedPlugins.map(async (plugin) => {
+    await Promise.all(loadedPlugins.map(async (plugin) => {
         if (!plugin.routesLoaded) {
             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
+        // TODO alpha-60: remove this deprecated lifecycle soon
+        // 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: url=${'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.
     (0, routeConfig_1.sortConfig)(pluginsRouteConfigs, context.siteConfig.baseUrl);
-    // Apply each plugin one after the other to translate the theme config
-    const themeConfigTranslated = contentLoadedTranslatedPlugins.reduce((currentThemeConfig, plugin) => {
-        const translatedThemeConfigSlice = plugin.translateThemeConfig?.({
-            themeConfig: currentThemeConfig,
-            translationFiles: plugin.translationFiles,
-        });
-        return {
-            ...currentThemeConfig,
-            ...translatedThemeConfigSlice,
-        };
-    }, context.siteConfig.themeConfig);
-    return {
-        plugins: loadedPlugins,
-        pluginsRouteConfigs,
-        globalData,
-        themeConfigTranslated,
-    };
+    return { plugins: loadedPlugins, pluginsRouteConfigs, globalData };
 }
 exports.loadPlugins = loadPlugins;

package/lib/server/translations/translations.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 { TranslationFileContent, TranslationFile, TranslationMessage, InitializedPlugin } from '@docusaurus/types';
+import type { TranslationFileContent, TranslationFile, CodeTranslations, InitializedPlugin } from '@docusaurus/types';
 export declare type WriteTranslationsOptions = {
     override?: boolean;
     messagePrefix?: string;
@@ -25,17 +25,9 @@ export declare function localizePluginTranslationFile({ siteDir, plugin, locale,
     plugin: InitializedPlugin;
     translationFile: TranslationFile;
 }): Promise<TranslationFile>;
-export declare function getPluginsDefaultCodeTranslationMessages(plugins: InitializedPlugin[]): Promise<{
-    [msgId: string]: string;
-}>;
+export declare function getPluginsDefaultCodeTranslationMessages(plugins: InitializedPlugin[]): Promise<CodeTranslations>;
 export declare function applyDefaultCodeTranslations({ extractedCodeTranslations, defaultCodeMessages, }: {
-    extractedCodeTranslations: {
-        [msgId: string]: TranslationMessage;
-    };
-    defaultCodeMessages: {
-        [msgId: string]: string;
-    };
-}): {
-    [msgId: string]: TranslationMessage;
-};
+    extractedCodeTranslations: TranslationFileContent;
+    defaultCodeMessages: CodeTranslations;
+}): TranslationFileContent;
 export {};

package/lib/server/translations/translationsExtractor.d.ts

@@ -5,14 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { type TransformOptions } from '@babel/core';
-import type { InitializedPlugin, TranslationFileContent, TranslationMessage } from '@docusaurus/types';
+import type { InitializedPlugin, TranslationFileContent } from '@docusaurus/types';
 export declare function globSourceCodeFilePaths(dirPaths: string[]): Promise<string[]>;
 export declare function extractSiteSourceCodeTranslations(siteDir: string, plugins: InitializedPlugin[], babelOptions: TransformOptions, extraSourceCodeFilePaths?: string[]): Promise<TranslationFileContent>;
 declare type SourceCodeFileTranslations = {
     sourceCodeFilePath: string;
-    translations: {
-        [msgId: string]: TranslationMessage;
-    };
+    translations: TranslationFileContent;
     warnings: string[];
 };
 export declare function extractAllSourceCodeFileTranslations(sourceCodeFilePaths: string[], babelOptions: TransformOptions): Promise<SourceCodeFileTranslations[]>;

package/lib/webpack/aliases/index.d.ts

@@ -24,6 +24,4 @@ export declare function loadThemeAliases({ siteDir, plugins, }: {
  * instead of naively aliasing this to `client/exports`, we use fine-grained
  * aliases instead.
  */
-export declare function loadDocusaurusAliases(): Promise<{
-    [aliasName: string]: string;
-}>;
+export declare function loadDocusaurusAliases(): Promise<ThemeAliases>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4807",
+  "version": "0.0.0-4812",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.8",
     "@babel/runtime-corejs3": "^7.17.8",
     "@babel/traverse": "^7.17.3",
-    "@docusaurus/cssnano-preset": "0.0.0-4807",
-    "@docusaurus/logger": "0.0.0-4807",
-    "@docusaurus/mdx-loader": "0.0.0-4807",
+    "@docusaurus/cssnano-preset": "0.0.0-4812",
+    "@docusaurus/logger": "0.0.0-4812",
+    "@docusaurus/mdx-loader": "0.0.0-4812",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4807",
-    "@docusaurus/utils-common": "0.0.0-4807",
-    "@docusaurus/utils-validation": "0.0.0-4807",
+    "@docusaurus/utils": "0.0.0-4812",
+    "@docusaurus/utils-common": "0.0.0-4812",
+    "@docusaurus/utils-validation": "0.0.0-4812",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.4",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.4",
@@ -105,8 +105,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4807",
-    "@docusaurus/types": "0.0.0-4807",
+    "@docusaurus/module-type-aliases": "0.0.0-4812",
+    "@docusaurus/types": "0.0.0-4812",
     "@types/detect-port": "^1.3.2",
     "@types/nprogress": "^0.2.0",
     "@types/react-dom": "^17.0.14",
@@ -127,5 +127,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "9bb0a5cc35908e3d1ab5e8b3840180990c0e1e05"
+  "gitHead": "7b54ca31ae70170874768f01443d6c9b6256054c"
 }