@docusaurus/core 3.9.2-canary-6526 → 3.9.2-canary-6541

package/lib/commands/build/buildLocale.js

@@ -132,7 +132,7 @@ async function getBuildClientConfig({ props, cliOptions, configureWebpackUtils,
     const result = await (0, client_1.createBuildClientConfig)({
         props,
         minify: cliOptions.minify ?? true,
-        faster: props.siteConfig.future.experimental_faster,
+        faster: props.siteConfig.future.faster,
         configureWebpackUtils,
         bundleAnalyzer: cliOptions.bundleAnalyzer ?? false,
     });

package/lib/commands/start/webpack.js

@@ -102,7 +102,7 @@ async function getStartClientConfig({ props, minify, poll, configureWebpackUtils
     let { clientConfig: config } = await (0, client_1.createStartClientConfig)({
         props,
         minify,
-        faster: props.siteConfig.future.experimental_faster,
+        faster: props.siteConfig.future.faster,
         poll,
         configureWebpackUtils,
     });

package/lib/server/configValidation.d.ts

@@ -15,6 +15,6 @@ export declare const DEFAULT_FUTURE_V4_CONFIG_TRUE: FutureV4Config;
 export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
 export declare const DEFAULT_MARKDOWN_HOOKS: MarkdownHooks;
 export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
-export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
+export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'storage' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
 export declare const ConfigSchema: Joi.ObjectSchema<DocusaurusConfig>;
 export declare function validateConfig(config: unknown, siteConfigPath: string): DocusaurusConfig;

package/lib/server/configValidation.js

@@ -72,16 +72,19 @@ exports.DEFAULT_FASTER_CONFIG_TRUE = {
 exports.DEFAULT_FUTURE_V4_CONFIG = {
     removeLegacyPostBuildHeadAttribute: false,
     useCssCascadeLayers: false,
+    siteStorageNamespacing: false,
+    fasterByDefault: false,
 };
 // When using the "v4: true" shortcut
 exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = {
     removeLegacyPostBuildHeadAttribute: true,
     useCssCascadeLayers: true,
+    siteStorageNamespacing: true,
+    fasterByDefault: true,
 };
 exports.DEFAULT_FUTURE_CONFIG = {
     v4: exports.DEFAULT_FUTURE_V4_CONFIG,
-    experimental_faster: exports.DEFAULT_FASTER_CONFIG,
-    experimental_storage: exports.DEFAULT_STORAGE_CONFIG,
+    faster: exports.DEFAULT_FASTER_CONFIG,
     experimental_vcs: (0, utils_1.getVcsPreset)('default-v1'),
     experimental_router: 'browser',
 };
@@ -108,6 +111,7 @@ exports.DEFAULT_MARKDOWN_CONFIG = {
 };
 exports.DEFAULT_CONFIG = {
     i18n: exports.DEFAULT_I18N_CONFIG,
+    storage: exports.DEFAULT_STORAGE_CONFIG,
     future: exports.DEFAULT_FUTURE_CONFIG,
     onBrokenLinks: 'throw',
     onBrokenAnchors: 'warn', // TODO Docusaurus v4: change to throw
@@ -197,26 +201,30 @@ const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
 })
     .optional()
     .default(exports.DEFAULT_I18N_CONFIG);
+// Individual boolean defaults are not set here on purpose
+// They are resolved in postProcessDocusaurusConfig based on
+// the future.v4.fasterByDefault flag
 const FASTER_CONFIG_SCHEMA = utils_validation_1.Joi.alternatives()
     .try(utils_validation_1.Joi.object({
-    swcJsLoader: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.swcJsLoader),
-    swcJsMinimizer: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.swcJsMinimizer),
-    swcHtmlMinimizer: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.swcHtmlMinimizer),
-    lightningCssMinimizer: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.lightningCssMinimizer),
-    mdxCrossCompilerCache: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.mdxCrossCompilerCache),
-    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),
+    swcJsLoader: utils_validation_1.Joi.boolean(),
+    swcJsMinimizer: utils_validation_1.Joi.boolean(),
+    swcHtmlMinimizer: utils_validation_1.Joi.boolean(),
+    lightningCssMinimizer: utils_validation_1.Joi.boolean(),
+    mdxCrossCompilerCache: utils_validation_1.Joi.boolean(),
+    rspackBundler: utils_validation_1.Joi.boolean(),
+    rspackPersistentCache: utils_validation_1.Joi.boolean(),
+    ssgWorkerThreads: utils_validation_1.Joi.boolean(),
+    gitEagerVcs: utils_validation_1.Joi.boolean(),
 }), utils_validation_1.Joi.boolean()
     .required()
     .custom((bool) => bool ? exports.DEFAULT_FASTER_CONFIG_TRUE : exports.DEFAULT_FASTER_CONFIG))
-    .optional()
-    .default(exports.DEFAULT_FASTER_CONFIG);
+    .optional();
 const FUTURE_V4_SCHEMA = utils_validation_1.Joi.alternatives()
     .try(utils_validation_1.Joi.object({
     removeLegacyPostBuildHeadAttribute: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.removeLegacyPostBuildHeadAttribute),
     useCssCascadeLayers: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.useCssCascadeLayers),
+    siteStorageNamespacing: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.siteStorageNamespacing),
+    fasterByDefault: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.fasterByDefault),
 }), utils_validation_1.Joi.boolean()
     .required()
     .custom((bool) => bool ? exports.DEFAULT_FUTURE_V4_CONFIG_TRUE : exports.DEFAULT_FUTURE_V4_CONFIG))
@@ -226,12 +234,13 @@ const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     type: utils_validation_1.Joi.string()
         .equal('localStorage', 'sessionStorage')
         .default(exports.DEFAULT_STORAGE_CONFIG.type),
-    namespace: utils_validation_1.Joi.alternatives()
-        .try(utils_validation_1.Joi.string(), utils_validation_1.Joi.boolean())
-        .default(exports.DEFAULT_STORAGE_CONFIG.namespace),
+    // namespace default is not set here on purpose
+    // It is resolved in postProcessDocusaurusConfig based on
+    // the future.v4.siteStorageNamespacing flag
+    namespace: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.boolean()),
 })
     .optional()
-    .default(exports.DEFAULT_STORAGE_CONFIG);
+    .default({ type: exports.DEFAULT_STORAGE_CONFIG.type });
 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
@@ -262,12 +271,21 @@ const VCS_CONFIG_SCHEMA = utils_validation_1.Joi.custom((input) => {
 }).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,
+    faster: FASTER_CONFIG_SCHEMA,
     experimental_vcs: VCS_CONFIG_SCHEMA,
     experimental_router: utils_validation_1.Joi.string()
         .equal('browser', 'hash')
         .default(exports.DEFAULT_FUTURE_CONFIG.experimental_router),
+    experimental_storage: utils_validation_1.Joi.any()
+        .forbidden()
+        .messages({
+        'any.unknown': `The Docusaurus config ${logger_1.default.code('future.experimental_storage')} has been promoted to a stable top-level ${logger_1.default.code('storage')} config attribute. Please move your storage config to the top level.`,
+    }),
+    experimental_faster: utils_validation_1.Joi.any()
+        .forbidden()
+        .messages({
+        'any.unknown': `The Docusaurus config ${logger_1.default.code('future.experimental_faster')} has been renamed to ${logger_1.default.code('future.faster')}. Please update your Docusaurus config.`,
+    }),
 })
     .optional()
     .default(exports.DEFAULT_FUTURE_CONFIG);
@@ -280,6 +298,7 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
     title: utils_validation_1.Joi.string().required(),
     trailingSlash: utils_validation_1.Joi.boolean(), // No default value! undefined = retrocompatible legacy behavior!
     i18n: I18N_CONFIG_SCHEMA,
+    storage: STORAGE_CONFIG_SCHEMA,
     future: FUTURE_CONFIG_SCHEMA,
     onBrokenLinks: utils_validation_1.Joi.string()
         .equal('ignore', 'log', 'warn', 'throw')
@@ -394,6 +413,41 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
 // Expressing this kind of logic in Joi is a pain
 // We also want to decouple logic from Joi: easier to remove it later!
 function postProcessDocusaurusConfig(config) {
+    // Resolve storage.namespace based on the v4 future flag
+    // undefined means "not explicitly set by user"
+    if (config.storage.namespace === undefined) {
+        config.storage.namespace = config.future.v4.siteStorageNamespacing;
+    }
+    // Resolve faster config based on the v4.fasterByDefault flag
+    // undefined means "not explicitly set by user"
+    if (config.future.faster === undefined) {
+        config.future.faster = {};
+    }
+    const fasterDefault = config.future.v4.fasterByDefault;
+    const fasterKeys = Object.keys(exports.DEFAULT_FASTER_CONFIG);
+    for (const key of fasterKeys) {
+        if (config.future.faster[key] === undefined) {
+            config.future.faster[key] = fasterDefault;
+        }
+    }
+    // Docusaurus Faster doesn't fully support Yarn PnP :s
+    // Until we support Rspack + PnP, we simply revert to Webpack with a warning
+    // See https://github.com/facebook/docusaurus/issues/10787
+    if (process.versions.pnp) {
+        if (config.future.faster.rspackBundler) {
+            logger_1.default.warn(`Docusaurus Faster doesn't fully support the Yarn PnP linker yet.
+We recommend to use Yarn node-linker instead.
+Docusaurus will still attempt to build your app with Webpack (instead of Rspack) and use slower minimizers.
+See also https://github.com/facebook/docusaurus/issues/10787`);
+            config.future.faster.rspackBundler = false;
+            config.future.faster.rspackPersistentCache = false;
+            // This also won't work due to Webpack libs using peerDependencies :s
+            // This could eventually work if the deps are added at the site level
+            // TODO Docusaurus v4 clean this up
+            config.future.faster.lightningCssMinimizer = false;
+            config.future.faster.swcJsMinimizer = false;
+        }
+    }
     if (config.onBrokenMarkdownLinks) {
         logger_1.default.warn `The code=${'siteConfig.onBrokenMarkdownLinks'} config option is deprecated and will be removed in Docusaurus v4.
 Please migrate and move this option to code=${'siteConfig.markdown.hooks.onBrokenMarkdownLinks'} instead.`;
@@ -405,21 +459,21 @@ Please migrate and move this option to code=${'siteConfig.markdown.hooks.onBroke
     // 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
+            ? config.future.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 &&
+    if (config.future.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.
+        throw new Error(`Docusaurus config ${logger_1.default.code('future.faster.ssgWorkerThreads')} requires the future flag ${logger_1.default.code('future.v4.removeLegacyPostBuildHeadAttribute')} to be turned on.
 If you use Docusaurus Faster, we recommend that you also activate Docusaurus v4 future flags: ${logger_1.default.code('{future: {v4: true}}')}
 All the v4 future flags are documented here: https://docusaurus.io/docs/api/docusaurus-config#future`);
     }
-    if (config.future.experimental_faster.rspackPersistentCache &&
-        !config.future.experimental_faster.rspackBundler) {
-        throw new Error(`Docusaurus config flag ${logger_1.default.code('future.experimental_faster.rspackPersistentCache')} requires the flag ${logger_1.default.code('future.experimental_faster.rspackBundler')} to be turned on.`);
+    if (config.future.faster.rspackPersistentCache &&
+        !config.future.faster.rspackBundler) {
+        throw new Error(`Docusaurus config flag ${logger_1.default.code('future.faster.rspackPersistentCache')} requires the flag ${logger_1.default.code('future.faster.rspackBundler')} to be turned on.`);
     }
 }
 // TODO move to @docusaurus/utils-validation

package/lib/server/plugins/synthetic.js

@@ -60,7 +60,7 @@ function createBootstrapPlugin({ siteDir, siteConfig, }) {
  */
 async function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
     const mdxLoaderItem = await (0, mdx_loader_1.createMDXLoaderItem)({
-        useCrossCompilerCache: siteConfig.future.experimental_faster.mdxCrossCompilerCache,
+        useCrossCompilerCache: siteConfig.future.faster.mdxCrossCompilerCache,
         admonitions: true,
         staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
         siteDir,

package/lib/server/siteMessages.js

@@ -15,7 +15,7 @@ const babel_1 = require("@docusaurus/babel");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const uselessBabelConfigMessages = async ({ site }) => {
     const { props: { siteDir, siteConfig }, } = site;
-    if (siteConfig.future.experimental_faster.swcJsLoader) {
+    if (siteConfig.future.faster.swcJsLoader) {
         const babelConfigFilePath = await (0, babel_1.getCustomBabelConfigFilePath)(siteDir);
         if (babelConfigFilePath) {
             return [

package/lib/server/storage.d.ts

@@ -5,9 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { DocusaurusConfig, SiteStorage } from '@docusaurus/types';
-type PartialFuture = Pick<DocusaurusConfig['future'], 'experimental_storage'>;
-type PartialConfig = Pick<DocusaurusConfig, 'url' | 'baseUrl'> & {
-    future: PartialFuture;
-};
+type PartialConfig = Pick<DocusaurusConfig, 'url' | 'baseUrl' | 'storage'>;
 export declare function createSiteStorage(config: PartialConfig): SiteStorage;
 export {};

package/lib/server/storage.js

@@ -14,18 +14,18 @@ function automaticNamespace(config) {
     return (0, utils_1.simpleHash)(normalizedUrl, 3);
 }
 function getNamespaceString(config) {
-    if (config.future.experimental_storage.namespace === true) {
+    if (config.storage.namespace === true) {
         return automaticNamespace(config);
     }
-    else if (config.future.experimental_storage.namespace === false) {
+    else if (config.storage.namespace === false) {
         return null;
     }
     else {
-        return config.future.experimental_storage.namespace;
+        return config.storage.namespace;
     }
 }
 function createSiteStorage(config) {
-    const { type } = config.future.experimental_storage;
+    const { type } = config.storage;
     const namespaceString = getNamespaceString(config);
     const namespace = namespaceString ? `-${namespaceString}` : '';
     return {

package/lib/ssg/ssgExecutor.js

@@ -136,8 +136,7 @@ async function executeSSG({ props, serverBundlePath, clientManifestPath, router,
         logger_1.PerfLogger.end('Generate Hash Router entry point');
         return { collectedData: {} };
     }
-    const createExecutor = props.siteConfig.future.experimental_faster
-        .ssgWorkerThreads
+    const createExecutor = props.siteConfig.future.faster.ssgWorkerThreads
         ? createPooledSSGExecutor
         : createSimpleSSGExecutor;
     const executor = await createExecutor({ params, pathnames: props.routesPaths });

package/lib/ssg/ssgParams.js

@@ -26,8 +26,7 @@ async function createSSGParams({ props, serverBundlePath, clientManifestPath, })
         noIndex: props.siteConfig.noIndex,
         DOCUSAURUS_VERSION: utils_1.DOCUSAURUS_VERSION,
         serverBundlePath,
-        htmlMinifierType: props.siteConfig.future.experimental_faster
-            .swcHtmlMinimizer
+        htmlMinifierType: props.siteConfig.future.faster.swcHtmlMinimizer
             ? 'swc'
             : 'terser',
         v4RemoveLegacyPostBuildHeadAttribute: props.siteConfig.future.v4.removeLegacyPostBuildHeadAttribute,

package/lib/webpack/base.js

@@ -86,7 +86,7 @@ async function createBaseConfig({ props, isServer, minify, faster, configureWebp
             return disabledPersistentCacheValue;
         }
         if (props.currentBundler.name === 'rspack') {
-            if (props.siteConfig.future.experimental_faster.rspackPersistentCache) {
+            if (props.siteConfig.future.faster.rspackPersistentCache) {
                 // Use cache: true + experiments.cache.type: "persistent"
                 // See https://rspack.dev/config/experiments#persistent-cache
                 return true;

package/lib/webpack/server.js

@@ -18,7 +18,7 @@ async function createServerConfig({ props, configureWebpackUtils, }) {
         props,
         isServer: true,
         minify: false,
-        faster: props.siteConfig.future.experimental_faster,
+        faster: props.siteConfig.future.faster,
         configureWebpackUtils,
     });
     const ProgressBarPlugin = await (0, bundler_1.getProgressBarPlugin)({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.9.2-canary-6526",
+  "version": "3.9.2-canary-6541",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.9.2-canary-6526",
-    "@docusaurus/bundler": "3.9.2-canary-6526",
-    "@docusaurus/logger": "3.9.2-canary-6526",
-    "@docusaurus/mdx-loader": "3.9.2-canary-6526",
-    "@docusaurus/utils": "3.9.2-canary-6526",
-    "@docusaurus/utils-common": "3.9.2-canary-6526",
-    "@docusaurus/utils-validation": "3.9.2-canary-6526",
+    "@docusaurus/babel": "3.9.2-canary-6541",
+    "@docusaurus/bundler": "3.9.2-canary-6541",
+    "@docusaurus/logger": "3.9.2-canary-6541",
+    "@docusaurus/mdx-loader": "3.9.2-canary-6541",
+    "@docusaurus/utils": "3.9.2-canary-6541",
+    "@docusaurus/utils-common": "3.9.2-canary-6541",
+    "@docusaurus/utils-validation": "3.9.2-canary-6541",
     "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.9.2-canary-6526",
-    "@docusaurus/types": "3.9.2-canary-6526",
+    "@docusaurus/module-type-aliases": "3.9.2-canary-6541",
+    "@docusaurus/types": "3.9.2-canary-6541",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^19.2.3",
@@ -90,12 +90,18 @@
     "tree-node-cli": "^1.6.0"
   },
   "peerDependencies": {
+    "@docusaurus/faster": "*",
     "@mdx-js/react": "^3.0.0",
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0"
   },
+  "peerDependenciesMeta": {
+    "@docusaurus/faster": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=20.0"
   },
-  "gitHead": "a37ae138931cb80b31664f86a34f97671c00e409"
+  "gitHead": "60ac4995b8bfb7a1b649eb7c7ae6e812222438c5"
 }