@docusaurus/core 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

package/lib/commands/swizzle/themes.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 SwizzlePlugin } from './common';
+export declare function pluginToThemeName(plugin: SwizzlePlugin): string | undefined;
+export declare function getPluginByThemeName(plugins: SwizzlePlugin[], themeName: string): SwizzlePlugin;
+export declare function getThemeNames(plugins: SwizzlePlugin[]): string[];
+export declare function getThemeName({ themeNameParam, themeNames, list, }: {
+    themeNameParam: string | undefined;
+    themeNames: string[];
+    list: boolean | undefined;
+}): Promise<string>;
+export declare function getThemePath({ plugins, themeName, typescript, }: {
+    plugins: SwizzlePlugin[];
+    themeName: string;
+    typescript: boolean | undefined;
+}): string;

package/lib/commands/swizzle/themes.js

@@ -0,0 +1,103 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getThemePath = exports.getThemeName = exports.getThemeNames = exports.getPluginByThemeName = exports.pluginToThemeName = void 0;
+const tslib_1 = require("tslib");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const leven_1 = tslib_1.__importDefault(require("leven"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const prompts_1 = require("./prompts");
+const common_1 = require("./common");
+function pluginToThemeName(plugin) {
+    if (plugin.instance.getThemePath) {
+        return (plugin.instance.version.name ?? plugin.instance.name);
+    }
+    return undefined;
+}
+exports.pluginToThemeName = pluginToThemeName;
+function getPluginByThemeName(plugins, themeName) {
+    const plugin = plugins.find((p) => pluginToThemeName(p) === themeName);
+    if (!plugin) {
+        throw new Error(`Theme ${themeName} not found`);
+    }
+    return plugin;
+}
+exports.getPluginByThemeName = getPluginByThemeName;
+function getThemeNames(plugins) {
+    const themeNames = lodash_1.default.uniq(
+    // The fact that getThemePath is attached to the plugin instance makes
+    // this code impossible to optimize. If this is a static method, we don't
+    // need to initialize all plugins just to filter which are themes
+    // Benchmark: loadContext-58ms; initPlugins-323ms
+    plugins.map((plugin) => pluginToThemeName(plugin)).filter(Boolean));
+    // Opinionated ordering: user is most likely to swizzle:
+    // - the classic theme
+    // - official themes
+    // - official plugins
+    return lodash_1.default.orderBy(themeNames, [
+        (t) => t === '@docusaurus/theme-classic',
+        (t) => t.includes('@docusaurus/theme'),
+        (t) => t.includes('@docusaurus'),
+    ], ['desc', 'desc', 'desc']);
+}
+exports.getThemeNames = getThemeNames;
+// Returns a valid value if recovering is possible
+function handleInvalidThemeName({ themeNameParam, themeNames, }) {
+    // Trying to recover invalid value
+    // We look for potential matches that only differ in casing.
+    const differentCaseMatch = (0, common_1.findStringIgnoringCase)(themeNameParam, themeNames);
+    if (differentCaseMatch) {
+        logger_1.default.warn `Theme name=${themeNameParam} doesn't exist.`;
+        logger_1.default.info `name=${differentCaseMatch} will be used instead of name=${themeNameParam}.`;
+        return differentCaseMatch;
+    }
+    // TODO recover from short theme-names here: "classic" => "@docusaurus/theme-classic"
+    // No recovery value is possible: print error
+    const suggestion = themeNames.find((name) => (0, leven_1.default)(name, themeNameParam) < 4);
+    logger_1.default.error `Theme name=${themeNameParam} not found. ${suggestion
+        ? logger_1.default.interpolate `Did you mean name=${suggestion}?`
+        : logger_1.default.interpolate `Themes available for swizzle: ${themeNames}`}`;
+    return process.exit(1);
+}
+async function validateThemeName({ themeNameParam, themeNames, }) {
+    const isValidName = themeNames.includes(themeNameParam);
+    if (!isValidName) {
+        return handleInvalidThemeName({
+            themeNameParam,
+            themeNames,
+        });
+    }
+    return themeNameParam;
+}
+async function getThemeName({ themeNameParam, themeNames, list, }) {
+    if (list && !themeNameParam) {
+        logger_1.default.info `Themes available for swizzle: name=${themeNames}`;
+        return process.exit(0);
+    }
+    return themeNameParam
+        ? validateThemeName({ themeNameParam, themeNames })
+        : (0, prompts_1.askThemeName)(themeNames);
+}
+exports.getThemeName = getThemeName;
+function getThemePath({ plugins, themeName, typescript, }) {
+    const pluginInstance = getPluginByThemeName(plugins, themeName);
+    const themePath = typescript
+        ? pluginInstance.instance.getTypeScriptThemePath?.()
+        : pluginInstance.instance.getThemePath?.();
+    if (!themePath) {
+        logger_1.default.warn(typescript
+            ? logger_1.default.interpolate `name=${themeName} does not provide TypeScript theme code via ${'getTypeScriptThemePath()'}.`
+            : // This is... technically possible to happen, e.g. returning undefined
+                // from getThemePath. Plugins may intentionally or unintentionally
+                // disguise as themes?
+                logger_1.default.interpolate `name=${themeName} does not provide any theme code.`);
+        return process.exit(1);
+    }
+    return themePath;
+}
+exports.getThemePath = getThemePath;

package/lib/commands/writeHeadingIds.d.ts

@@ -4,9 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import GithubSlugger from 'github-slugger';
-export declare function unwrapMarkdownLinks(line: string): string;
-export declare function transformMarkdownHeadingLine(line: string, slugger: GithubSlugger): string;
-export declare function transformMarkdownLine(line: string, slugger: GithubSlugger): string;
-export declare function transformMarkdownContent(content: string): string;
-export default function writeHeadingIds(siteDir: string): Promise<void>;
+import { type Slugger } from '@docusaurus/utils';
+declare type Options = {
+    maintainCase?: boolean;
+    overwrite?: boolean;
+};
+export declare function transformMarkdownHeadingLine(line: string, slugger: Slugger, options?: Options): string;
+export declare function transformMarkdownContent(content: string, options?: Options): string;
+export default function writeHeadingIds(siteDir: string, files?: string[], options?: Options): Promise<void>;
+export {};

package/lib/commands/writeHeadingIds.js

@@ -6,105 +6,103 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformMarkdownContent = exports.transformMarkdownLine = exports.transformMarkdownHeadingLine = exports.unwrapMarkdownLinks = void 0;
+exports.transformMarkdownContent = exports.transformMarkdownHeadingLine = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const github_slugger_1 = tslib_1.__importDefault(require("github-slugger"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const server_1 = require("../server");
 const init_1 = tslib_1.__importDefault(require("../server/plugins/init"));
-const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
 const utils_2 = require("../server/utils");
 function unwrapMarkdownLinks(line) {
-    return line.replace(/\[([^\]]+)\]\([^)]+\)/g, (match, p1) => p1);
+    return line.replace(/\[(?<alt>[^\]]+)\]\([^)]+\)/g, (match, p1) => p1);
 }
-exports.unwrapMarkdownLinks = unwrapMarkdownLinks;
-function addHeadingId(line, slugger) {
+function addHeadingId(line, slugger, maintainCase) {
     let headingLevel = 0;
     while (line.charAt(headingLevel) === '#') {
         headingLevel += 1;
     }
     const headingText = line.slice(headingLevel).trimEnd();
     const headingHashes = line.slice(0, headingLevel);
-    const slug = slugger.slug(unwrapMarkdownLinks(headingText));
+    const slug = slugger
+        .slug(unwrapMarkdownLinks(headingText).trim(), { maintainCase })
+        .replace(/^-+/, '')
+        .replace(/-+$/, '');
     return `${headingHashes}${headingText} {#${slug}}`;
 }
-function transformMarkdownHeadingLine(line, slugger) {
+function transformMarkdownHeadingLine(line, slugger, options = { maintainCase: false, overwrite: false }) {
+    const { maintainCase = false, overwrite = false } = options;
     if (!line.startsWith('#')) {
         throw new Error(`Line is not a Markdown heading: ${line}.`);
     }
-    const parsedHeading = utils_1.parseMarkdownHeadingId(line);
-    // Do not process if id is already therer
-    if (parsedHeading.id) {
+    const parsedHeading = (0, utils_1.parseMarkdownHeadingId)(line);
+    // Do not process if id is already there
+    if (parsedHeading.id && !overwrite) {
         return line;
     }
-    return addHeadingId(line, slugger);
+    return addHeadingId(parsedHeading.text, slugger, maintainCase);
 }
 exports.transformMarkdownHeadingLine = transformMarkdownHeadingLine;
-function transformMarkdownLine(line, slugger) {
+function transformMarkdownLine(line, slugger, options) {
     // Ignore h1 headings on purpose, as we don't create anchor links for those
     if (line.startsWith('##')) {
-        return transformMarkdownHeadingLine(line, slugger);
-    }
-    else {
-        return line;
+        return transformMarkdownHeadingLine(line, slugger, options);
     }
+    return line;
 }
-exports.transformMarkdownLine = transformMarkdownLine;
-function transformMarkdownLines(lines) {
+function transformMarkdownLines(lines, options) {
     let inCode = false;
-    const slugger = new github_slugger_1.default();
+    const slugger = (0, utils_1.createSlugger)();
     return lines.map((line) => {
         if (line.startsWith('```')) {
             inCode = !inCode;
             return line;
         }
-        else {
-            if (inCode) {
-                return line;
-            }
-            return transformMarkdownLine(line, slugger);
+        if (inCode) {
+            return line;
         }
+        return transformMarkdownLine(line, slugger, options);
     });
 }
-function transformMarkdownContent(content) {
-    return transformMarkdownLines(content.split('\n')).join('\n');
+function transformMarkdownContent(content, options) {
+    return transformMarkdownLines(content.split('\n'), options).join('\n');
 }
 exports.transformMarkdownContent = transformMarkdownContent;
-async function transformMarkdownFile(filepath) {
+async function transformMarkdownFile(filepath, options) {
     const content = await fs_extra_1.default.readFile(filepath, 'utf8');
-    const updatedContent = transformMarkdownLines(content.split('\n')).join('\n');
+    const updatedContent = transformMarkdownLines(content.split('\n'), options).join('\n');
     if (content !== updatedContent) {
         await fs_extra_1.default.writeFile(filepath, updatedContent);
         return filepath;
     }
     return undefined;
 }
-// We only handle the "paths to watch" because these are the paths where the markdown files are
-// Also we don't want to transform the site md docs that do not belong to a content plugin
-// For example ./README.md should not be transformed
+/**
+ * We only handle the "paths to watch" because these are the paths where the
+ * markdown files are. Also we don't want to transform the site md docs that do
+ * not belong to a content plugin. For example ./README.md should not be
+ * transformed
+ */
 async function getPathsToWatch(siteDir) {
-    const context = await server_1.loadContext(siteDir);
-    const pluginConfigs = server_1.loadPluginConfigs(context);
-    const plugins = await init_1.default({
+    const context = await (0, server_1.loadContext)(siteDir);
+    const pluginConfigs = await (0, server_1.loadPluginConfigs)(context);
+    const plugins = await (0, init_1.default)({
         pluginConfigs,
         context,
     });
-    return lodash_1.flatten(plugins.map((plugin) => { var _a, _b; return (_b = (_a = plugin === null || plugin === void 0 ? void 0 : plugin.getPathsToWatch) === null || _a === void 0 ? void 0 : _a.call(plugin)) !== null && _b !== void 0 ? _b : []; }));
+    return plugins.flatMap((plugin) => plugin?.getPathsToWatch?.() ?? []);
 }
-async function writeHeadingIds(siteDir) {
-    const markdownFiles = await utils_2.safeGlobby(await getPathsToWatch(siteDir), {
+async function writeHeadingIds(siteDir, files, options) {
+    const markdownFiles = await (0, utils_2.safeGlobby)(files ?? (await getPathsToWatch(siteDir)), {
         expandDirectories: ['**/*.{md,mdx}'],
     });
-    const result = await Promise.all(markdownFiles.map(transformMarkdownFile));
+    const result = await Promise.all(markdownFiles.map((p) => transformMarkdownFile(p, options)));
     const pathsModified = result.filter(Boolean);
     if (pathsModified.length) {
-        console.log(chalk_1.default.green(`Heading ids added to Markdown files (${pathsModified.length}/${markdownFiles.length} files):
-- ${pathsModified.join('\n- ')}`));
+        logger_1.default.success `Heading ids added to Markdown files (number=${`${pathsModified.length}/${markdownFiles.length}`} files): ${pathsModified}`;
     }
     else {
-        console.log(chalk_1.default.yellow(`${markdownFiles.length} Markdown files already have explicit heading ids.`));
+        logger_1.default.warn `number=${markdownFiles.length} Markdown files already have explicit heading IDs. If you intend to overwrite the existing heading IDs, use the code=${'--overwrite'} option.`;
     }
 }
 exports.default = writeHeadingIds;

package/lib/commands/writeTranslations.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { ConfigOptions } from '@docusaurus/types';
-import { WriteTranslationsOptions } from '../server/translations/translations';
+import type { ConfigOptions } from '@docusaurus/types';
+import { type WriteTranslationsOptions } from '../server/translations/translations';
 export default function writeTranslations(siteDir: string, options: WriteTranslationsOptions & ConfigOptions & {
     locale?: string;
 }): Promise<void>;

package/lib/commands/writeTranslations.js

@@ -1,20 +1,42 @@
 "use strict";
+/**
+ * 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.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
 const server_1 = require("../server");
 const init_1 = tslib_1.__importDefault(require("../server/plugins/init"));
 const translations_1 = require("../server/translations/translations");
 const translationsExtractor_1 = require("../server/translations/translationsExtractor");
 const utils_1 = require("../webpack/utils");
+/**
+ * This is a hack, so that @docusaurus/theme-common translations are extracted!
+ * A theme doesn't have a way to express that one of its dependency (like
+ * @docusaurus/theme-common) also has translations to extract.
+ * Instead of introducing a new lifecycle (like `getThemeTranslationPaths()`?)
+ * We just make an exception and assume that user is using an official theme
+ */
+async function getExtraSourceCodeFilePaths() {
+    try {
+        const themeCommonSourceDir = path_1.default.dirname(require.resolve('@docusaurus/theme-common/lib'));
+        return (0, translationsExtractor_1.globSourceCodeFilePaths)([themeCommonSourceDir]);
+    }
+    catch {
+        return []; // User may not use a Docusaurus official theme? Quite unlikely...
+    }
+}
 async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }) {
-    var _a;
     if (plugin.getTranslationFiles) {
-        const content = await ((_a = plugin.loadContent) === null || _a === void 0 ? void 0 : _a.call(plugin));
+        const content = await plugin.loadContent?.();
         const translationFiles = await plugin.getTranslationFiles({
             content,
         });
         await Promise.all(translationFiles.map(async (translationFile) => {
-            await translations_1.writePluginTranslations({
+            await (0, translations_1.writePluginTranslations)({
                 siteDir,
                 plugin,
                 translationFile,
@@ -25,32 +47,31 @@ async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }
     }
 }
 async function writeTranslations(siteDir, options) {
-    var _a;
-    const context = await server_1.loadContext(siteDir, {
+    const context = await (0, server_1.loadContext)(siteDir, {
         customConfigFilePath: options.config,
         locale: options.locale,
     });
-    const pluginConfigs = server_1.loadPluginConfigs(context);
-    const plugins = init_1.default({
+    const pluginConfigs = await (0, server_1.loadPluginConfigs)(context);
+    const plugins = await (0, init_1.default)({
         pluginConfigs,
         context,
     });
-    const locale = (_a = options.locale) !== null && _a !== void 0 ? _a : context.i18n.defaultLocale;
+    const locale = options.locale ?? context.i18n.defaultLocale;
     if (!context.i18n.locales.includes(locale)) {
         throw new Error(`Can't write-translation for locale "${locale}" that is not in the locale configuration file.
 Available locales are: ${context.i18n.locales.join(',')}.`);
     }
-    const babelOptions = utils_1.getBabelOptions({
+    const babelOptions = (0, utils_1.getBabelOptions)({
         isServer: true,
-        babelOptions: utils_1.getCustomBabelConfigFilePath(siteDir),
+        babelOptions: await (0, utils_1.getCustomBabelConfigFilePath)(siteDir),
     });
-    const extractedCodeTranslations = await translationsExtractor_1.extractSiteSourceCodeTranslations(siteDir, plugins, babelOptions);
-    const defaultCodeMessages = await translations_1.getPluginsDefaultCodeTranslationMessages(plugins);
-    const codeTranslations = translations_1.applyDefaultCodeTranslations({
+    const extractedCodeTranslations = await (0, translationsExtractor_1.extractSiteSourceCodeTranslations)(siteDir, plugins, babelOptions, await getExtraSourceCodeFilePaths());
+    const defaultCodeMessages = await (0, translations_1.getPluginsDefaultCodeTranslationMessages)(plugins);
+    const codeTranslations = (0, translations_1.applyDefaultCodeTranslations)({
         extractedCodeTranslations,
         defaultCodeMessages,
     });
-    await translations_1.writeCodeTranslations({ siteDir, locale }, codeTranslations, options);
+    await (0, translations_1.writeCodeTranslations)({ siteDir, locale }, codeTranslations, options);
     await Promise.all(plugins.map(async (plugin) => {
         await writePluginTranslationFiles({ siteDir, plugin, locale, options });
     }));

package/lib/index.d.ts

@@ -4,12 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export { default as build } from './commands/build';
-export { default as start } from './commands/start';
-export { default as swizzle } from './commands/swizzle';
-export { default as deploy } from './commands/deploy';
-export { default as externalCommand } from './commands/external';
-export { default as serve } from './commands/serve';
-export { default as clear } from './commands/clear';
-export { default as writeTranslations } from './commands/writeTranslations';
-export { default as writeHeadingIds } from './commands/writeHeadingIds';
+import build from './commands/build';
+import clear from './commands/clear';
+import deploy from './commands/deploy';
+import externalCommand from './commands/external';
+import serve from './commands/serve';
+import start from './commands/start';
+import swizzle from './commands/swizzle';
+import writeHeadingIds from './commands/writeHeadingIds';
+import writeTranslations from './commands/writeTranslations';
+export { build, clear, deploy, externalCommand, serve, start, swizzle, writeHeadingIds, writeTranslations, };

package/lib/index.js

@@ -6,22 +6,23 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeHeadingIds = exports.writeTranslations = exports.clear = exports.serve = exports.externalCommand = exports.deploy = exports.swizzle = exports.start = exports.build = void 0;
-var build_1 = require("./commands/build");
-Object.defineProperty(exports, "build", { enumerable: true, get: function () { return __importDefault(build_1).default; } });
-var start_1 = require("./commands/start");
-Object.defineProperty(exports, "start", { enumerable: true, get: function () { return __importDefault(start_1).default; } });
-var swizzle_1 = require("./commands/swizzle");
-Object.defineProperty(exports, "swizzle", { enumerable: true, get: function () { return __importDefault(swizzle_1).default; } });
-var deploy_1 = require("./commands/deploy");
-Object.defineProperty(exports, "deploy", { enumerable: true, get: function () { return __importDefault(deploy_1).default; } });
-var external_1 = require("./commands/external");
-Object.defineProperty(exports, "externalCommand", { enumerable: true, get: function () { return __importDefault(external_1).default; } });
-var serve_1 = require("./commands/serve");
-Object.defineProperty(exports, "serve", { enumerable: true, get: function () { return __importDefault(serve_1).default; } });
-var clear_1 = require("./commands/clear");
-Object.defineProperty(exports, "clear", { enumerable: true, get: function () { return __importDefault(clear_1).default; } });
-var writeTranslations_1 = require("./commands/writeTranslations");
-Object.defineProperty(exports, "writeTranslations", { enumerable: true, get: function () { return __importDefault(writeTranslations_1).default; } });
-var writeHeadingIds_1 = require("./commands/writeHeadingIds");
-Object.defineProperty(exports, "writeHeadingIds", { enumerable: true, get: function () { return __importDefault(writeHeadingIds_1).default; } });
+exports.writeTranslations = exports.writeHeadingIds = exports.swizzle = exports.start = exports.serve = exports.externalCommand = exports.deploy = exports.clear = exports.build = void 0;
+const tslib_1 = require("tslib");
+const build_1 = tslib_1.__importDefault(require("./commands/build"));
+exports.build = build_1.default;
+const clear_1 = tslib_1.__importDefault(require("./commands/clear"));
+exports.clear = clear_1.default;
+const deploy_1 = tslib_1.__importDefault(require("./commands/deploy"));
+exports.deploy = deploy_1.default;
+const external_1 = tslib_1.__importDefault(require("./commands/external"));
+exports.externalCommand = external_1.default;
+const serve_1 = tslib_1.__importDefault(require("./commands/serve"));
+exports.serve = serve_1.default;
+const start_1 = tslib_1.__importDefault(require("./commands/start"));
+exports.start = start_1.default;
+const swizzle_1 = tslib_1.__importDefault(require("./commands/swizzle"));
+exports.swizzle = swizzle_1.default;
+const writeHeadingIds_1 = tslib_1.__importDefault(require("./commands/writeHeadingIds"));
+exports.writeHeadingIds = writeHeadingIds_1.default;
+const writeTranslations_1 = tslib_1.__importDefault(require("./commands/writeTranslations"));
+exports.writeTranslations = writeTranslations_1.default;

package/lib/server/brokenLinks.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 { RouteConfig, ReportingSeverity } from '@docusaurus/types';
+import type { RouteConfig, ReportingSeverity } from '@docusaurus/types';
 declare type BrokenLink = {
     link: string;
     resolvedLink: string;