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

package/lib/server/themes/alias.js

@@ -6,34 +6,43 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortAliases = void 0;
 const tslib_1 = require("tslib");
-const globby_1 = tslib_1.__importDefault(require("globby"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const utils_1 = require("@docusaurus/utils");
-const lodash_1 = require("lodash");
-function themeAlias(themePath, addOriginalAlias) {
-    if (!fs_extra_1.default.pathExistsSync(themePath)) {
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+// Order of Webpack aliases is important because one alias can shadow another
+// This ensure @theme/NavbarItem alias is after @theme/NavbarItem/LocaleDropdown
+// See https://github.com/facebook/docusaurus/pull/3922
+// See https://github.com/facebook/docusaurus/issues/5382
+function sortAliases(aliases) {
+    // Alphabetical order by default
+    const entries = lodash_1.default.sortBy(Object.entries(aliases), ([alias]) => alias);
+    // @theme/NavbarItem should be after @theme/NavbarItem/LocaleDropdown
+    entries.sort(([alias1], [alias2]) => alias1.includes(`${alias2}/`) ? -1 : 0);
+    return Object.fromEntries(entries);
+}
+exports.sortAliases = sortAliases;
+async function themeAlias(themePath, addOriginalAlias) {
+    if (!(await fs_extra_1.default.pathExists(themePath))) {
         return {};
     }
-    const themeComponentFiles = globby_1.default.sync(['**/*.{js,jsx,ts,tsx}'], {
+    const themeComponentFiles = await (0, utils_1.Globby)(['**/*.{js,jsx,ts,tsx}'], {
         cwd: themePath,
     });
-    // See https://github.com/facebook/docusaurus/pull/3922
-    // ensure @theme/NavbarItem alias is created after @theme/NavbarItem/LocaleDropdown
-    const sortedThemeComponentFiles = lodash_1.sortBy(themeComponentFiles, (file) => file.endsWith('/index.js'));
     const aliases = {};
-    sortedThemeComponentFiles.forEach((relativeSource) => {
+    themeComponentFiles.forEach((relativeSource) => {
         const filePath = path_1.default.join(themePath, relativeSource);
-        const fileName = utils_1.fileToPath(relativeSource);
-        const aliasName = utils_1.posixPath(utils_1.normalizeUrl(['@theme', fileName]).replace(/\/$/, ''));
+        const fileName = (0, utils_1.fileToPath)(relativeSource);
+        const aliasName = (0, utils_1.posixPath)((0, utils_1.normalizeUrl)(['@theme', fileName]).replace(/\/$/, ''));
         aliases[aliasName] = filePath;
         if (addOriginalAlias) {
             // For swizzled components to access the original.
-            const originalAliasName = utils_1.posixPath(utils_1.normalizeUrl(['@theme-original', fileName]).replace(/\/$/, ''));
+            const originalAliasName = (0, utils_1.posixPath)((0, utils_1.normalizeUrl)(['@theme-original', fileName]).replace(/\/$/, ''));
             aliases[originalAliasName] = filePath;
         }
     });
-    return aliases;
+    return sortAliases(aliases);
 }
 exports.default = themeAlias;

package/lib/server/themes/index.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 { ThemeAlias } from '@docusaurus/types';
-export default function loadThemeAlias(themePaths: string[], userThemePaths?: string[]): ThemeAlias;
+import type { ThemeAliases, LoadedPlugin } from '@docusaurus/types';
+export declare function loadThemeAliases(themePaths: string[], userThemePaths: string[]): Promise<ThemeAliases>;
+export declare function loadPluginsThemeAliases({ siteDir, plugins, }: {
+    siteDir: string;
+    plugins: LoadedPlugin[];
+}): Promise<ThemeAliases>;

package/lib/server/themes/index.js

@@ -6,30 +6,42 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadPluginsThemeAliases = exports.loadThemeAliases = void 0;
 const tslib_1 = require("tslib");
-const alias_1 = tslib_1.__importDefault(require("./alias"));
-function buildThemeAliases(themeAliases, aliases = {}) {
-    Object.keys(themeAliases).forEach((aliasKey) => {
-        if (aliasKey in aliases) {
-            const componentName = aliasKey.substring(aliasKey.indexOf('/') + 1);
-            // eslint-disable-next-line no-param-reassign
-            aliases[`@theme-init/${componentName}`] = aliases[aliasKey];
-        }
-        // eslint-disable-next-line no-param-reassign
-        aliases[aliasKey] = themeAliases[aliasKey];
-    });
-    return aliases;
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const utils_1 = require("@docusaurus/utils");
+const alias_1 = (0, tslib_1.__importStar)(require("./alias"));
+const ThemeFallbackDir = path_1.default.resolve(__dirname, '../../client/theme-fallback');
+async function loadThemeAliases(themePaths, userThemePaths) {
+    const aliases = {};
+    for (const themePath of themePaths) {
+        const themeAliases = await (0, alias_1.default)(themePath, true);
+        Object.keys(themeAliases).forEach((aliasKey) => {
+            // If this alias shadows a previous one, use @theme-init to preserve the
+            // initial one. @theme-init is only applied once: to the initial theme
+            // that provided this component
+            if (aliasKey in aliases) {
+                const componentName = aliasKey.substring(aliasKey.indexOf('/') + 1);
+                const initAlias = `@theme-init/${componentName}`;
+                if (!(initAlias in aliases)) {
+                    aliases[initAlias] = aliases[aliasKey];
+                }
+            }
+            aliases[aliasKey] = themeAliases[aliasKey];
+        });
+    }
+    for (const themePath of userThemePaths) {
+        const userThemeAliases = await (0, alias_1.default)(themePath, false);
+        Object.assign(aliases, userThemeAliases);
+    }
+    return (0, alias_1.sortAliases)(aliases);
 }
-function loadThemeAlias(themePaths, userThemePaths = []) {
-    let aliases = {};
-    themePaths.forEach((themePath) => {
-        const themeAliases = alias_1.default(themePath, true);
-        aliases = { ...aliases, ...buildThemeAliases(themeAliases, aliases) };
-    });
-    userThemePaths.forEach((themePath) => {
-        const userThemeAliases = alias_1.default(themePath, false);
-        aliases = { ...aliases, ...buildThemeAliases(userThemeAliases, aliases) };
-    });
-    return aliases;
+exports.loadThemeAliases = loadThemeAliases;
+function loadPluginsThemeAliases({ siteDir, plugins, }) {
+    const pluginThemes = plugins
+        .map((plugin) => (plugin.getThemePath ? plugin.getThemePath() : undefined))
+        .filter((x) => Boolean(x));
+    const userTheme = path_1.default.resolve(siteDir, utils_1.THEME_PATH);
+    return loadThemeAliases([ThemeFallbackDir, ...pluginThemes], [userTheme]);
 }
-exports.default = loadThemeAlias;
+exports.loadPluginsThemeAliases = loadPluginsThemeAliases;

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

@@ -1,5 +1,10 @@
-import { InitPlugin } from '../plugins/init';
-import { TranslationFileContent, TranslationFile, TranslationMessage } from '@docusaurus/types';
+/**
+ * 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 { TranslationFileContent, TranslationFile, TranslationMessage, InitializedPlugin } from '@docusaurus/types';
 export declare type WriteTranslationsOptions = {
     override?: boolean;
     messagePrefix?: string;
@@ -21,15 +26,15 @@ export declare function getCodeTranslationsFilePath(context: TranslationContext)
 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 & {
-    plugin: InitPlugin;
+    plugin: InitializedPlugin;
     translationFile: TranslationFile;
     options?: WriteTranslationsOptions;
 }): Promise<void>;
 export declare function localizePluginTranslationFile({ siteDir, plugin, locale, translationFile, }: TranslationContext & {
-    plugin: InitPlugin;
+    plugin: InitializedPlugin;
     translationFile: TranslationFile;
 }): Promise<TranslationFile>;
-export declare function getPluginsDefaultCodeTranslationMessages(plugins: InitPlugin[]): Promise<Record<string, string>>;
+export declare function getPluginsDefaultCodeTranslationMessages(plugins: InitializedPlugin[]): Promise<Record<string, string>>;
 export declare function applyDefaultCodeTranslations({ extractedCodeTranslations, defaultCodeMessages, }: {
     extractedCodeTranslations: Record<string, TranslationMessage>;
     defaultCodeMessages: Record<string, string>;

package/lib/server/translations/translations.js

@@ -1,19 +1,19 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyDefaultCodeTranslations = exports.getPluginsDefaultCodeTranslationMessages = exports.localizePluginTranslationFile = exports.writePluginTranslations = exports.writeCodeTranslations = exports.readCodeTranslationFileContent = exports.getCodeTranslationsFilePath = exports.getTranslationsLocaleDirPath = exports.getTranslationsDirPath = exports.writeTranslationFileContent = exports.readTranslationFileContent = exports.ensureTranslationFileContent = void 0;
-const tslib_1 = require("tslib");
 /**
  * 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.
  */
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const lodash_1 = require("lodash");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyDefaultCodeTranslations = exports.getPluginsDefaultCodeTranslationMessages = exports.localizePluginTranslationFile = exports.writePluginTranslations = exports.writeCodeTranslations = exports.readCodeTranslationFileContent = exports.getCodeTranslationsFilePath = exports.getTranslationsLocaleDirPath = exports.getTranslationsDirPath = exports.writeTranslationFileContent = exports.readTranslationFileContent = exports.ensureTranslationFileContent = void 0;
+const tslib_1 = require("tslib");
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const TranslationFileContentSchema = utils_validation_1.Joi.object()
     .pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
     message: utils_validation_1.Joi.string().allow('').required(),
@@ -35,8 +35,9 @@ async function readTranslationFileContent(filePath) {
             ensureTranslationFileContent(content);
             return content;
         }
-        catch (e) {
-            throw new Error(`Invalid translation file at path=${filePath}.\n${e.message}`);
+        catch (err) {
+            logger_1.default.error `Invalid translation file at path=${filePath}.`;
+            throw err;
         }
     }
     return undefined;
@@ -44,7 +45,7 @@ async function readTranslationFileContent(filePath) {
 exports.readTranslationFileContent = readTranslationFileContent;
 function mergeTranslationFileContent({ existingContent = {}, newContent, options, }) {
     // Apply messagePrefix to all messages
-    const newContentTransformed = lodash_1.mapValues(newContent, (value) => {
+    const newContentTransformed = lodash_1.default.mapValues(newContent, (value) => {
         var _a;
         return ({
             ...value,
@@ -56,7 +57,7 @@ function mergeTranslationFileContent({ existingContent = {}, newContent, options
     Object.entries(newContentTransformed).forEach(([key, { message, description }]) => {
         var _a, _b;
         result[key] = {
-            // If the messages already exist, we don't override them (unless requested)
+            // If messages already exist, we don't override them (unless requested)
             message: options.override
                 ? message
                 : (_b = (_a = existingContent[key]) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : message,
@@ -68,11 +69,10 @@ function mergeTranslationFileContent({ existingContent = {}, newContent, options
 async function writeTranslationFileContent({ filePath, content: newContent, options = {}, }) {
     const existingContent = await readTranslationFileContent(filePath);
     // Warn about potential legacy keys
-    const unknownKeys = lodash_1.difference(Object.keys(existingContent !== null && existingContent !== void 0 ? existingContent : {}), Object.keys(newContent));
+    const unknownKeys = lodash_1.default.difference(Object.keys(existingContent !== null && existingContent !== void 0 ? existingContent : {}), Object.keys(newContent));
     if (unknownKeys.length > 0) {
-        console.warn(chalk_1.default.yellow(`Some translation keys looks unknown to us in file ${filePath}
-Maybe you should remove them?
-- ${unknownKeys.join('\n- ')}`));
+        logger_1.default.warn `Some translation keys looks unknown to us in file path=${filePath}.
+Maybe you should remove them? ${unknownKeys}`;
     }
     const mergedContent = mergeTranslationFileContent({
         existingContent,
@@ -81,11 +81,9 @@ Maybe you should remove them?
     });
     // Avoid creating empty translation files
     if (Object.keys(mergedContent).length > 0) {
-        console.log(`${Object.keys(mergedContent)
-            .length.toString()
-            .padStart(3, ' ')} translations will be written at ${utils_1.toMessageRelativeFilePath(filePath)}`);
+        logger_1.default.info `number=${Object.keys(mergedContent).length} translations will be written at path=${(0, utils_1.toMessageRelativeFilePath)(filePath)}.`;
         await fs_extra_1.default.ensureDir(path_1.default.dirname(filePath));
-        await fs_extra_1.default.writeFile(filePath, JSON.stringify(mergedContent, null, 2));
+        await fs_extra_1.default.writeFile(filePath, `${JSON.stringify(mergedContent, null, 2)}\n`);
     }
 }
 exports.writeTranslationFileContent = writeTranslationFileContent;
@@ -119,12 +117,12 @@ exports.writeCodeTranslations = writeCodeTranslations;
 // (json/yaml/toml/xml...)
 function addTranslationFileExtension(translationFilePath) {
     if (translationFilePath.endsWith('.json')) {
-        throw new Error(`Translation file path does  not need to end  with .json, we addt the extension automatically. translationFilePath=${translationFilePath}`);
+        throw new Error(`Translation file path at "${translationFilePath}" does not need to end with ".json", we add the extension automatically.`);
     }
     return `${translationFilePath}.json`;
 }
 function getPluginTranslationFilePath({ siteDir, plugin, locale, translationFilePath, }) {
-    const dirPath = utils_1.getPluginI18nPath({
+    const dirPath = (0, utils_1.getPluginI18nPath)({
         siteDir,
         locale,
         pluginName: plugin.name,
@@ -165,32 +163,26 @@ async function localizePluginTranslationFile({ siteDir, plugin, locale, translat
             },
         };
     }
-    else {
-        return translationFile;
-    }
+    return translationFile;
 }
 exports.localizePluginTranslationFile = localizePluginTranslationFile;
 async function getPluginsDefaultCodeTranslationMessages(plugins) {
     const pluginsMessages = await Promise.all(plugins.map((plugin) => { var _a, _b; return (_b = (_a = plugin.getDefaultCodeTranslationMessages) === null || _a === void 0 ? void 0 : _a.call(plugin)) !== null && _b !== void 0 ? _b : {}; }));
-    return pluginsMessages.reduce((allMessages, pluginMessages) => {
-        return { ...allMessages, ...pluginMessages };
-    }, {});
+    return pluginsMessages.reduce((allMessages, pluginMessages) => ({ ...allMessages, ...pluginMessages }), {});
 }
 exports.getPluginsDefaultCodeTranslationMessages = getPluginsDefaultCodeTranslationMessages;
 function applyDefaultCodeTranslations({ extractedCodeTranslations, defaultCodeMessages, }) {
-    const unusedDefaultCodeMessages = lodash_1.difference(Object.keys(defaultCodeMessages), Object.keys(extractedCodeTranslations));
+    const unusedDefaultCodeMessages = lodash_1.default.difference(Object.keys(defaultCodeMessages), Object.keys(extractedCodeTranslations));
     if (unusedDefaultCodeMessages.length > 0) {
-        console.warn(chalk_1.default.yellow(`Unused default message codes found.
-Please report this Docusaurus issue.
-- ${unusedDefaultCodeMessages.join('\n- ')}
-`));
+        logger_1.default.warn `Unused default message codes found.
+Please report this Docusaurus issue. name=${unusedDefaultCodeMessages}`;
     }
-    return lodash_1.mapValues(extractedCodeTranslations, (messageTranslation, messageId) => {
+    return lodash_1.default.mapValues(extractedCodeTranslations, (messageTranslation, messageId) => {
         var _a;
-        return {
+        return ({
             ...messageTranslation,
             message: (_a = defaultCodeMessages[messageId]) !== null && _a !== void 0 ? _a : messageTranslation.message,
-        };
+        });
     });
 }
 exports.applyDefaultCodeTranslations = applyDefaultCodeTranslations;

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

@@ -1,8 +1,13 @@
-import { TransformOptions } from '@babel/core';
-import { TranslationFileContent, TranslationMessage } from '@docusaurus/types';
-import { InitPlugin } from '../plugins/init';
+/**
+ * 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 TransformOptions } from '@babel/core';
+import type { InitializedPlugin, TranslationFileContent, TranslationMessage } from '@docusaurus/types';
 export declare function globSourceCodeFilePaths(dirPaths: string[]): Promise<string[]>;
-export declare function extractSiteSourceCodeTranslations(siteDir: string, plugins: InitPlugin[], babelOptions: TransformOptions): Promise<TranslationFileContent>;
+export declare function extractSiteSourceCodeTranslations(siteDir: string, plugins: InitializedPlugin[], babelOptions: TransformOptions, extraSourceCodeFilePaths?: string[]): Promise<TranslationFileContent>;
 declare type SourceCodeFileTranslations = {
     sourceCodeFilePath: string;
     translations: Record<string, TranslationMessage>;