@docusaurus/core 0.0.0-5089 → 0.0.0-5091

package/lib/commands/start.js

@@ -24,7 +24,6 @@ const server_1 = require("../server");
 const client_1 = tslib_1.__importDefault(require("../webpack/client"));
 const utils_2 = require("../webpack/utils");
 const getHostPort_1 = require("../server/getHostPort");
-const translations_1 = require("../server/translations/translations");
 async function start(siteDir, cliOptions) {
     process.env.NODE_ENV = 'development';
     process.env.BABEL_ENV = 'development';
@@ -61,7 +60,7 @@ async function start(siteDir, cliOptions) {
             logger_1.default.error(err.stack);
         });
     }, 500);
-    const { siteConfig, plugins } = props;
+    const { siteConfig, plugins, localizationDir } = props;
     const normalizeToSiteDir = (filepath) => {
         if (filepath && path_1.default.isAbsolute(filepath)) {
             return (0, utils_1.posixPath)(path_1.default.relative(siteDir, filepath));
@@ -72,14 +71,7 @@ async function start(siteDir, cliOptions) {
         .flatMap((plugin) => plugin.getPathsToWatch?.() ?? [])
         .filter(Boolean)
         .map(normalizeToSiteDir);
-    const pathsToWatch = [
-        ...pluginPaths,
-        props.siteConfigPath,
-        (0, translations_1.getTranslationsLocaleDirPath)({
-            siteDir,
-            locale: props.i18n.currentLocale,
-        }),
-    ];
+    const pathsToWatch = [...pluginPaths, props.siteConfigPath, localizationDir];
     const pollingOptions = {
         usePolling: !!cliOptions.poll,
         interval: Number.isInteger(cliOptions.poll)

package/lib/commands/writeTranslations.js

@@ -30,7 +30,7 @@ async function getExtraSourceCodeFilePaths() {
         return []; // User may not use a Docusaurus official theme? Quite unlikely...
     }
 }
-async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }) {
+async function writePluginTranslationFiles({ localizationDir, plugin, options, }) {
     if (plugin.getTranslationFiles) {
         const content = await plugin.loadContent?.();
         const translationFiles = await plugin.getTranslationFiles({
@@ -38,10 +38,9 @@ async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }
         });
         await Promise.all(translationFiles.map(async (translationFile) => {
             await (0, translations_1.writePluginTranslations)({
-                siteDir,
+                localizationDir,
                 plugin,
                 translationFile,
-                locale,
                 options,
             });
         }));
@@ -53,6 +52,7 @@ async function writeTranslations(siteDir, options) {
         config: options.config,
         locale: options.locale,
     });
+    const { localizationDir } = context;
     const plugins = await (0, init_1.initPlugins)(context);
     const locale = options.locale ?? context.i18n.defaultLocale;
     if (!context.i18n.locales.includes(locale)) {
@@ -69,9 +69,9 @@ Available locales are: ${context.i18n.locales.join(',')}.`);
         extractedCodeTranslations,
         defaultCodeMessages,
     });
-    await (0, translations_1.writeCodeTranslations)({ siteDir, locale }, codeTranslations, options);
+    await (0, translations_1.writeCodeTranslations)({ localizationDir }, codeTranslations, options);
     await Promise.all(plugins.map(async (plugin) => {
-        await writePluginTranslationFiles({ siteDir, plugin, locale, options });
+        await writePluginTranslationFiles({ localizationDir, plugin, options });
     }));
 }
 exports.writeTranslations = writeTranslations;

package/lib/server/configValidation.js

@@ -12,6 +12,7 @@ const utils_validation_1 = require("@docusaurus/utils-validation");
 const DEFAULT_I18N_LOCALE = 'en';
 exports.DEFAULT_I18N_CONFIG = {
     defaultLocale: DEFAULT_I18N_LOCALE,
+    path: utils_1.DEFAULT_I18N_DIR_NAME,
     locales: [DEFAULT_I18N_LOCALE],
     localeConfigs: {},
 };
@@ -91,6 +92,7 @@ const LocaleConfigSchema = utils_validation_1.Joi.object({
 });
 const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     defaultLocale: utils_validation_1.Joi.string().required(),
+    path: utils_validation_1.Joi.string().default(exports.DEFAULT_I18N_CONFIG.path),
     locales: utils_validation_1.Joi.array().items().min(1).items(utils_validation_1.Joi.string().required()).required(),
     localeConfigs: utils_validation_1.Joi.object()
         .pattern(/.*/, LocaleConfigSchema)

package/lib/server/i18n.js

@@ -44,6 +44,7 @@ Note: Docusaurus only support running one locale at a time.`;
     return {
         defaultLocale: i18nConfig.defaultLocale,
         locales,
+        path: i18nConfig.path,
         currentLocale,
         localeConfigs,
     };

package/lib/server/index.js

@@ -46,15 +46,15 @@ async function loadContext(options) {
         pathType: 'fs',
     });
     const siteConfig = { ...initialSiteConfig, baseUrl };
-    const codeTranslationFileContent = (await (0, translations_1.readCodeTranslationFileContent)({
-        siteDir,
-        locale: i18n.currentLocale,
-    })) ?? {};
+    // TODO allow customizing localizationDir per-locale
+    const localizationDir = path_1.default.resolve(siteDir, i18n.path, i18n.currentLocale);
+    const codeTranslationFileContent = (await (0, translations_1.readCodeTranslationFileContent)({ localizationDir })) ?? {};
     // We only need key->message for code translations
     const codeTranslations = lodash_1.default.mapValues(codeTranslationFileContent, (value) => value.message);
     return {
         siteDir,
         generatedFilesDir,
+        localizationDir,
         siteConfig,
         siteConfigPath,
         outDir,
@@ -73,7 +73,7 @@ exports.loadContext = loadContext;
 async function load(options) {
     const { siteDir } = options;
     const context = await loadContext(options);
-    const { generatedFilesDir, siteConfig, siteConfigPath, outDir, baseUrl, i18n, codeTranslations: siteCodeTranslations, } = context;
+    const { generatedFilesDir, siteConfig, siteConfigPath, outDir, baseUrl, i18n, localizationDir, codeTranslations: siteCodeTranslations, } = context;
     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);
@@ -137,6 +137,7 @@ ${Object.entries(registry)
         outDir,
         baseUrl,
         i18n,
+        localizationDir,
         generatedFilesDir,
         routes: pluginsRouteConfigs,
         routesPaths,

package/lib/server/plugins/index.js

@@ -35,8 +35,7 @@ async function loadPlugins(context) {
         const content = await plugin.loadContent?.();
         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,
+            localizationDir: context.localizationDir,
             translationFile,
             plugin,
         })));

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

@@ -10,18 +10,16 @@ export declare type WriteTranslationsOptions = {
     messagePrefix?: string;
 };
 declare type TranslationContext = {
-    siteDir: string;
-    locale: string;
+    localizationDir: string;
 };
-export declare function getTranslationsLocaleDirPath(context: TranslationContext): string;
 export declare function readCodeTranslationFileContent(context: TranslationContext): Promise<TranslationFileContent | undefined>;
 export declare function writeCodeTranslations(context: TranslationContext, content: TranslationFileContent, options: WriteTranslationsOptions): Promise<void>;
-export declare function writePluginTranslations({ siteDir, plugin, locale, translationFile, options, }: TranslationContext & {
+export declare function writePluginTranslations({ localizationDir, plugin, translationFile, options, }: TranslationContext & {
     plugin: InitializedPlugin;
     translationFile: TranslationFile;
     options?: WriteTranslationsOptions;
 }): Promise<void>;
-export declare function localizePluginTranslationFile({ siteDir, plugin, locale, translationFile, }: TranslationContext & {
+export declare function localizePluginTranslationFile({ localizationDir, plugin, translationFile, }: TranslationContext & {
     plugin: InitializedPlugin;
     translationFile: TranslationFile;
 }): Promise<TranslationFile>;

package/lib/server/translations/translations.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyDefaultCodeTranslations = exports.getPluginsDefaultCodeTranslationMessages = exports.localizePluginTranslationFile = exports.writePluginTranslations = exports.writeCodeTranslations = exports.readCodeTranslationFileContent = exports.getTranslationsLocaleDirPath = void 0;
+exports.applyDefaultCodeTranslations = exports.getPluginsDefaultCodeTranslationMessages = exports.localizePluginTranslationFile = exports.writePluginTranslations = exports.writeCodeTranslations = exports.readCodeTranslationFileContent = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
@@ -79,13 +79,8 @@ Maybe you should remove them? ${unknownKeys}`;
         await fs_extra_1.default.outputFile(filePath, `${JSON.stringify(mergedContent, null, 2)}\n`);
     }
 }
-// Should we make this configurable?
-function getTranslationsLocaleDirPath(context) {
-    return path_1.default.join(context.siteDir, utils_1.I18N_DIR_NAME, context.locale);
-}
-exports.getTranslationsLocaleDirPath = getTranslationsLocaleDirPath;
 function getCodeTranslationsFilePath(context) {
-    return path_1.default.join(getTranslationsLocaleDirPath(context), utils_1.CODE_TRANSLATIONS_FILE_NAME);
+    return path_1.default.join(context.localizationDir, utils_1.CODE_TRANSLATIONS_FILE_NAME);
 }
 async function readCodeTranslationFileContent(context) {
     return readTranslationFileContent(getCodeTranslationsFilePath(context));
@@ -108,21 +103,19 @@ function addTranslationFileExtension(translationFilePath) {
     }
     return `${translationFilePath}.json`;
 }
-function getPluginTranslationFilePath({ siteDir, plugin, locale, translationFilePath, }) {
+function getPluginTranslationFilePath({ localizationDir, plugin, translationFilePath, }) {
     const dirPath = (0, utils_1.getPluginI18nPath)({
-        siteDir,
-        locale,
+        localizationDir,
         pluginName: plugin.name,
         pluginId: plugin.options.id,
     });
     const filePath = addTranslationFileExtension(translationFilePath);
     return path_1.default.join(dirPath, filePath);
 }
-async function writePluginTranslations({ siteDir, plugin, locale, translationFile, options, }) {
+async function writePluginTranslations({ localizationDir, plugin, translationFile, options, }) {
     const filePath = getPluginTranslationFilePath({
         plugin,
-        siteDir,
-        locale,
+        localizationDir,
         translationFilePath: translationFile.path,
     });
     await writeTranslationFileContent({
@@ -132,11 +125,10 @@ async function writePluginTranslations({ siteDir, plugin, locale, translationFil
     });
 }
 exports.writePluginTranslations = writePluginTranslations;
-async function localizePluginTranslationFile({ siteDir, plugin, locale, translationFile, }) {
+async function localizePluginTranslationFile({ localizationDir, plugin, translationFile, }) {
     const filePath = getPluginTranslationFilePath({
         plugin,
-        siteDir,
-        locale,
+        localizationDir,
         translationFilePath: translationFile.path,
     });
     const localizedContent = await readTranslationFileContent(filePath);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-5089",
+  "version": "0.0.0-5091",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,13 +43,13 @@
     "@babel/runtime": "^7.18.3",
     "@babel/runtime-corejs3": "^7.18.3",
     "@babel/traverse": "^7.18.2",
-    "@docusaurus/cssnano-preset": "0.0.0-5089",
-    "@docusaurus/logger": "0.0.0-5089",
-    "@docusaurus/mdx-loader": "0.0.0-5089",
+    "@docusaurus/cssnano-preset": "0.0.0-5091",
+    "@docusaurus/logger": "0.0.0-5091",
+    "@docusaurus/mdx-loader": "0.0.0-5091",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-5089",
-    "@docusaurus/utils-common": "0.0.0-5089",
-    "@docusaurus/utils-validation": "0.0.0-5089",
+    "@docusaurus/utils": "0.0.0-5091",
+    "@docusaurus/utils-common": "0.0.0-5091",
+    "@docusaurus/utils-validation": "0.0.0-5091",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.7",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.7",
@@ -107,8 +107,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5089",
-    "@docusaurus/types": "0.0.0-5089",
+    "@docusaurus/module-type-aliases": "0.0.0-5091",
+    "@docusaurus/types": "0.0.0-5091",
     "@types/detect-port": "^1.3.2",
     "@types/react-dom": "^18.0.5",
     "@types/react-router-config": "^5.0.6",
@@ -128,5 +128,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "f03215790788b609224a7d79e123fdfb3ecdb717"
+  "gitHead": "9f79f0eb7547d40c08306a72a3617806f2e6f2bd"
 }