wire to cli

Author: slorber

packages/docusaurus/src/commands/cli.ts

@@ -259,6 +259,10 @@ export async function createCLIProgram({
       "keep the headings' casing, otherwise make all lowercase (default: false)",
     )
     .option('--overwrite', 'overwrite existing heading IDs (default: false)')
+    .option(
+      '--syntax <syntax>',
+      'heading ID syntax: "classic" ({#id}) or "mdx-comment" ({/* #id */}) (default: "classic")',
+    )
     .action(writeHeadingIds);
 
   cli.arguments('<command>').action((cmd) => {

packages/docusaurus/src/commands/writeHeadingIds.ts

@@ -61,11 +61,25 @@ async function getPathsToWatch(siteDir: string): Promise<string[]> {
   return plugins.flatMap((plugin) => plugin.getPathsToWatch?.() ?? []);
 }
 
+// TODO Docusaurus v4 - Upgrade commander, use choices() API?
+function validateOptions(options: WriteHeadingIDOptions) {
+  const validSyntaxValues: HeadingIdSyntax[] = ['classic', 'mdx-comment'];
+  if (options.syntax && !['classic', 'mdx-comment'].includes(options.syntax)) {
+    throw new Error(
+      `Invalid --syntax value "${
+        options.syntax
+      }". Valid values: ${validSyntaxValues.join(', ')}`,
+    );
+  }
+}
+
 export async function writeHeadingIds(
   siteDirParam: string = '.',
   files: string[] = [],
   options: WriteHeadingIDOptions = {},
 ): Promise<void> {
+  validateOptions(options);
+
   const siteDir = await fs.realpath(siteDirParam);
 
   const patterns = files.length ? files : await getPathsToWatch(siteDir);