@docusaurus/core 2.0.0-beta.16 → 2.0.0-beta.19

package/lib/commands/writeHeadingIds.js

@@ -6,71 +6,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformMarkdownContent = exports.transformMarkdownHeadingLine = void 0;
+exports.writeHeadingIds = void 0;
 const tslib_1 = require("tslib");
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
-const server_1 = require("../server");
-const init_1 = (0, tslib_1.__importDefault)(require("../server/plugins/init"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
+const server_1 = require("../server");
+const init_1 = require("../server/plugins/init");
 const utils_2 = require("../server/utils");
-function unwrapMarkdownLinks(line) {
-    return line.replace(/\[(?<alt>[^\]]+)\]\([^)]+\)/g, (match, p1) => p1);
-}
-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).trim(), { maintainCase })
-        .replace(/^-+/, '')
-        .replace(/-+$/, '');
-    return `${headingHashes}${headingText} {#${slug}}`;
-}
-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 = (0, utils_1.parseMarkdownHeadingId)(line);
-    // Do not process if id is already there
-    if (parsedHeading.id && !overwrite) {
-        return line;
-    }
-    return addHeadingId(parsedHeading.text, slugger, maintainCase);
-}
-exports.transformMarkdownHeadingLine = transformMarkdownHeadingLine;
-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, options);
-    }
-    return line;
-}
-function transformMarkdownLines(lines, options) {
-    let inCode = false;
-    const slugger = (0, utils_1.createSlugger)();
-    return lines.map((line) => {
-        if (line.startsWith('```')) {
-            inCode = !inCode;
-            return line;
-        }
-        if (inCode) {
-            return line;
-        }
-        return transformMarkdownLine(line, slugger, options);
-    });
-}
-function transformMarkdownContent(content, options) {
-    return transformMarkdownLines(content.split('\n'), options).join('\n');
-}
-exports.transformMarkdownContent = transformMarkdownContent;
 async function transformMarkdownFile(filepath, options) {
     const content = await fs_extra_1.default.readFile(filepath, 'utf8');
-    const updatedContent = transformMarkdownLines(content.split('\n'), options).join('\n');
+    const updatedContent = (0, utils_1.writeMarkdownHeadingId)(content, options);
     if (content !== updatedContent) {
         await fs_extra_1.default.writeFile(filepath, updatedContent);
         return filepath;
@@ -84,16 +30,12 @@ async function transformMarkdownFile(filepath, options) {
  * transformed
  */
 async function getPathsToWatch(siteDir) {
-    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 plugins.flatMap((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 : []; });
+    const context = await (0, server_1.loadContext)({ siteDir });
+    const plugins = await (0, init_1.initPlugins)(context);
+    return plugins.flatMap((plugin) => plugin?.getPathsToWatch?.() ?? []);
 }
 async function writeHeadingIds(siteDir, files, options) {
-    const markdownFiles = await (0, utils_2.safeGlobby)(files !== null && files !== void 0 ? files : (await getPathsToWatch(siteDir)), {
+    const markdownFiles = await (0, utils_2.safeGlobby)(files ?? (await getPathsToWatch(siteDir)), {
         expandDirectories: ['**/*.{md,mdx}'],
     });
     const result = await Promise.all(markdownFiles.map((p) => transformMarkdownFile(p, options)));
@@ -105,4 +47,4 @@ async function writeHeadingIds(siteDir, files, options) {
         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;
+exports.writeHeadingIds = writeHeadingIds;

package/lib/commands/writeTranslations.d.ts

@@ -4,8 +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 { ConfigOptions } from '@docusaurus/types';
+import { type LoadContextOptions } from '../server';
 import { type WriteTranslationsOptions } from '../server/translations/translations';
-export default function writeTranslations(siteDir: string, options: WriteTranslationsOptions & ConfigOptions & {
-    locale?: string;
-}): Promise<void>;
+export declare type WriteTranslationsCLIOptions = Pick<LoadContextOptions, 'config' | 'locale'> & WriteTranslationsOptions;
+export declare function writeTranslations(siteDir: string, options: Partial<WriteTranslationsCLIOptions>): Promise<void>;

package/lib/commands/writeTranslations.js

@@ -6,10 +6,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeTranslations = void 0;
 const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const path_1 = tslib_1.__importDefault(require("path"));
 const server_1 = require("../server");
-const init_1 = (0, tslib_1.__importDefault)(require("../server/plugins/init"));
+const init_1 = require("../server/plugins/init");
 const translations_1 = require("../server/translations/translations");
 const translationsExtractor_1 = require("../server/translations/translationsExtractor");
 const utils_1 = require("../webpack/utils");
@@ -30,9 +31,8 @@ async function getExtraSourceCodeFilePaths() {
     }
 }
 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,
         });
@@ -48,17 +48,13 @@ async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }
     }
 }
 async function writeTranslations(siteDir, options) {
-    var _a;
-    const context = await (0, server_1.loadContext)(siteDir, {
-        customConfigFilePath: options.config,
+    const context = await (0, server_1.loadContext)({
+        siteDir,
+        config: options.config,
         locale: options.locale,
     });
-    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 plugins = await (0, init_1.initPlugins)(context);
+    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(',')}.`);
@@ -78,4 +74,4 @@ Available locales are: ${context.i18n.locales.join(',')}.`);
         await writePluginTranslationFiles({ siteDir, plugin, locale, options });
     }));
 }
-exports.default = writeTranslations;
+exports.writeTranslations = writeTranslations;

package/lib/index.d.ts

@@ -4,13 +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 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, };
+export { build } from './commands/build';
+export { clear } from './commands/clear';
+export { deploy } from './commands/deploy';
+export { externalCommand } from './commands/external';
+export { serve } from './commands/serve';
+export { start } from './commands/start';
+export { swizzle } from './commands/swizzle';
+export { writeHeadingIds } from './commands/writeHeadingIds';
+export { writeTranslations } from './commands/writeTranslations';

package/lib/index.js

@@ -7,22 +7,21 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 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 = (0, tslib_1.__importDefault)(require("./commands/build"));
-exports.build = build_1.default;
-const clear_1 = (0, tslib_1.__importDefault)(require("./commands/clear"));
-exports.clear = clear_1.default;
-const deploy_1 = (0, tslib_1.__importDefault)(require("./commands/deploy"));
-exports.deploy = deploy_1.default;
-const external_1 = (0, tslib_1.__importDefault)(require("./commands/external"));
-exports.externalCommand = external_1.default;
-const serve_1 = (0, tslib_1.__importDefault)(require("./commands/serve"));
-exports.serve = serve_1.default;
-const start_1 = (0, tslib_1.__importDefault)(require("./commands/start"));
-exports.start = start_1.default;
-const swizzle_1 = (0, tslib_1.__importDefault)(require("./commands/swizzle"));
-exports.swizzle = swizzle_1.default;
-const writeHeadingIds_1 = (0, tslib_1.__importDefault)(require("./commands/writeHeadingIds"));
-exports.writeHeadingIds = writeHeadingIds_1.default;
-const writeTranslations_1 = (0, tslib_1.__importDefault)(require("./commands/writeTranslations"));
-exports.writeTranslations = writeTranslations_1.default;
+var build_1 = require("./commands/build");
+Object.defineProperty(exports, "build", { enumerable: true, get: function () { return build_1.build; } });
+var clear_1 = require("./commands/clear");
+Object.defineProperty(exports, "clear", { enumerable: true, get: function () { return clear_1.clear; } });
+var deploy_1 = require("./commands/deploy");
+Object.defineProperty(exports, "deploy", { enumerable: true, get: function () { return deploy_1.deploy; } });
+var external_1 = require("./commands/external");
+Object.defineProperty(exports, "externalCommand", { enumerable: true, get: function () { return external_1.externalCommand; } });
+var serve_1 = require("./commands/serve");
+Object.defineProperty(exports, "serve", { enumerable: true, get: function () { return serve_1.serve; } });
+var start_1 = require("./commands/start");
+Object.defineProperty(exports, "start", { enumerable: true, get: function () { return start_1.start; } });
+var swizzle_1 = require("./commands/swizzle");
+Object.defineProperty(exports, "swizzle", { enumerable: true, get: function () { return swizzle_1.swizzle; } });
+var writeHeadingIds_1 = require("./commands/writeHeadingIds");
+Object.defineProperty(exports, "writeHeadingIds", { enumerable: true, get: function () { return writeHeadingIds_1.writeHeadingIds; } });
+var writeTranslations_1 = require("./commands/writeTranslations");
+Object.defineProperty(exports, "writeTranslations", { enumerable: true, get: function () { return writeTranslations_1.writeTranslations; } });

package/lib/server/brokenLinks.d.ts

@@ -5,25 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { RouteConfig, ReportingSeverity } from '@docusaurus/types';
-declare type BrokenLink = {
-    link: string;
-    resolvedLink: string;
-};
-export declare function getAllBrokenLinks({ allCollectedLinks, routes, }: {
-    allCollectedLinks: Record<string, string[]>;
-    routes: RouteConfig[];
-}): Record<string, BrokenLink[]>;
-export declare function getBrokenLinksErrorMessage(allBrokenLinks: Record<string, BrokenLink[]>): string | undefined;
-export declare function filterExistingFileLinks({ baseUrl, outDir, allCollectedLinks, }: {
-    baseUrl: string;
-    outDir: string;
-    allCollectedLinks: Record<string, string[]>;
-}): Promise<Record<string, string[]>>;
 export declare function handleBrokenLinks({ allCollectedLinks, onBrokenLinks, routes, baseUrl, outDir, }: {
-    allCollectedLinks: Record<string, string[]>;
+    allCollectedLinks: {
+        [location: string]: string[];
+    };
     onBrokenLinks: ReportingSeverity;
     routes: RouteConfig[];
     baseUrl: string;
     outDir: string;
 }): Promise<void>;
-export {};

package/lib/server/brokenLinks.js

@@ -6,36 +6,35 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleBrokenLinks = exports.filterExistingFileLinks = exports.getBrokenLinksErrorMessage = exports.getAllBrokenLinks = void 0;
+exports.handleBrokenLinks = void 0;
 const tslib_1 = require("tslib");
 const react_router_config_1 = require("react-router-config");
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 const utils_2 = require("./utils");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const combine_promises_1 = (0, tslib_1.__importDefault)(require("combine-promises"));
-function toReactRouterRoutes(routes) {
-    // @ts-expect-error: types incompatible???
-    return routes;
-}
+const path_1 = tslib_1.__importDefault(require("path"));
+const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 // matchRoutes does not support qs/anchors, so we remove it!
 function onlyPathname(link) {
     return link.split('#')[0].split('?')[0];
 }
 function getPageBrokenLinks({ pagePath, pageLinks, routes, }) {
-    // ReactRouter is able to support links like ./../somePath
-    // but matchRoutes does not do this resolving internally
-    // we must resolve the links before using matchRoutes
-    // resolvePathname is used internally by ReactRouter
+    // ReactRouter is able to support links like ./../somePath but `matchRoutes`
+    // does not do this resolution internally. We must resolve the links before
+    // using `matchRoutes`. `resolvePathname` is used internally by React Router
     function resolveLink(link) {
         const resolvedLink = (0, utils_1.resolvePathname)(onlyPathname(link), pagePath);
         return { link, resolvedLink };
     }
     function isBrokenLink(link) {
         const matchedRoutes = [link, decodeURI(link)]
-            .map((l) => (0, react_router_config_1.matchRoutes)(toReactRouterRoutes(routes), l))
-            .reduce((prev, cur) => prev.concat(cur));
+            // @ts-expect-error: React router types RouteConfig with an actual React
+            // component, but we load route components with string paths.
+            // We don't actually access component here, so it's fine.
+            .map((l) => (0, react_router_config_1.matchRoutes)(routes, l))
+            .flat();
         return matchedRoutes.length === 0;
     }
     return pageLinks.map(resolveLink).filter((l) => isBrokenLink(l.resolvedLink));
@@ -43,8 +42,8 @@ function getPageBrokenLinks({ pagePath, pageLinks, routes, }) {
 /**
  * The route defs can be recursive, and have a parent match-all route. We don't
  * want to match broken links like /docs/brokenLink against /docs/*. For this
- * reason, we only consider the "final routes", that do not have subroutes.
- * We also need to remove the match all 404 route
+ * reason, we only consider the "final routes" that do not have subroutes.
+ * We also need to remove the match-all 404 route
  */
 function filterIntermediateRoutes(routesInput) {
     const routesWithout404 = routesInput.filter((route) => route.path !== '*');
@@ -53,10 +52,8 @@ function filterIntermediateRoutes(routesInput) {
 function getAllBrokenLinks({ allCollectedLinks, routes, }) {
     const filteredRoutes = filterIntermediateRoutes(routes);
     const allBrokenLinks = lodash_1.default.mapValues(allCollectedLinks, (pageLinks, pagePath) => getPageBrokenLinks({ pageLinks, pagePath, routes: filteredRoutes }));
-    // remove pages without any broken link
     return lodash_1.default.pickBy(allBrokenLinks, (brokenLinks) => brokenLinks.length > 0);
 }
-exports.getAllBrokenLinks = getAllBrokenLinks;
 function getBrokenLinksErrorMessage(allBrokenLinks) {
     if (Object.keys(allBrokenLinks).length === 0) {
         return undefined;
@@ -66,7 +63,9 @@ function getBrokenLinksErrorMessage(allBrokenLinks) {
         return `${brokenLink.link}${showResolvedLink ? ` (resolved as: ${brokenLink.resolvedLink})` : ''}`;
     }
     function pageBrokenLinksMessage(pagePath, brokenLinks) {
-        return `\n- On source page path = ${pagePath}:\n   -> linking to ${brokenLinks
+        return `
+- On source page path = ${pagePath}:
+   -> linking to ${brokenLinks
             .map(brokenLinkMessage)
             .join('\n   -> linking to ')}`;
     }
@@ -85,15 +84,24 @@ function getBrokenLinksErrorMessage(allBrokenLinks) {
         if (frequentLinks.length === 0) {
             return '';
         }
-        return `\n\nIt looks like some of the broken links we found appear in many pages of your site.\nMaybe those broken links appear on all pages through your site layout?\nWe recommend that you check your theme configuration for such links (particularly, theme navbar and footer).\nFrequent broken links are linking to:\n- ${frequentLinks.join(`\n- `)}\n`;
+        return logger_1.default.interpolate `
+
+It looks like some of the broken links we found appear in many pages of your site.
+Maybe those broken links appear on all pages through your site layout?
+We recommend that you check your theme configuration for such links (particularly, theme navbar and footer).
+Frequent broken links are linking to:${frequentLinks}`;
     }
-    return (`Docusaurus found broken links!\n\nPlease check the pages of your site in the list below, and make sure you don't reference any path that does not exist.\nNote: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.${getLayoutBrokenLinksHelpMessage()}` +
-        `\n\nExhaustive list of all broken links found:\n${Object.entries(allBrokenLinks)
-            .map(([pagePath, brokenLinks]) => pageBrokenLinksMessage(pagePath, brokenLinks))
-            .join('\n')}
-`);
+    return `Docusaurus found broken links!
+
+Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
+Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.${getLayoutBrokenLinksHelpMessage()}
+
+Exhaustive list of all broken links found:
+${Object.entries(allBrokenLinks)
+        .map(([pagePath, brokenLinks]) => pageBrokenLinksMessage(pagePath, brokenLinks))
+        .join('\n')}
+`;
 }
-exports.getBrokenLinksErrorMessage = getBrokenLinksErrorMessage;
 async function isExistingFile(filePath) {
     try {
         return (await fs_extra_1.default.stat(filePath)).isFile();
@@ -107,14 +115,13 @@ async function isExistingFile(filePath) {
 async function filterExistingFileLinks({ baseUrl, outDir, allCollectedLinks, }) {
     async function linkFileExists(link) {
         // /baseUrl/javadoc/ -> /outDir/javadoc
-        const baseFilePath = (0, utils_1.removeSuffix)(`${outDir}/${(0, utils_1.removePrefix)(link, baseUrl)}`, '/');
+        const baseFilePath = onlyPathname((0, utils_1.removeSuffix)(`${outDir}/${(0, utils_1.removePrefix)(link, baseUrl)}`, '/'));
         // -> /outDir/javadoc
         // -> /outDir/javadoc.html
         // -> /outDir/javadoc/index.html
         const filePathsToTry = [baseFilePath];
         if (!path_1.default.extname(baseFilePath)) {
-            filePathsToTry.push(`${baseFilePath}.html`);
-            filePathsToTry.push(path_1.default.join(baseFilePath, 'index.html'));
+            filePathsToTry.push(`${baseFilePath}.html`, path_1.default.join(baseFilePath, 'index.html'));
         }
         for (const file of filePathsToTry) {
             if (await isExistingFile(file)) {
@@ -125,7 +132,6 @@ async function filterExistingFileLinks({ baseUrl, outDir, allCollectedLinks, })
     }
     return (0, combine_promises_1.default)(lodash_1.default.mapValues(allCollectedLinks, async (links) => (await Promise.all(links.map(async (link) => ((await linkFileExists(link)) ? '' : link)))).filter(Boolean)));
 }
-exports.filterExistingFileLinks = filterExistingFileLinks;
 async function handleBrokenLinks({ allCollectedLinks, onBrokenLinks, routes, baseUrl, outDir, }) {
     if (onBrokenLinks === 'ignore') {
         return;

package/lib/server/clientModules.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 { LoadedPlugin } from '@docusaurus/types';
+/**
+ * Runs the `getClientModules` lifecycle. The returned file paths are all
+ * absolute.
+ */
+export declare function loadClientModules(plugins: LoadedPlugin[]): string[];

package/lib/server/clientModules.js

@@ -0,0 +1,20 @@
+"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.loadClientModules = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+/**
+ * Runs the `getClientModules` lifecycle. The returned file paths are all
+ * absolute.
+ */
+function loadClientModules(plugins) {
+    return plugins.flatMap((plugin) => plugin.getClientModules?.().map((p) => path_1.default.resolve(plugin.path, p)) ??
+        []);
+}
+exports.loadClientModules = loadClientModules;

package/lib/server/config.d.ts

@@ -4,5 +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 type { DocusaurusConfig } from '@docusaurus/types';
-export default function loadConfig(configPath: string): Promise<DocusaurusConfig>;
+import type { LoadContext } from '@docusaurus/types';
+export declare function loadSiteConfig({ siteDir, customConfigFilePath, }: {
+    siteDir: string;
+    customConfigFilePath?: string;
+}): Promise<Pick<LoadContext, 'siteConfig' | 'siteConfigPath'>>;

package/lib/server/config.js

@@ -6,18 +6,23 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadSiteConfig = void 0;
 const tslib_1 = require("tslib");
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const import_fresh_1 = (0, tslib_1.__importDefault)(require("import-fresh"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
+const utils_1 = require("@docusaurus/utils");
 const configValidation_1 = require("./configValidation");
-async function loadConfig(configPath) {
-    if (!(await fs_extra_1.default.pathExists(configPath))) {
-        throw new Error(`Config file at "${configPath}" not found.`);
+async function loadSiteConfig({ siteDir, customConfigFilePath, }) {
+    const siteConfigPath = path_1.default.resolve(siteDir, customConfigFilePath ?? utils_1.DEFAULT_CONFIG_FILE_NAME);
+    if (!(await fs_extra_1.default.pathExists(siteConfigPath))) {
+        throw new Error(`Config file at "${siteConfigPath}" not found.`);
     }
-    const importedConfig = (0, import_fresh_1.default)(configPath);
-    const loadedConfig = importedConfig instanceof Function
+    const importedConfig = (0, import_fresh_1.default)(siteConfigPath);
+    const loadedConfig = typeof importedConfig === 'function'
         ? await importedConfig()
         : await importedConfig;
-    return (0, configValidation_1.validateConfig)(loadedConfig);
+    const siteConfig = (0, configValidation_1.validateConfig)(loadedConfig);
+    return { siteConfig, siteConfigPath };
 }
-exports.default = loadConfig;
+exports.loadSiteConfig = loadSiteConfig;

package/lib/server/configValidation.d.ts

@@ -7,6 +7,6 @@
 import type { DocusaurusConfig, I18nConfig } from '@docusaurus/types';
 import { Joi } from '@docusaurus/utils-validation';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
-export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories'>;
+export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories'>;
 export declare const ConfigSchema: Joi.ObjectSchema<any>;
 export declare function validateConfig(config: Partial<DocusaurusConfig>): DocusaurusConfig;

package/lib/server/configValidation.js

@@ -23,19 +23,24 @@ exports.DEFAULT_CONFIG = {
     plugins: [],
     themes: [],
     presets: [],
+    stylesheets: [],
+    scripts: [],
+    clientModules: [],
     customFields: {},
     themeConfig: {},
     titleDelimiter: '|',
     noIndex: false,
     tagline: '',
     baseUrlIssueBanner: true,
-    staticDirectories: [utils_1.STATIC_DIR_NAME],
+    staticDirectories: [utils_1.DEFAULT_STATIC_DIR_NAME],
 };
-function createPluginSchema(theme = false) {
+function createPluginSchema(theme) {
     return (utils_validation_1.Joi.alternatives()
-        .try(utils_validation_1.Joi.function(), utils_validation_1.Joi.array().ordered(utils_validation_1.Joi.function().required(), utils_validation_1.Joi.object().required()), utils_validation_1.Joi.string(), utils_validation_1.Joi.array()
+        .try(utils_validation_1.Joi.function(), utils_validation_1.Joi.array()
+        .ordered(utils_validation_1.Joi.function().required(), utils_validation_1.Joi.object().required())
+        .length(2), utils_validation_1.Joi.string(), utils_validation_1.Joi.array()
         .ordered(utils_validation_1.Joi.string().required(), utils_validation_1.Joi.object().required())
-        .length(2), utils_validation_1.Joi.bool().equal(false))
+        .length(2), utils_validation_1.Joi.any().valid(false, null))
         // @ts-expect-error: bad lib def, doesn't recognize an array of reports
         .error((errors) => {
         errors.forEach((error) => {
@@ -69,11 +74,20 @@ ${validConfigExample}
 }
 const PluginSchema = createPluginSchema(false);
 const ThemeSchema = createPluginSchema(true);
-const PresetSchema = utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required(), utils_validation_1.Joi.object().required()).length(2));
+const PresetSchema = utils_validation_1.Joi.alternatives()
+    .try(utils_validation_1.Joi.string(), utils_validation_1.Joi.array()
+    .items(utils_validation_1.Joi.string().required(), utils_validation_1.Joi.object().required())
+    .length(2), utils_validation_1.Joi.any().valid(false, null))
+    .messages({
+    'alternatives.types': `{#label} does not look like a valid preset config. A preset config entry should be one of:
+- A tuple of [presetName, options], like \`["classic", \\{ blog: false \\}]\`, or
+- A simple string, like \`"classic"\``,
+});
 const LocaleConfigSchema = utils_validation_1.Joi.object({
     label: utils_validation_1.Joi.string(),
     htmlLang: utils_validation_1.Joi.string(),
     direction: utils_validation_1.Joi.string().equal('ltr', 'rtl').default('ltr'),
+    calendar: utils_validation_1.Joi.string(),
 });
 const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     defaultLocale: utils_validation_1.Joi.string().required(),
@@ -129,22 +143,34 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
     themes: utils_validation_1.Joi.array().items(ThemeSchema).default(exports.DEFAULT_CONFIG.themes),
     presets: utils_validation_1.Joi.array().items(PresetSchema).default(exports.DEFAULT_CONFIG.presets),
     themeConfig: utils_validation_1.Joi.object().unknown().default(exports.DEFAULT_CONFIG.themeConfig),
-    scripts: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
+    scripts: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
         src: utils_validation_1.Joi.string().required(),
         async: utils_validation_1.Joi.bool(),
         defer: utils_validation_1.Joi.bool(),
     })
         // See https://github.com/facebook/docusaurus/issues/3378
-        .unknown()),
+        .unknown())
+        .messages({
+        'array.includes': '{#label} is invalid. A script must be a plain string (the src), or an object with at least a "src" property.',
+    })
+        .default(exports.DEFAULT_CONFIG.scripts),
     ssrTemplate: utils_validation_1.Joi.string(),
-    stylesheets: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
+    stylesheets: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
         href: utils_validation_1.Joi.string().required(),
         type: utils_validation_1.Joi.string(),
-    }).unknown()),
-    clientModules: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()),
+    }).unknown())
+        .messages({
+        'array.includes': '{#label} is invalid. A stylesheet must be a plain string (the href), or an object with at least a "href" property.',
+    })
+        .default(exports.DEFAULT_CONFIG.stylesheets),
+    clientModules: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.string())
+        .default(exports.DEFAULT_CONFIG.clientModules),
     tagline: utils_validation_1.Joi.string().allow('').default(exports.DEFAULT_CONFIG.tagline),
-    titleDelimiter: utils_validation_1.Joi.string().default('|'),
-    noIndex: utils_validation_1.Joi.bool().default(false),
+    titleDelimiter: utils_validation_1.Joi.string().default(exports.DEFAULT_CONFIG.titleDelimiter),
+    noIndex: utils_validation_1.Joi.bool().default(exports.DEFAULT_CONFIG.noIndex),
     webpack: utils_validation_1.Joi.object({
         jsLoader: utils_validation_1.Joi.alternatives()
             .try(utils_validation_1.Joi.string().equal('babel'), utils_validation_1.Joi.function())
@@ -170,7 +196,7 @@ function validateConfig(config) {
             ? `${accumulatedErr}${err.message}\n`
             : accumulatedErr, '');
         formattedError = unknownFields
-            ? `${formattedError}These field(s) (${unknownFields}) are not recognized in ${utils_1.DEFAULT_CONFIG_FILE_NAME}.\nIf you still want these fields to be in your configuration, put them in the "customFields" field.\nSee https://docusaurus.io/docs/docusaurus.config.js/#customfields`
+            ? `${formattedError}These field(s) (${unknownFields}) are not recognized in ${utils_1.DEFAULT_CONFIG_FILE_NAME}.\nIf you still want these fields to be in your configuration, put them in the "customFields" field.\nSee https://docusaurus.io/docs/api/docusaurus-config/#customfields`
             : formattedError;
         throw new Error(formattedError);
     }

package/lib/server/getHostPort.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+export declare type HostPortOptions = {
+    host?: string;
+    port?: string;
+};
+export declare function getHostPort(options: HostPortOptions): Promise<{
+    host: string;
+    port: number | null;
+}>;