fix(core): escape symbols signatures correctly

typedoc2md · May 6, 2024 · bbf4d10 · bbf4d10
1 parent 5afbeeb
commit bbf4d10
Show file tree

Hide file tree

Showing 9 changed files with 118 additions and 50 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts b/packages/typedoc-plugin-markdown/src/libs/utils/escape-chars.ts
@@ -7,5 +7,7 @@ export function escapeChars(str: string) {
     .replace(/_/g, '\\_')
     .replace(/`/g, '\\`')
     .replace(/\|/g, '\\|')
+    .replace(/\[/g, '\\[')
+    .replace(/\]/g, '\\]')
     .replace(/\*/g, '\\*');
 }
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts
@@ -101,6 +101,13 @@ export class DerivedClassB extends AbstractClass {
   }
 }
 
+const symbolConst: unique symbol = Symbol('SomeSymbol');
+
+export class ClassWithSymbols {
+  [Symbol.dispose]() {}
+  public static [symbolConst]?: () => void;
+}
+
 export class DisposableClass implements Disposable {
   [Symbol.dispose]() {}
 }

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap
@@ -2730,6 +2730,11 @@ exports[`Navigation should gets Navigation Json for single entry point: (Output
         "kind": 128,
         "path": "classes/ClassWithSimpleProps.md"
       },
+      {
+        "title": "ClassWithSymbols",
+        "kind": 128,
+        "path": "classes/ClassWithSymbols.md"
+      },
       {
         "title": "ClassWithTypeParameters",
         "kind": 128,

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap
@@ -763,9 +763,9 @@ Comments variable with symbol
 
 ## Type declaration
 
-### [sym]
+### \\[sym\\]
 
-> **[sym]**: \`string\` = \`'value'\`
+> **\\[sym\\]**: \`string\` = \`'value'\`
 
 Comments for symbol
 "
@@ -784,7 +784,7 @@ Comments variable with symbol
 
 ## Type declaration
 
-### [sym]
+### \\[sym\\]
 
 \`\`\`ts
 [sym]: string = 'value';