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

package/README.md

@@ -1 +1,3 @@
-# Docusaurus core
+# `@docusaurus/core`
+
+The core package of Docusaurus

package/lib/commands/cli.js

@@ -135,8 +135,10 @@ async function createCLIProgram({ cli, cliArgs, siteDir, config, }) {
     cli
         .command('write-heading-ids [siteDir] [files...]')
         .description('Generate heading ids in Markdown content.')
+        .option('--syntax <syntax>', 'heading ID syntax: "classic" ({#id}) or "mdx-comment" ({/* #id */}) (default: "classic")')
+        .option('--migrate', 'migrate existing heading IDs to the target --syntax, if they are using a different syntax (default: false)')
+        .option('--overwrite', 'overwrite existing heading IDs, re-generate them from the heading text (default: false)')
         .option('--maintain-case', "keep the headings' casing, otherwise make all lowercase (default: false)")
-        .option('--overwrite', 'overwrite existing heading IDs (default: false)')
         .action(writeHeadingIds_1.writeHeadingIds);
     cli.arguments('<command>').action((cmd) => {
         cli.outputHelp();

package/lib/commands/writeHeadingIds.js

@@ -13,9 +13,25 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const site_1 = require("../server/site");
 const init_1 = require("../server/plugins/init");
+function inferFallbackSyntax(_filepath) {
+    // TODO Docusaurus v4 - infer the syntax based on the file extensions?
+    // This is not ideal because we have many ways to define the syntax
+    // (front matter "format", siteConfig.markdown.format etc...)
+    // but probably good enough for now
+    // Until then, we default to the classic syntax
+    // The mdx-comment syntax is opt-in
+    return 'classic';
+}
+function getHeadingIdSyntax(filepath, options) {
+    return options?.syntax ?? inferFallbackSyntax(filepath);
+}
 async function transformMarkdownFile(filepath, options) {
     const content = await fs_extra_1.default.readFile(filepath, 'utf8');
-    const updatedContent = (0, utils_1.writeMarkdownHeadingId)(content, options);
+    const syntax = getHeadingIdSyntax(filepath, options);
+    const updatedContent = (0, utils_1.writeMarkdownHeadingId)(content, {
+        ...options,
+        syntax,
+    });
     if (content !== updatedContent) {
         await fs_extra_1.default.writeFile(filepath, updatedContent);
         return filepath;
@@ -33,17 +49,35 @@ async function getPathsToWatch(siteDir) {
     const plugins = await (0, init_1.initPlugins)(context);
     return plugins.flatMap((plugin) => plugin.getPathsToWatch?.() ?? []);
 }
+// TODO Docusaurus v4 - Upgrade commander, use choices() API?
+function validateOptions(options) {
+    const validSyntaxValues = ['classic', 'mdx-comment'];
+    if (options.syntax && !validSyntaxValues.includes(options.syntax)) {
+        throw new Error(`Invalid --syntax value "${options.syntax}". Valid values: ${validSyntaxValues.join(', ')}`);
+    }
+    if (options.overwrite && options.migrate) {
+        throw new Error("Options --overwrite and --migrate cannot be used together.\nThe --overwrite already re-generates IDs in the target syntax, so the --migrate option wouldn't have any effect.");
+    }
+}
 async function writeHeadingIds(siteDirParam = '.', files = [], options = {}) {
+    validateOptions(options);
     const siteDir = await fs_extra_1.default.realpath(siteDirParam);
-    const markdownFiles = await (0, utils_1.safeGlobby)(files ?? (await getPathsToWatch(siteDir)), {
+    const patterns = files.length ? files : await getPathsToWatch(siteDir);
+    const markdownFiles = await (0, utils_1.safeGlobby)(patterns, {
         expandDirectories: ['**/*.{md,mdx}'],
     });
+    if (markdownFiles.length === 0) {
+        logger_1.default.warn `No markdown files found in siteDir path=${siteDir} for patterns: ${patterns}`;
+        return;
+    }
     const result = await Promise.all(markdownFiles.map((p) => transformMarkdownFile(p, options)));
     const pathsModified = result.filter(Boolean);
     if (pathsModified.length) {
         logger_1.default.success `Heading ids added to Markdown files (number=${`${pathsModified.length}/${markdownFiles.length}`} files): ${pathsModified}`;
     }
     else {
-        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.`;
+        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.
+If you intend to change their heading ID syntax, use the code=${'--migrate'} option.`;
     }
 }

package/lib/webpack/base.js

@@ -118,24 +118,6 @@ async function createBaseConfig({ props, isServer, minify, faster, configureWebp
                     buildDependencies: getCacheBuildDependencies(),
                 };
             }
-            if (process.env.DISABLE_RSPACK_INCREMENTAL) {
-                // Enabled by default since Rspack 1.4
-                console.log('Rspack incremental disabled');
-                experiments.incremental = false;
-            }
-            // See https://rspack.rs/blog/announcing-1-5#barrel-file-optimization
-            if (process.env.DISABLE_RSPACK_LAZY_BARREL) {
-                console.log('Rspack lazyBarrel disabled');
-                experiments.lazyBarrel = false;
-            }
-            else {
-                // TODO remove after we upgrade to Rspack 1.6+
-                //  Enabled by default for Rspack >= 1.6
-                experiments.lazyBarrel = true;
-            }
-            // TODO re-enable later, there's an Rspack performance issue
-            //  see https://github.com/facebook/docusaurus/pull/11178
-            experiments.parallelCodeSplitting = false;
             return experiments;
         }
         return undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.9.2-canary-6495",
+  "version": "3.9.2-canary-6526",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.9.2-canary-6495",
-    "@docusaurus/bundler": "3.9.2-canary-6495",
-    "@docusaurus/logger": "3.9.2-canary-6495",
-    "@docusaurus/mdx-loader": "3.9.2-canary-6495",
-    "@docusaurus/utils": "3.9.2-canary-6495",
-    "@docusaurus/utils-common": "3.9.2-canary-6495",
-    "@docusaurus/utils-validation": "3.9.2-canary-6495",
+    "@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",
     "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-6495",
-    "@docusaurus/types": "3.9.2-canary-6495",
+    "@docusaurus/module-type-aliases": "3.9.2-canary-6526",
+    "@docusaurus/types": "3.9.2-canary-6526",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^19.2.3",
@@ -97,5 +97,5 @@
   "engines": {
     "node": ">=20.0"
   },
-  "gitHead": "fb9b28015f40d530ceb623dc486a5b8f48902ca0"
+  "gitHead": "a37ae138931cb80b31664f86a34f97671c00e409"
 }