fix: Formatting fixes

typedoc2md · Mar 21, 2024 · 5983059 · 5983059
1 parent 06187c7
commit 5983059
Show file tree

Hide file tree

Showing 11 changed files with 58 additions and 5 deletions.
diff --git a/docs/pages/options.mdx b/docs/pages/options.mdx
@@ -579,6 +579,7 @@ Below is the full list of keys and default values:
     "label.indexSignature": "Index signature",
     "label.member": "Member",
     "label.modifier": "Modifier",
+    "label.name": "Name",
     "label.overrides": "Overrides",
     "label.packages": "Packages",
     "label.reExports": "Re-exports",

diff --git a/packages/typedoc-plugin-markdown/src/app/options/option-types.ts b/packages/typedoc-plugin-markdown/src/app/options/option-types.ts
@@ -90,6 +90,7 @@ export interface TextContentMappings {
   'label.indexSignature': string;
   'label.member': string;
   'label.modifier': string;
+  'label.name': string;
   'label.overrides': string;
   'label.packages': string;
   'label.reExports': string;

diff --git a/packages/typedoc-plugin-markdown/src/app/options/text-mappings/text-mapping-defaults.ts b/packages/typedoc-plugin-markdown/src/app/options/text-mappings/text-mapping-defaults.ts
@@ -22,6 +22,7 @@ export const TEXT_MAPPING_DEFAULTS = {
   'label.indexSignature': 'Index signature',
   'label.member': 'Member',
   'label.modifier': 'Modifier',
+  'label.name': 'Name',
   'label.overrides': 'Overrides',
   'label.packages': 'Packages',
   'label.reExports': 'Re-exports',

diff --git a/packages/typedoc-plugin-markdown/src/theme/lib/markdown/back-ticks.ts b/packages/typedoc-plugin-markdown/src/theme/lib/markdown/back-ticks.ts
@@ -1,3 +1,3 @@
 export function backTicks(text: string) {
-  return /(\`)/g.test(text) ? text.replace(/`/g, '\\`') : `\`${text}\``;
+  return /(\`)/g.test(text) ? `\`\`${text}\`\`` : `\`${text}\``;
 }
diff --git a/...oc-plugin-markdown/src/theme/markdown-theme-render-context/partials/page.packagesIndex.ts b/...oc-plugin-markdown/src/theme/markdown-theme-render-context/partials/page.packagesIndex.ts
@@ -22,7 +22,7 @@ export function packagesIndex(
   );
 
   if (context.options.getValue('packagesFormat') === 'table') {
-    const headers = ['Package'];
+    const headers = [context.helpers.getText('label.name')];
     if (includeVersion) {
       headers.push('Version');
     }

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/types.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/types.ts
@@ -169,3 +169,11 @@ export const someQuery = 1;
  * Comments for query type
  */
 export type QueryType = typeof someQuery;
+
+/**
+ * Union with template strings
+ */
+export type UnionTypeWithTemplateStrings =
+  | `v${number}`
+  | `v${number}.${number}`
+  | `v${number}.${number}.${number}`;
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
@@ -1838,6 +1838,10 @@ exports[`Navigation should gets Navigation Json for single entry point: (Output
       {
         "title": "UnionType",
         "url": "type-aliases/UnionType.md"
+      },
+      {
+        "title": "UnionTypeWithTemplateStrings",
+        "url": "type-aliases/UnionTypeWithTemplateStrings.md"
       }
     ]
   },

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/packages.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/packages.spec.ts.snap
@@ -174,7 +174,7 @@ Some text.
 
 ## Packages
 
-| Package | Version | Description |
+| Name | Version | Description |
 | :------ | :------ | :------ |
 | [@scope/package-1](package-1/index.md) | 1.0.0 | Description for package-1 |
 | [package-1b](package-1b/index.md) | - | - |

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap
@@ -514,7 +514,7 @@ Comments for ReadonlyMapedType
 exports[`Type Alias Reflection should compile string literal type: (Output File Strategy "members") (Option Group "1") 1`] = `
 "# Type alias: StringLiteralType
 
-> **StringLiteralType**: \`" "\` \\| \`"string"\` \\| \`"string|with|pipes"\` \\| "string\\\`with\\\`backticks" \\| \`"<foo>"\` \\| \`"*"\`
+> **StringLiteralType**: \`" "\` \\| \`"string"\` \\| \`"string|with|pipes"\` \\| \`\`"string\`with\`backticks"\`\` \\| \`"<foo>"\` \\| \`"*"\`
 
 Comments for StringLiteralType
 
@@ -532,7 +532,7 @@ type StringLiteralType:
   | " "
   | "string"
   | "string|with|pipes"
-  | "string\\with\\backticks"
+  | "stringwithbackticks"
   | "<foo>"
   | "*";
 \`\`\`
@@ -614,6 +614,34 @@ Comments for TypeWithTypeParams
 "
 `;
 
+exports[`Type Alias Reflection should compile union type with template strings: (Output File Strategy "members") (Option Group "1") 1`] = `
+"# Type alias: UnionTypeWithTemplateStrings
+
+> **UnionTypeWithTemplateStrings**: \`\`\`v\${number}\`\`\` \\| \`\`\`v\${number}.\${number}\`\`\` \\| \`\`\`v\${number}.\${number}.\${number}\`\`\`
+
+Union with template strings
+
+## Source
+
+[types.ts:176](http://source-url)
+"
+`;
+
+exports[`Type Alias Reflection should compile union type with template strings: (Output File Strategy "members") (Option Group "2") 1`] = `
+"# UnionTypeWithTemplateStrings
+
+\`\`\`ts
+type UnionTypeWithTemplateStrings: v\${number} | v\${number}.\${number} | v\${number}.\${number}.\${number};
+\`\`\`
+
+Union with template strings
+
+## Source
+
+[types.ts:176](http://source-url)
+"
+`;
+
 exports[`Type Alias Reflection should compile union type: (Output File Strategy "members") (Option Group "1") 1`] = `
 "# Type alias: UnionType
 

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap
@@ -421,6 +421,7 @@ exports[`Urls should gets Urls for single entry points: outputFileStrategy: memb
   "type-aliases/TypeWithExternalSymbolLinkMapping.md",
   "type-aliases/TypeWithTypeParams.md",
   "type-aliases/UnionType.md",
+  "type-aliases/UnionTypeWithTemplateStrings.md",
   "variables/objectLiteralVariable.md",
   "variables/objectWithSymbol.md",
   "variables/someQuery.md",
@@ -485,6 +486,7 @@ exports[`Urls should gets Urls for single entry points: outputFileStrategy: memb
   "type-aliases/TypeWithExternalSymbolLinkMapping.md",
   "type-aliases/TypeWithTypeParams.md",
   "type-aliases/UnionType.md",
+  "type-aliases/UnionTypeWithTemplateStrings.md",
   "variables/objectLiteralVariable.md",
   "variables/objectWithSymbol.md",
   "variables/someQuery.md",

diff --git a/packages/typedoc-plugin-markdown/test/specs/reflection.type-alias.spec.ts b/packages/typedoc-plugin-markdown/test/specs/reflection.type-alias.spec.ts
@@ -104,4 +104,12 @@ describe(`Type Alias Reflection`, () => {
   test(`should compile query type`, () => {
     expectFileToEqual('reflections', 'members', 'type-aliases/QueryType.md');
   });
+
+  test(`should compile union type with template strings`, () => {
+    expectFileToEqual(
+      'reflections',
+      'members',
+      'type-aliases/UnionTypeWithTemplateStrings.md',
+    );
+  });
 });