Merge pull request #7141 from QwikDev/v2-fix-code-ql

fix: api docs generation regexp
QwikDev · Dec 13, 2024 · 3eb4f34 · 3eb4f34
2 parents 1def076 + bedf0c3
commit 3eb4f34
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/packages/docs/src/routes/api/qwik/api.json b/packages/docs/src/routes/api/qwik/api.json
@@ -2214,4 +2214,4 @@
       "mdFile": "core.withlocale.md"
     }
   ]
-}
+}
diff --git a/scripts/api-docs.ts b/scripts/api-docs.ts
@@ -211,8 +211,7 @@ async function createApiMarkdown(a: ApiData) {
     md.push(``);
 
     // sanitize / adjust output
-    const content = m.content
-      .replace(/<!--(.|\s)*?-->/g, '')
+    const content = removeHtmlComments(m.content)
       // .replace(/<Slot\/>/g, ''
       .replace(/\\#\\#\\# (\w+)/gm, '### $1')
       .replace(/\\\[/gm, '[')
@@ -232,6 +231,15 @@ async function createApiMarkdown(a: ApiData) {
   return mdOutput;
 }
 
+function removeHtmlComments(input: string): string {
+  let previous;
+  do {
+    previous = input;
+    input = input.replace(/<!--(\s*|.*)--!?>/g, '');
+  } while (input !== previous);
+  return input;
+}
+
 interface ApiData {
   id: string;
   package: string;
-Original file line number
+Diff line change
@@ Expand Up / @@ -2214,4 +2214,4 @@ @@
           "mdFile": "core.withlocale.md"
         }
       ]
-    }
+    }