wire to cli

Author: slorber

packages/docusaurus/src/commands/writeHeadingIds.ts

@@ -11,16 +11,37 @@ import {
   safeGlobby,
   writeMarkdownHeadingId,
   type WriteHeadingIDOptions,
+  type HeadingIdSyntax,
 } from '@docusaurus/utils';
 import {loadContext} from '../server/site';
 import {initPlugins} from '../server/plugins/init';
 
+function inferFallbackSyntax(_filepath: string): HeadingIdSyntax {
+  // 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: string, options?: WriteHeadingIDOptions) {
+  return options?.syntax ?? inferFallbackSyntax(filepath);
+}
+
 async function transformMarkdownFile(
   filepath: string,
   options?: WriteHeadingIDOptions,
 ): Promise<string | undefined> {
   const content = await fs.readFile(filepath, 'utf8');
-  const updatedContent = writeMarkdownHeadingId(content, options);
+
+  const syntax = getHeadingIdSyntax(filepath, options);
+  const updatedContent = writeMarkdownHeadingId(content, {
+    ...options,
+    syntax,
+  });
   if (content !== updatedContent) {
     await fs.writeFile(filepath, updatedContent);
     return filepath;