@docusaurus/core 3.9.2-canary-6437 → 3.9.2-canary-6439

package/lib/commands/build/build.js

@@ -54,7 +54,7 @@ async function getLocalesToBuild({ siteDir, cliOptions, }) {
         customConfigFilePath: cliOptions.config,
     });
     const locales = cliOptions.locale ??
-        (0, i18n_1.loadI18nLocaleList)({
+        (0, i18n_1.getLocaleList)({
             i18nConfig: siteConfig.i18n,
             currentLocale: siteConfig.i18n.defaultLocale, // Awkward but ok
         });

package/lib/commands/build/buildLocale.js

@@ -22,6 +22,7 @@ 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 ReturnAfterLoading = process.env.DOCUSAURUS_RETURN_AFTER_LOADING === 'true';
 const ExitAfterLoading = process.env.DOCUSAURUS_EXIT_AFTER_LOADING === 'true';
 const ExitAfterBundling = process.env.DOCUSAURUS_EXIT_AFTER_BUNDLING === 'true';
 async function buildLocale({ siteDir, locale, cliOptions, }) {
@@ -37,6 +38,9 @@ async function buildLocale({ siteDir, locale, cliOptions, }) {
         locale,
         automaticBaseUrlLocalizationDisabled: (0, buildUtils_1.isAutomaticBaseUrlLocalizationDisabled)(cliOptions),
     }));
+    if (ReturnAfterLoading) {
+        return;
+    }
     if (ExitAfterLoading) {
         return process.exit(0);
     }

package/lib/server/configValidation.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import type { FasterConfig, FutureConfig, FutureV4Config, StorageConfig, DocusaurusConfig, I18nConfig, MarkdownConfig, MarkdownHooks } from '@docusaurus/types';
+import type { DocusaurusConfig, FasterConfig, FutureConfig, FutureV4Config, I18nConfig, MarkdownConfig, MarkdownHooks, StorageConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
 export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
 export declare const DEFAULT_FASTER_CONFIG: FasterConfig;

package/lib/server/configValidation.js

@@ -55,6 +55,7 @@ exports.DEFAULT_FASTER_CONFIG = {
     rspackBundler: false,
     rspackPersistentCache: false,
     ssgWorkerThreads: false,
+    gitEagerVcs: false,
 };
 // When using the "faster: true" shortcut
 exports.DEFAULT_FASTER_CONFIG_TRUE = {
@@ -66,6 +67,7 @@ exports.DEFAULT_FASTER_CONFIG_TRUE = {
     rspackBundler: true,
     rspackPersistentCache: true,
     ssgWorkerThreads: true,
+    gitEagerVcs: true,
 };
 exports.DEFAULT_FUTURE_V4_CONFIG = {
     removeLegacyPostBuildHeadAttribute: false,
@@ -80,6 +82,7 @@ exports.DEFAULT_FUTURE_CONFIG = {
     v4: exports.DEFAULT_FUTURE_V4_CONFIG,
     experimental_faster: exports.DEFAULT_FASTER_CONFIG,
     experimental_storage: exports.DEFAULT_STORAGE_CONFIG,
+    experimental_vcs: (0, utils_1.getVcsPreset)('default-v1'),
     experimental_router: 'browser',
 };
 exports.DEFAULT_MARKDOWN_HOOKS = {
@@ -204,6 +207,7 @@ const FASTER_CONFIG_SCHEMA = utils_validation_1.Joi.alternatives()
     rspackBundler: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.rspackBundler),
     rspackPersistentCache: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.rspackPersistentCache),
     ssgWorkerThreads: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.ssgWorkerThreads),
+    gitEagerVcs: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.gitEagerVcs),
 }), utils_validation_1.Joi.boolean()
     .required()
     .custom((bool) => bool ? exports.DEFAULT_FASTER_CONFIG_TRUE : exports.DEFAULT_FASTER_CONFIG))
@@ -228,10 +232,39 @@ const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
 })
     .optional()
     .default(exports.DEFAULT_STORAGE_CONFIG);
+const VCS_CONFIG_OBJECT_SCHEMA = utils_validation_1.Joi.object({
+    // All the fields are required on purpose
+    // You either provide a full VCS config or nothing
+    initialize: utils_validation_1.Joi.function().maxArity(1).required(),
+    getFileCreationInfo: utils_validation_1.Joi.function().arity(1).required(),
+    getFileLastUpdateInfo: utils_validation_1.Joi.function().arity(1).required(),
+});
+const VCS_CONFIG_SCHEMA = utils_validation_1.Joi.custom((input) => {
+    if (typeof input === 'string') {
+        const presetName = input;
+        if (!utils_1.VcsPresetNames.includes(presetName)) {
+            throw new Error(`VCS config preset name '${input}' is not valid.`);
+        }
+        return (0, utils_1.getVcsPreset)(presetName);
+    }
+    if (typeof input === 'boolean') {
+        // We return the boolean on purpose
+        // We'll normalize it to a real VcsConfig later
+        // This is annoying, but we have to read the future flag to switch to the
+        // new "default-v2" config (not easy to do it here)
+        return input;
+    }
+    const { error, value } = VCS_CONFIG_OBJECT_SCHEMA.validate(input);
+    if (error) {
+        throw error;
+    }
+    return value;
+}).default(true);
 const FUTURE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     v4: FUTURE_V4_SCHEMA,
     experimental_faster: FASTER_CONFIG_SCHEMA,
     experimental_storage: STORAGE_CONFIG_SCHEMA,
+    experimental_vcs: VCS_CONFIG_SCHEMA,
     experimental_router: utils_validation_1.Joi.string()
         .equal('browser', 'hash')
         .default(exports.DEFAULT_FUTURE_CONFIG.experimental_router),
@@ -364,6 +397,15 @@ Please migrate and move this option to code=${'siteConfig.markdown.hooks.onBroke
         // We erase the former one to ensure we don't use it anywhere
         config.onBrokenMarkdownLinks = undefined;
     }
+    // We normalize the VCS config when using a boolean value
+    if (typeof config.future.experimental_vcs === 'boolean') {
+        const vcsConfig = config.future.experimental_vcs
+            ? config.future.experimental_faster.gitEagerVcs
+                ? (0, utils_1.getVcsPreset)('default-v2')
+                : (0, utils_1.getVcsPreset)('default-v1')
+            : (0, utils_1.getVcsPreset)('disabled');
+        config.future.experimental_vcs = vcsConfig;
+    }
     if (config.future.experimental_faster.ssgWorkerThreads &&
         !config.future.v4.removeLegacyPostBuildHeadAttribute) {
         throw new Error(`Docusaurus config ${logger_1.default.code('future.experimental_faster.ssgWorkerThreads')} requires the future flag ${logger_1.default.code('future.v4.removeLegacyPostBuildHeadAttribute')} to be turned on.

package/lib/server/i18n.d.ts

@@ -6,7 +6,7 @@
  */
 import type { I18n, DocusaurusConfig, I18nLocaleConfig, I18nConfig } from '@docusaurus/types';
 export declare function getDefaultLocaleConfig(locale: string): Omit<I18nLocaleConfig, 'translate' | 'url' | 'baseUrl'>;
-export declare function loadI18nLocaleList({ i18nConfig, currentLocale, }: {
+export declare function getLocaleList({ i18nConfig, currentLocale, }: {
     i18nConfig: I18nConfig;
     currentLocale: string;
 }): [string, ...string[]];

package/lib/server/i18n.js

@@ -7,7 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDefaultLocaleConfig = getDefaultLocaleConfig;
-exports.loadI18nLocaleList = loadI18nLocaleList;
+exports.getLocaleList = getLocaleList;
 exports.loadI18n = loadI18n;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -87,7 +87,7 @@ function getDefaultLocaleConfig(locale) {
 Make sure it is a valid BCP 47 locale name (e.g. en, fr, fr-FR, etc.) and/or provide a valid BCP 47 ${logger_1.default.code(`siteConfig.i18n.localeConfig['${locale}'].htmlLang`)} attribute.`, { cause: e });
     }
 }
-function loadI18nLocaleList({ i18nConfig, currentLocale, }) {
+function getLocaleList({ i18nConfig, currentLocale, }) {
     if (!i18nConfig.locales.includes(currentLocale)) {
         logger_1.default.warn `The locale name=${currentLocale} was not found in your Docusaurus site configuration.
 We recommend adding the name=${currentLocale} to your site i18n config, but we will still try to run your site.
@@ -98,7 +98,7 @@ Declared site config locales are: ${i18nConfig.locales}`;
 }
 async function loadI18n({ siteDir, config, currentLocale, automaticBaseUrlLocalizationDisabled, }) {
     const { i18n: i18nConfig } = config;
-    const locales = loadI18nLocaleList({
+    const locales = getLocaleList({
         i18nConfig,
         currentLocale,
     });

package/lib/server/site.js

@@ -43,6 +43,14 @@ async function loadContext(params) {
             customConfigFilePath,
         }),
     });
+    // Not sure where is the best place to put this VCS initialization call?
+    // The sooner is probably the better
+    // Note: we don't await the result on purpose!
+    // VCS initialization can be slow for large repos, and we don't want to block
+    // VCS integrations should be carefully designed to avoid blocking
+    logger_1.PerfLogger.async('VCS init', () => {
+        return initialSiteConfig.future.experimental_vcs.initialize({ siteDir });
+    });
     const currentBundler = await (0, bundler_1.getCurrentBundler)({
         siteConfig: initialSiteConfig,
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.9.2-canary-6437",
+  "version": "3.9.2-canary-6439",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.9.2-canary-6437",
-    "@docusaurus/bundler": "3.9.2-canary-6437",
-    "@docusaurus/logger": "3.9.2-canary-6437",
-    "@docusaurus/mdx-loader": "3.9.2-canary-6437",
-    "@docusaurus/utils": "3.9.2-canary-6437",
-    "@docusaurus/utils-common": "3.9.2-canary-6437",
-    "@docusaurus/utils-validation": "3.9.2-canary-6437",
+    "@docusaurus/babel": "3.9.2-canary-6439",
+    "@docusaurus/bundler": "3.9.2-canary-6439",
+    "@docusaurus/logger": "3.9.2-canary-6439",
+    "@docusaurus/mdx-loader": "3.9.2-canary-6439",
+    "@docusaurus/utils": "3.9.2-canary-6439",
+    "@docusaurus/utils-common": "3.9.2-canary-6439",
+    "@docusaurus/utils-validation": "3.9.2-canary-6439",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -51,7 +51,7 @@
     "escape-html": "^1.0.3",
     "eta": "^2.2.0",
     "eval": "^0.1.8",
-    "execa": "5.1.1",
+    "execa": "^5.1.1",
     "fs-extra": "^11.1.1",
     "html-tags": "^3.3.1",
     "html-webpack-plugin": "^5.6.0",
@@ -77,8 +77,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.9.2-canary-6437",
-    "@docusaurus/types": "3.9.2-canary-6437",
+    "@docusaurus/module-type-aliases": "3.9.2-canary-6439",
+    "@docusaurus/types": "3.9.2-canary-6439",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -98,5 +98,5 @@
   "engines": {
     "node": ">=20.0"
   },
-  "gitHead": "c36f3ac2e06fc332b02fc2feaae5011d1a51ac87"
+  "gitHead": "67795b9b8e2c6d94284ae736bb0d974a2cf2000b"
 }