@docusaurus/core 2.0.0-beta.138b4c997 → 2.0.0-beta.14

package/lib/server/presets/index.js

@@ -7,19 +7,18 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const module_1 = tslib_1.__importDefault(require("module"));
-const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
+const module_1 = require("module");
+const import_fresh_1 = (0, tslib_1.__importDefault)(require("import-fresh"));
+const moduleShorthand_1 = require("../moduleShorthand");
 function loadPresets(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);
+    // We need to resolve presets from the perspective of the siteDir, since the siteDir's package.json
+    // declares the dependency on these presets.
+    const presetRequire = (0, module_1.createRequire)(context.siteConfigPath);
     const presets = (context.siteConfig || {}).presets || [];
     const unflatPlugins = [];
     const unflatThemes = [];
     presets.forEach((presetItem) => {
+        var _a;
         let presetModuleImport;
         let presetOptions = {};
         if (typeof presetItem === 'string') {
@@ -31,8 +30,9 @@ function loadPresets(context) {
         else {
             throw new Error('Invalid presets format detected in config.');
         }
-        const presetModule = import_fresh_1.default(pluginRequire.resolve(presetModuleImport));
-        const preset = (presetModule.default || presetModule)(context, presetOptions);
+        const presetName = (0, moduleShorthand_1.resolveModuleName)(presetModuleImport, presetRequire, 'preset');
+        const presetModule = (0, import_fresh_1.default)(presetRequire.resolve(presetName));
+        const preset = ((_a = presetModule.default) !== null && _a !== void 0 ? _a : presetModule)(context, presetOptions);
         if (preset.plugins) {
             unflatPlugins.push(preset.plugins);
         }
@@ -41,8 +41,8 @@ function loadPresets(context) {
         }
     });
     return {
-        plugins: [].concat(...unflatPlugins).filter(Boolean),
-        themes: [].concat(...unflatThemes).filter(Boolean),
+        plugins: unflatPlugins.flat().filter(Boolean),
+        themes: unflatThemes.flat().filter(Boolean),
     };
 }
 exports.default = loadPresets;

package/lib/server/routes.js

@@ -9,18 +9,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@docusaurus/utils");
 const lodash_1 = require("lodash");
 const querystring_1 = require("querystring");
-const createRouteCodeString = ({ routePath, routeHash, exact, subroutesCodeStrings, }) => {
-    const str = `{
-  path: '${routePath}',
-  component: ComponentCreator('${routePath}','${routeHash}'),
-  ${exact ? `exact: true,` : ''}
-${subroutesCodeStrings
-        ? `  routes: [
-${utils_1.removeSuffix(subroutesCodeStrings.join(',\n'), ',\n')},
-]
-`
-        : ''}}`;
-    return str;
+function indent(str) {
+    const spaces = '  ';
+    return `${spaces}${str.replace(/(\n)/g, `\n${spaces}`)}`;
+}
+const createRouteCodeString = ({ routePath, routeHash, exact, subroutesCodeStrings, props, }) => {
+    const parts = [
+        `path: '${routePath}'`,
+        `component: ComponentCreator('${routePath}','${routeHash}')`,
+    ];
+    if (exact) {
+        parts.push(`exact: true`);
+    }
+    if (subroutesCodeStrings) {
+        parts.push(`routes: [
+${indent((0, utils_1.removeSuffix)(subroutesCodeStrings.join(',\n'), ',\n'))}
+]`);
+    }
+    Object.entries(props).forEach(([propName, propValue]) => {
+        // Figure out how to "unquote" JS attributes that don't need to be quoted
+        // Is this lib reliable? https://github.com/armanozak/should-quote
+        const shouldQuote = true; // TODO
+        const key = shouldQuote ? `'${propName}'` : propName;
+        parts.push(`${key}: ${JSON.stringify(propValue)}`);
+    });
+    return `{
+${indent(parts.join(',\n'))}
+}`;
 };
 const NotFoundRouteCode = `{
   path: '*',
@@ -31,10 +46,10 @@ const RoutesImportsCode = [
     `import ComponentCreator from '@docusaurus/ComponentCreator';`,
 ].join('\n');
 function isModule(value) {
-    if (lodash_1.isString(value)) {
+    if ((0, lodash_1.isString)(value)) {
         return true;
     }
-    if (lodash_1.isPlainObject(value) && lodash_1.has(value, '__import') && lodash_1.has(value, 'path')) {
+    if ((0, lodash_1.isPlainObject)(value) && (0, lodash_1.has)(value, '__import') && (0, lodash_1.has)(value, 'path')) {
         return true;
     }
     return false;
@@ -43,17 +58,17 @@ function getModulePath(target) {
     if (typeof target === 'string') {
         return target;
     }
-    const queryStr = target.query ? `?${querystring_1.stringify(target.query)}` : '';
+    const queryStr = target.query ? `?${(0, querystring_1.stringify)(target.query)}` : '';
     return `${target.path}${queryStr}`;
 }
 async function loadRoutes(pluginsRouteConfigs, baseUrl) {
     const registry = {};
-    const routesPaths = [utils_1.normalizeUrl([baseUrl, '404.html'])];
+    const routesPaths = [(0, utils_1.normalizeUrl)([baseUrl, '404.html'])];
     const routesChunkNames = {};
     // This is the higher level overview of route code generation.
     function generateRouteCode(routeConfig) {
-        const { path: routePath, component, modules = {}, routes: subroutes, exact, } = routeConfig;
-        if (!lodash_1.isString(routePath) || !component) {
+        const { path: routePath, component, modules = {}, routes: subroutes, exact, priority, ...props } = routeConfig;
+        if (!(0, lodash_1.isString)(routePath) || !component) {
             throw new Error(`Invalid route config: path must be a string and component is required.\n${JSON.stringify(routeConfig)}`);
         }
         // Collect all page paths for injecting it later in the plugin lifecycle
@@ -65,7 +80,7 @@ async function loadRoutes(pluginsRouteConfigs, baseUrl) {
         // We hash the route to generate the key, because 2 routes can conflict with
         // each others if they have the same path, ex: parent=/docs, child=/docs
         // see https://github.com/facebook/docusaurus/issues/2917
-        const routeHash = utils_1.simpleHash(JSON.stringify(routeConfig), 3);
+        const routeHash = (0, utils_1.simpleHash)(JSON.stringify(routeConfig), 3);
         const chunkNamesKey = `${routePath}-${routeHash}`;
         routesChunkNames[chunkNamesKey] = {
             ...genRouteChunkNames(registry, { component }, 'component', component),
@@ -76,14 +91,17 @@ async function loadRoutes(pluginsRouteConfigs, baseUrl) {
             routeHash,
             exact,
             subroutesCodeStrings: subroutes === null || subroutes === void 0 ? void 0 : subroutes.map(generateRouteCode),
+            props,
         });
     }
     const routesConfig = `
 ${RoutesImportsCode}
+
 export default [
-${pluginsRouteConfigs.map(generateRouteCode).join(',\n')},
-${NotFoundRouteCode}
-];\n`;
+${indent(`${pluginsRouteConfigs.map(generateRouteCode).join(',\n')},`)}
+${indent(NotFoundRouteCode)}
+];
+`;
     return {
         registry,
         routesConfig,
@@ -103,7 +121,7 @@ registry, value, prefix, name) {
     }
     if (isModule(value)) {
         const modulePath = getModulePath(value);
-        const chunkName = utils_1.genChunkName(modulePath, prefix, name);
+        const chunkName = (0, utils_1.genChunkName)(modulePath, prefix, name);
         // We need to JSON.stringify so that if its on windows, backslashes are escaped.
         const loader = `() => import(/* webpackChunkName: '${chunkName}' */ ${JSON.stringify(modulePath)})`;
         registry[chunkName] = {

package/lib/server/themes/alias.d.ts

@@ -5,4 +5,5 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { ThemeAliases } from '@docusaurus/types';
+export declare function sortAliases(aliases: ThemeAliases): ThemeAliases;
 export default function themeAlias(themePath: string, addOriginalAlias: boolean): ThemeAliases;

package/lib/server/themes/alias.js

@@ -6,35 +6,44 @@
  * 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");
+// 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 = (0, lodash_1.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;
 // TODO make async
 function themeAlias(themePath, addOriginalAlias) {
     if (!fs_extra_1.default.pathExistsSync(themePath)) {
         return {};
     }
-    const themeComponentFiles = globby_1.default.sync(['**/*.{js,jsx,ts,tsx}'], {
+    const themeComponentFiles = utils_1.Globby.sync(['**/*.{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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { ThemeAliases, LoadedPlugin } from '@docusaurus/types';
-export declare function loadThemeAliases(themePaths: string[], userThemePaths?: string[]): ThemeAliases;
+export declare function loadThemeAliases(themePaths: string[], userThemePaths: string[]): ThemeAliases;
 export declare function loadPluginsThemeAliases({ siteDir, plugins, }: {
     siteDir: string;
     plugins: LoadedPlugin[];

package/lib/server/themes/index.js

@@ -8,40 +8,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadPluginsThemeAliases = exports.loadThemeAliases = void 0;
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const constants_1 = require("../../constants");
-const alias_1 = tslib_1.__importDefault(require("./alias"));
+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');
-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;
-}
-function loadThemeAliases(themePaths, userThemePaths = []) {
-    let aliases = {}; // TODO refactor, inelegant side-effect
+function loadThemeAliases(themePaths, userThemePaths) {
+    const aliases = {};
     themePaths.forEach((themePath) => {
-        const themeAliases = alias_1.default(themePath, true);
-        aliases = { ...aliases, ...buildThemeAliases(themeAliases, aliases) };
+        const themeAliases = (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];
+        });
     });
     userThemePaths.forEach((themePath) => {
-        const userThemeAliases = alias_1.default(themePath, false);
-        aliases = { ...aliases, ...buildThemeAliases(userThemeAliases, aliases) };
+        const userThemeAliases = (0, alias_1.default)(themePath, false);
+        Object.assign(aliases, userThemeAliases);
     });
-    return aliases;
+    return (0, alias_1.sortAliases)(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, constants_1.THEME_PATH);
+    const userTheme = path_1.default.resolve(siteDir, utils_1.THEME_PATH);
     return loadThemeAliases([ThemeFallbackDir, ...pluginThemes], [userTheme]);
 }
 exports.loadPluginsThemeAliases = loadPluginsThemeAliases;

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

@@ -1,3 +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.
+ */
 import { TranslationFileContent, TranslationFile, TranslationMessage, InitializedPlugin } from '@docusaurus/types';
 export declare type WriteTranslationsOptions = {
     override?: boolean;

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"));
+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 = 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(),
@@ -44,7 +44,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 = (0, lodash_1.mapValues)(newContent, (value) => {
         var _a;
         return ({
             ...value,
@@ -68,11 +68,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 = (0, lodash_1.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,9 +80,7 @@ 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));
     }
@@ -124,7 +121,7 @@ function addTranslationFileExtension(translationFilePath) {
     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,
@@ -172,25 +169,21 @@ async function localizePluginTranslationFile({ siteDir, plugin, locale, translat
 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 = (0, lodash_1.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 (0, lodash_1.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,7 +1,13 @@
+/**
+ * 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 { TransformOptions } from '@babel/core';
 import { InitializedPlugin, TranslationFileContent, TranslationMessage } from '@docusaurus/types';
 export declare function globSourceCodeFilePaths(dirPaths: string[]): Promise<string[]>;
-export declare function extractSiteSourceCodeTranslations(siteDir: string, plugins: InitializedPlugin[], 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>;