@docusaurus/core 3.8.1-canary-6372 → 3.8.1-canary-6374

package/lib/client/exports/ComponentCreator.js

@@ -44,7 +44,6 @@ export default function ComponentCreator(path, hash) {
     Object.entries(flatChunkNames).forEach(([keyPath, chunkName]) => {
         const chunkRegistry = registry[chunkName];
         if (chunkRegistry) {
-            // eslint-disable-next-line prefer-destructuring
             loader[keyPath] = chunkRegistry[0];
             modules.push(chunkRegistry[1]);
             optsWebpack.push(chunkRegistry[2]);

package/lib/commands/build/build.js

@@ -14,6 +14,7 @@ const utils_1 = require("@docusaurus/utils");
 const site_1 = require("../../server/site");
 const i18n_1 = require("../../server/i18n");
 const buildLocale_1 = require("./buildLocale");
+const buildUtils_1 = require("./buildUtils");
 async function build(siteDirParam = '.', cliOptions = {}) {
     process.env.BABEL_ENV = 'production';
     process.env.NODE_ENV = 'production';
@@ -49,19 +50,19 @@ function orderLocales({ locales, defaultLocale, }) {
     }
 }
 async function getLocalesToBuild({ siteDir, cliOptions, }) {
-    // We disable locale path localization if CLI has single "--locale" option
-    // yarn build --locale fr => baseUrl=/ instead of baseUrl=/fr/
-    const localizePath = cliOptions.locale?.length === 1 ? false : undefined;
+    // TODO we shouldn't need to load all context + i18n just to get that list
+    // only loading siteConfig should be enough
     const context = await (0, site_1.loadContext)({
         siteDir,
         outDir: cliOptions.outDir,
         config: cliOptions.config,
-        localizePath,
+        automaticBaseUrlLocalizationDisabled: (0, buildUtils_1.isAutomaticBaseUrlLocalizationDisabled)(cliOptions),
     });
     const i18n = await (0, i18n_1.loadI18n)({
         siteDir,
         config: context.siteConfig,
-        currentLocale: context.siteConfig.i18n.defaultLocale // Awkward but ok
+        currentLocale: context.siteConfig.i18n.defaultLocale, // Awkward but ok
+        automaticBaseUrlLocalizationDisabled: false,
     });
     const locales = cliOptions.locale ?? i18n.locales;
     return orderLocales({

package/lib/commands/build/buildLocale.js

@@ -20,6 +20,7 @@ const server_1 = tslib_1.__importDefault(require("../../webpack/server"));
 const configure_1 = require("../../webpack/configure");
 const ssgExecutor_1 = require("../../ssg/ssgExecutor");
 const clearPath_1 = tslib_1.__importDefault(require("../utils/clearPath"));
+const buildUtils_1 = require("./buildUtils");
 const SkipBundling = process.env.DOCUSAURUS_SKIP_BUNDLING === 'true';
 const ExitAfterLoading = process.env.DOCUSAURUS_EXIT_AFTER_LOADING === 'true';
 const ExitAfterBundling = process.env.DOCUSAURUS_EXIT_AFTER_BUNDLING === 'true';
@@ -34,7 +35,7 @@ async function buildLocale({ siteDir, locale, cliOptions, }) {
         outDir: cliOptions.outDir,
         config: cliOptions.config,
         locale,
-        localizePath: cliOptions.locale?.length === 1 ? false : undefined,
+        automaticBaseUrlLocalizationDisabled: (0, buildUtils_1.isAutomaticBaseUrlLocalizationDisabled)(cliOptions),
     }));
     if (ExitAfterLoading) {
         return process.exit(0);

package/lib/commands/build/buildUtils.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.
+ */
+import { BuildCLIOptions } from './build';
+/**
+ * We disable locale path localization if CLI has a single "--locale" option
+ * yarn build --locale fr => baseUrl=/ instead of baseUrl=/fr/
+ * By default, this makes it easier to support multi-domain deployments
+ * See https://docusaurus.io/docs/i18n/tutorial#multi-domain-deployment
+ */
+export declare function isAutomaticBaseUrlLocalizationDisabled(cliOptions: BuildCLIOptions): boolean;

package/lib/commands/build/buildUtils.js

@@ -0,0 +1,18 @@
+"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.isAutomaticBaseUrlLocalizationDisabled = isAutomaticBaseUrlLocalizationDisabled;
+/**
+ * We disable locale path localization if CLI has a single "--locale" option
+ * yarn build --locale fr => baseUrl=/ instead of baseUrl=/fr/
+ * By default, this makes it easier to support multi-domain deployments
+ * See https://docusaurus.io/docs/i18n/tutorial#multi-domain-deployment
+ */
+function isAutomaticBaseUrlLocalizationDisabled(cliOptions) {
+    return cliOptions.locale?.length === 1;
+}

package/lib/commands/start/utils.js

@@ -53,7 +53,6 @@ async function createLoadSiteParams({ siteDirParam, cliOptions, }) {
         siteDir,
         config: cliOptions.config,
         locale: cliOptions.locale,
-        localizePath: undefined, // Should this be configurable?
     };
 }
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types

package/lib/server/configValidation.js

@@ -14,6 +14,28 @@ const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_common_1 = require("@docusaurus/utils-common");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const DEFAULT_I18N_LOCALE = 'en';
+const SiteUrlSchema = utils_validation_1.Joi.string()
+    .custom((value, helpers) => {
+    try {
+        const { pathname } = new URL(value);
+        if (pathname !== '/') {
+            return helpers.error('docusaurus.subPathError', { pathname });
+        }
+    }
+    catch {
+        return helpers.error('any.invalid');
+    }
+    return (0, utils_common_1.removeTrailingSlash)(value);
+})
+    .messages({
+    'any.invalid': '"{#value}" does not look like a valid URL. Make sure it has a protocol; for example, "https://example.com".',
+    'docusaurus.subPathError': 'The url is not supposed to contain a sub-path like "{#pathname}". Please use the baseUrl field for sub-paths.',
+});
+const BaseUrlSchema = utils_validation_1.Joi
+    // Weird Joi trick needed, otherwise value '' is not normalized...
+    .alternatives()
+    .try(utils_validation_1.Joi.string().required().allow(''))
+    .custom((value) => (0, utils_common_1.addLeadingSlash)((0, utils_common_1.addTrailingSlash)(value)));
 exports.DEFAULT_I18N_CONFIG = {
     defaultLocale: DEFAULT_I18N_LOCALE,
     path: utils_1.DEFAULT_I18N_DIR_NAME,
@@ -155,9 +177,11 @@ const PresetSchema = utils_validation_1.Joi.alternatives()
 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'),
+    direction: utils_validation_1.Joi.string().equal('ltr', 'rtl'),
     calendar: utils_validation_1.Joi.string(),
     path: utils_validation_1.Joi.string(),
+    url: SiteUrlSchema,
+    baseUrl: BaseUrlSchema,
 });
 const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     defaultLocale: utils_validation_1.Joi.string().required(),
@@ -213,36 +237,13 @@ const FUTURE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
 })
     .optional()
     .default(exports.DEFAULT_FUTURE_CONFIG);
-const SiteUrlSchema = utils_validation_1.Joi.string()
-    .required()
-    .custom((value, helpers) => {
-    try {
-        const { pathname } = new URL(value);
-        if (pathname !== '/') {
-            return helpers.error('docusaurus.subPathError', { pathname });
-        }
-    }
-    catch {
-        return helpers.error('any.invalid');
-    }
-    return (0, utils_common_1.removeTrailingSlash)(value);
-})
-    .messages({
-    'any.invalid': '"{#value}" does not look like a valid URL. Make sure it has a protocol; for example, "https://example.com".',
-    'docusaurus.subPathError': 'The url is not supposed to contain a sub-path like "{#pathname}". Please use the baseUrl field for sub-paths.',
-});
 // TODO move to @docusaurus/utils-validation
 exports.ConfigSchema = utils_validation_1.Joi.object({
-    baseUrl: utils_validation_1.Joi
-        // Weird Joi trick needed, otherwise value '' is not normalized...
-        .alternatives()
-        .try(utils_validation_1.Joi.string().required().allow(''))
-        .required()
-        .custom((value) => (0, utils_common_1.addLeadingSlash)((0, utils_common_1.addTrailingSlash)(value))),
+    url: SiteUrlSchema.required(),
+    baseUrl: BaseUrlSchema.required(),
     baseUrlIssueBanner: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.baseUrlIssueBanner),
     favicon: utils_validation_1.Joi.string().optional(),
     title: utils_validation_1.Joi.string().required(),
-    url: SiteUrlSchema,
     trailingSlash: utils_validation_1.Joi.boolean(), // No default value! undefined = retrocompatible legacy behavior!
     i18n: I18N_CONFIG_SCHEMA,
     future: FUTURE_CONFIG_SCHEMA,

package/lib/server/i18n.d.ts

@@ -5,9 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { I18n, DocusaurusConfig, I18nLocaleConfig } from '@docusaurus/types';
-export declare function getDefaultLocaleConfig(locale: string): Omit<I18nLocaleConfig, 'translate'>;
-export declare function loadI18n({ siteDir, config, currentLocale, }: {
+export declare function getDefaultLocaleConfig(locale: string): Omit<I18nLocaleConfig, 'translate' | 'url' | 'baseUrl'>;
+export declare function loadI18n({ siteDir, config, currentLocale, automaticBaseUrlLocalizationDisabled, }: {
     siteDir: string;
     config: DocusaurusConfig;
     currentLocale: string;
+    automaticBaseUrlLocalizationDisabled: boolean;
 }): Promise<I18n>;

package/lib/server/i18n.js

@@ -13,6 +13,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
+const utils_1 = require("@docusaurus/utils");
 function inferLanguageDisplayName(locale) {
     const tryLocale = (l) => {
         try {
@@ -83,7 +84,7 @@ function getDefaultLocaleConfig(locale) {
         throw new Error(`Docusaurus couldn't get default locale config for ${locale}`, { cause: e });
     }
 }
-async function loadI18n({ siteDir, config, currentLocale, }) {
+async function loadI18n({ siteDir, config, currentLocale, automaticBaseUrlLocalizationDisabled, }) {
     const { i18n: i18nConfig } = config;
     if (!i18nConfig.locales.includes(currentLocale)) {
         logger_1.default.warn `The locale name=${currentLocale} was not found in your site configuration: Available locales are: ${i18nConfig.locales}
@@ -103,10 +104,28 @@ Note: Docusaurus only support running one locale at a time.`;
             const localizationDir = path_1.default.resolve(siteDir, i18nConfig.path, localeConfig.path);
             return fs_extra_1.default.pathExists(localizationDir);
         }
+        function getInferredBaseUrl() {
+            const addLocaleSegment = locale !== i18nConfig.defaultLocale &&
+                !automaticBaseUrlLocalizationDisabled;
+            return (0, utils_1.normalizeUrl)([
+                '/',
+                config.baseUrl,
+                addLocaleSegment ? locale : '',
+                '/',
+            ]);
+        }
         const translate = localeConfigInput.translate ?? (await inferTranslate());
+        const url = typeof localeConfigInput.url !== 'undefined'
+            ? localeConfigInput.url
+            : config.url;
+        const baseUrl = typeof localeConfigInput.baseUrl !== 'undefined'
+            ? (0, utils_1.normalizeUrl)(['/', localeConfigInput.baseUrl, '/'])
+            : getInferredBaseUrl();
         return {
             ...localeConfig,
             translate,
+            url,
+            baseUrl,
         };
     }
     const localeConfigs = await (0, combine_promises_1.default)(Object.fromEntries(locales.map((locale) => [locale, getFullLocaleConfig(locale)])));

package/lib/server/site.d.ts

@@ -15,12 +15,19 @@ export type LoadContextParams = {
     /** Default is `i18n.defaultLocale` */
     locale?: string;
     /**
-     * `true` means the paths will have the locale prepended; `false` means they
-     * won't (useful for `yarn build -l zh-Hans` where the output should be
-     * emitted into `build/` instead of `build/zh-Hans/`); `undefined` is like the
-     * "smart" option where only non-default locale paths are localized
+     * By default, we try to automatically infer a localized baseUrl.
+     * We prepend `/<siteBaseUrl>/` with a `/<locale>/` path segment,
+     * except for the default locale.
+     *
+     * This option permits opting out of this baseUrl localization process.
+     * It is mostly useful to simplify config for multi-domain i18n deployments.
+     * See https://docusaurus.io/docs/i18n/tutorial#multi-domain-deployment
+     *
+     * In all cases, this process doesn't happen if an explicit localized baseUrl
+     * has been provided using `i18n.localeConfigs[].baseUrl`. We always use the
+     * provided value over the inferred one, letting you override it.
      */
-    localizePath?: boolean;
+    automaticBaseUrlLocalizationDisabled?: boolean;
 };
 export type LoadSiteParams = LoadContextParams & {
     isReload?: boolean;

package/lib/server/site.js

@@ -34,7 +34,7 @@ const siteMessages_1 = require("./siteMessages");
  * to plugin constructors.
  */
 async function loadContext(params) {
-    const { siteDir, outDir: baseOutDir = utils_1.DEFAULT_BUILD_DIR_NAME, locale, config: customConfigFilePath, } = params;
+    const { siteDir, outDir: baseOutDir = utils_1.DEFAULT_BUILD_DIR_NAME, locale, config: customConfigFilePath, automaticBaseUrlLocalizationDisabled, } = params;
     const generatedFilesDir = path_1.default.resolve(siteDir, utils_1.GENERATED_FILES_DIR_NAME);
     const { siteVersion, loadSiteConfig: { siteConfig: initialSiteConfig, siteConfigPath }, } = await (0, combine_promises_1.default)({
         siteVersion: (0, siteMetadata_1.loadSiteVersion)(siteDir),
@@ -50,21 +50,19 @@ async function loadContext(params) {
         siteDir,
         config: initialSiteConfig,
         currentLocale: locale ?? initialSiteConfig.i18n.defaultLocale,
+        automaticBaseUrlLocalizationDisabled: automaticBaseUrlLocalizationDisabled ?? false,
     });
-    const baseUrl = (0, utils_1.localizePath)({
-        path: initialSiteConfig.baseUrl,
-        i18n,
-        options: params,
-        pathType: 'url',
-    });
-    const outDir = (0, utils_1.localizePath)({
-        path: path_1.default.resolve(siteDir, baseOutDir),
-        i18n,
-        options: params,
-        pathType: 'fs',
-    });
+    const localeConfig = (0, utils_1.getLocaleConfig)(i18n);
+    // We use the baseUrl from the locale config.
+    // By default, it is inferred as /<siteConfig.baseUrl>/
+    // eventually including the /<locale>/ suffix
+    const baseUrl = localeConfig.baseUrl;
+    const outDir = path_1.default.join(path_1.default.resolve(siteDir, baseOutDir), baseUrl);
     const localizationDir = path_1.default.resolve(siteDir, i18n.path, (0, utils_1.getLocaleConfig)(i18n).path);
-    const siteConfig = { ...initialSiteConfig, baseUrl };
+    const siteConfig = {
+        ...initialSiteConfig,
+        baseUrl,
+    };
     const codeTranslations = await (0, translations_1.loadSiteCodeTranslations)({ localizationDir });
     const siteStorage = (0, storage_1.createSiteStorage)(siteConfig);
     return {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.8.1-canary-6372",
+  "version": "3.8.1-canary-6374",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.8.1-canary-6372",
-    "@docusaurus/bundler": "3.8.1-canary-6372",
-    "@docusaurus/logger": "3.8.1-canary-6372",
-    "@docusaurus/mdx-loader": "3.8.1-canary-6372",
-    "@docusaurus/utils": "3.8.1-canary-6372",
-    "@docusaurus/utils-common": "3.8.1-canary-6372",
-    "@docusaurus/utils-validation": "3.8.1-canary-6372",
+    "@docusaurus/babel": "3.8.1-canary-6374",
+    "@docusaurus/bundler": "3.8.1-canary-6374",
+    "@docusaurus/logger": "3.8.1-canary-6374",
+    "@docusaurus/mdx-loader": "3.8.1-canary-6374",
+    "@docusaurus/utils": "3.8.1-canary-6374",
+    "@docusaurus/utils-common": "3.8.1-canary-6374",
+    "@docusaurus/utils-validation": "3.8.1-canary-6374",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -77,8 +77,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.8.1-canary-6372",
-    "@docusaurus/types": "3.8.1-canary-6372",
+    "@docusaurus/module-type-aliases": "3.8.1-canary-6374",
+    "@docusaurus/types": "3.8.1-canary-6374",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -98,5 +98,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "0229ae8aadbcfbebd1f49b3bdd174bea21ae93d4"
+  "gitHead": "d7c2ad4c6a14ff1185b4ee7bef89cd56c15d3869"
 }