fix(core): correctly handle anchor resolutions with table formats

Author: tgreyuk

.changeset/famous-forks-float.md

@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Correctly handle anchor resolutions with table formats.

docs/pages/docs/options/display-options.mdx

@@ -82,7 +82,7 @@ As a work around the [`@link`](https://typedoc.org/tags/link/) tag can be be use
 
 > Accepts a boolean value. Defaults to `false`.
 
-By default objects inside declarations are collapsed to preserve space and improve readability.
+By default when objects have associated documentation, object declarations are collapsed to preserve space and improve readability.
 
 This option should be set when a full object representation is preferred.
 

docs/pages/docs/options/utility-options.mdx

@@ -155,7 +155,7 @@ This option can be used for engines that require the preservation of anchor link
 
 <Callout emoji="💡">Change specific text placeholders in the template.</Callout>
 
->
+> Accepts a key/value object.
 
 Customizes the page titles for index, module, and member pages in the documentation.
 

packages/typedoc-plugin-markdown/package.json

@@ -15,7 +15,7 @@
     "prebuild": "rm -rf dist && prebuild-options && tsx ./.scripts/prebuild",
     "build": "tsc && tsc-alias",
     "build-and-run": "npm run build && npm run fixtures",
-    "fixtures": "node test/__scripts__/build-fixtures.mjs -c test/fixtures/config.mjs",
+    "fixtures": "rm -rf ./test/fixtures/out && node test/__scripts__/build-fixtures.mjs -c test/fixtures/config.mjs",
     "validate": "node test/__scripts__/lint/lint.md.mjs && tsx test/__scripts__/lint/lint.mdx.mjs",
     "pretest": "npm run fixtures -- -isCI",
     "test": "npm run validate && jest",

packages/typedoc-plugin-markdown/src/theme/base/url-builder.ts

@@ -542,18 +542,19 @@ export class UrlBuilder {
         anchorParts.unshift(`${anchorPrefix}`);
       }
 
-      reflection.url = containerUrl + '#' + anchorParts.join('');
+      reflection.url =
+        reflection.kind === ReflectionKind.TypeLiteral
+          ? containerUrl
+          : containerUrl + '#' + anchorParts.join('');
       reflection.anchor = anchorParts.join('');
       reflection.hasOwnDocument = false;
-
-      if (
-        this.options.getValue('outputFileStrategy') ===
-        OutputFileStrategy.Members
-      ) {
-        reflection.traverse((child) => {
-          this.applyAnchorUrl(child as DeclarationReflection, containerUrl);
-        });
-      }
+    }
+    if (
+      this.options.getValue('outputFileStrategy') === OutputFileStrategy.Members
+    ) {
+      reflection.traverse((child) => {
+        this.applyAnchorUrl(child as DeclarationReflection, containerUrl);
+      });
     }
   }
 
@@ -578,21 +579,33 @@ export class UrlBuilder {
     if (!htmlTableAnchors) {
       if (
         (reflection.kind === ReflectionKind.Property &&
-          this.options.getValue('propertiesFormat').toLowerCase() ===
-            'table') ||
+          this.options
+            .getValue('propertiesFormat')
+            .toLowerCase()
+            .includes('table')) ||
         (reflection.kind === ReflectionKind.Property &&
-          this.options.getValue('typeDeclarationFormat').toLowerCase() ===
-            'table') ||
+          reflection.parent?.kind === ReflectionKind.TypeLiteral &&
+          this.options
+            .getValue('typeDeclarationFormat')
+            .toLowerCase()
+            .includes('table')) ||
         (reflection.kind === ReflectionKind.Property &&
           reflection.parent?.kind === ReflectionKind.Class &&
-          this.options.getValue('classPropertiesFormat').toLowerCase() ===
-            'table') ||
+          this.options
+            .getValue('classPropertiesFormat')
+            .toLowerCase()
+            .includes('table')) ||
         (reflection.kind === ReflectionKind.Property &&
           reflection.parent?.kind === ReflectionKind.Interface &&
-          this.options.getValue('interfacePropertiesFormat').toLowerCase() ===
-            'table') ||
+          this.options
+            .getValue('interfacePropertiesFormat')
+            .toLowerCase()
+            .includes('table')) ||
         (reflection.kind === ReflectionKind.EnumMember &&
-          this.options.getValue('enumMembersFormat').toLowerCase() === 'table')
+          this.options
+            .getValue('enumMembersFormat')
+            .toLowerCase()
+            .includes('table'))
       ) {
         return null;
       }

packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts

@@ -53,13 +53,13 @@ export function getCommentParts(
       case 'relative-link':
         switch (typeof part.target) {
           case 'number': {
-            const refl = this.page.project.files.resolve(
+            const reflection = this.page.project.files.resolve(
               part.target,
               this.page.model.project,
             );
             let url: string | undefined;
-            if (typeof refl === 'object' && refl.url) {
-              url = this.getRelativeUrl(refl.url);
+            if (typeof reflection === 'object' && reflection.url) {
+              url = this.getRelativeUrl(reflection.url);
             } else {
               const fileName = this.page.project.files.getName(part.target);
               if (fileName) {

packages/typedoc-plugin-markdown/test/__scripts__/build-fixtures.mjs

@@ -97,7 +97,7 @@ function writeMarkdown(
       '-options',
       path.join(__dirname, '..', 'fixtures', 'typedoc.cjs'),
       '-logLevel',
-      'None',
+      'Warn',
       '-out',
       fullPath,
     ],

packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts

@@ -13,8 +13,8 @@
  * - {@link CommentEnum.MemberB}
  * - {@link SameName.prop}
  * - {@link TypeWithGenerics}
- * - {@link TypeDeclarationTable#declaration1 | Links to declaration1}
- * - {@link NotFound}
+ * - {@link TypeDeclarationType}
+ * - {@link TypeDeclarationType#declaration1 | Links to declaration1}
  *
  * External links:
  *
@@ -24,7 +24,6 @@
  * Relative Links:
  *
  * - [Relative Document](../../PROJECT_DOC_1.md)
- * - [Relative Link](../../../groups/members/opts-1/index.md)
  *
  * Relative Image Links:
  *
@@ -250,7 +249,7 @@ export interface InterfacePropertiesTable extends BaseInterfaceProperties {
   };
 }
 
-export type TypeDeclarationTable = {
+export type TypeDeclarationType = {
   /**
    * The subroutine recursively parsed the hexadecimal data.
    * to generate the binary output for input validation.
@@ -264,7 +263,7 @@ export type TypeDeclarationTable = {
   declaration4: 100;
 };
 
-export const TypeDeclarationTable = {
+export const TypeDeclarationConst = {
   declaration1: 'declaration3',
   declaration2: 100,
 };

packages/typedoc-plugin-markdown/test/fixtures/src/reflections/functions.ts

@@ -191,7 +191,7 @@ export function functionReturningAPromise(): Promise<{
   });
 }
 
-const foo = {
+const someConst = {
   /**
    * a comments
    */
@@ -202,7 +202,7 @@ const foo = {
   b: '',
 };
 
-type Foo = typeof foo;
+type SomeType = typeof someConst;
 
 export function functionWithUnionParams(
   /**
@@ -227,7 +227,7 @@ export function functionWithUnionParams(
    */
   mixedUnions:
     | string
-    | Foo
+    | SomeType
     | number
     | {
         /**

packages/typedoc-plugin-markdown/test/fixtures/src/reflections/types.ts

@@ -101,6 +101,13 @@ export type ReadonlyMappedType<T> = {
 
 /**
  * Comments for FunctionType
+ *
+ * - Test link resolution for:
+ *
+ * - {@linkcode LiteralType} and uses {@link LiteralType#x}
+ * - {@linkcode BasicInterface} and uses {@link BasicInterface#prop}
+ * - {@linkcode BasicClass} and uses {@link BasicClass#prop}
+ * - {@linkcode BasicEnum} and uses {@link BasicEnum#MemberA}
  */
 export type FunctionType = (name: string, value: unknown) => void;
 

packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap

@@ -8,8 +8,8 @@ exports[`Comments should compile @links with anchors: (Output File Strategy "mod
 - [CommentEnum.MemberB](README.md#memberb)
 - [SameName.prop](README.md#prop-2)
 - [TypeWithGenerics](README.md#typewithgenericsc-d)
+- [TypeDeclarationType](README.md#typedeclarationtype)
 - [Links to declaration1](README.md#declaration1)
-- NotFound
 "
 `;
 
@@ -29,8 +29,8 @@ Links using \`{@link}\` inline tags.
 - [CommentEnum.MemberB](enumerations/CommentEnum.md#memberb)
 - [SameName.prop](interfaces/SameName.md#prop)
 - [TypeWithGenerics](type-aliases/TypeWithGenerics.md)
-- [Links to declaration1](type-aliases/TypeDeclarationTable.md#declaration1)
-- NotFound
+- [TypeDeclarationType](type-aliases/TypeDeclarationType.md)
+- [Links to declaration1](type-aliases/TypeDeclarationType.md#declaration1)
 
 External links:
 
@@ -40,7 +40,6 @@ External links:
 Relative Links:
 
 - [Relative Document](_media/PROJECT_DOC_1.md)
-- [Relative Link](../../../groups/members/opts-1/index.md)
 
 Relative Image Links:
 
@@ -104,7 +103,7 @@ Some <p> html </p> inside codeblock
 
 ## Type Aliases
 
-- [TypeDeclarationTable](type-aliases/TypeDeclarationTable.md)
+- [TypeDeclarationType](type-aliases/TypeDeclarationType.md)
 - [typeWithBlockTags](type-aliases/typeWithBlockTags.md)
 - [TypeWithGenerics](type-aliases/TypeWithGenerics.md)
 
@@ -114,7 +113,7 @@ Some <p> html </p> inside codeblock
 - [prop](variables/prop.md)
 - [propb](variables/propb.md)
 - [SameName](variables/SameName.md)
-- [TypeDeclarationTable](variables/TypeDeclarationTable.md)
+- [TypeDeclarationConst](variables/TypeDeclarationConst.md)
 
 ## Functions
 
@@ -233,7 +232,7 @@ Other block tags
 "
 `;
 
-exports[`Comments should get tables for emum: (Output File Strategy "members") (Option Group "1") 1`] = `
+exports[`Comments should get tables for enum: (Output File Strategy "members") (Option Group "1") 1`] = `
 "# Enumeration: EnumMembersTable
 
 ## Enumeration Members
@@ -244,7 +243,7 @@ exports[`Comments should get tables for emum: (Output File Strategy "members") (
 "
 `;
 
-exports[`Comments should get tables for emum: (Output File Strategy "members") (Option Group "2") 1`] = `
+exports[`Comments should get tables for enum: (Output File Strategy "members") (Option Group "2") 1`] = `
 "# Enumeration: EnumMembersTable
 
 ## Enumeration Members
@@ -501,9 +500,9 @@ Experimental flag comments
 `;
 
 exports[`Comments should get tables for type declarations: (Output File Strategy "members") (Option Group "1") 1`] = `
-"# Type Alias: TypeDeclarationTable
+"# Type Alias: TypeDeclarationType
 
-> **TypeDeclarationTable**: \`object\`
+> **TypeDeclarationType**: \`object\`
 
 ## Type declaration
 
@@ -520,9 +519,9 @@ exports[`Comments should get tables for type declarations: (Output File Strategy
 `;
 
 exports[`Comments should get tables for type declarations: (Output File Strategy "members") (Option Group "1") 2`] = `
-"# Variable: TypeDeclarationTable
+"# Variable: TypeDeclarationConst
 
-> **TypeDeclarationTable**: \`object\`
+> \`const\` **TypeDeclarationConst**: \`object\`
 
 ## Type declaration
 
@@ -538,9 +537,9 @@ exports[`Comments should get tables for type declarations: (Output File Strategy
 `;
 
 exports[`Comments should get tables for type declarations: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# Type Alias: TypeDeclarationTable
+"# Type Alias: TypeDeclarationType
 
-> **TypeDeclarationTable**: \\{ \`declaration1\`: \`boolean\`; \`declaration2\`: \`boolean\`; \`declaration4\`: \`100\`; \\}
+> **TypeDeclarationType**: \\{ \`declaration1\`: \`boolean\`; \`declaration2\`: \`boolean\`; \`declaration4\`: \`100\`; \\}
 
 ## Type declaration
 
@@ -616,9 +615,9 @@ to generate the binary output for input validation.
 `;
 
 exports[`Comments should get tables for type declarations: (Output File Strategy "members") (Option Group "2") 2`] = `
-"# Variable: TypeDeclarationTable
+"# Variable: TypeDeclarationConst
 
-> **TypeDeclarationTable**: \\{ \`declaration1\`: \`string\`; \`declaration2\`: \`number\`; \\}
+> \`const\` **TypeDeclarationConst**: \\{ \`declaration1\`: \`string\`; \`declaration2\`: \`number\`; \\}
 
 ## Type declaration
 

packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap

@@ -349,6 +349,13 @@ exports[`Type Alias Reflection should compile function type: (Output File Strate
 
 Comments for FunctionType
 
+- Test link resolution for:
+
+- [\`LiteralType\`](LiteralType.md) and uses [LiteralType#x](LiteralType.md#x)
+- [\`BasicInterface\`](../interfaces/BasicInterface.md) and uses [BasicInterface#prop](../interfaces/BasicInterface.md#prop)
+- [\`BasicClass\`](../classes/BasicClass.md) and uses [BasicClass#prop](../classes/BasicClass.md#prop)
+- [\`BasicEnum\`](../enumerations/BasicEnum.md) and uses [BasicEnum#MemberA](../enumerations/BasicEnum.md#membera)
+
 ## Parameters
 
 ### name
@@ -378,6 +385,13 @@ type FunctionType: (name: string, value: unknown) => void;
 
 Comments for FunctionType
 
+- Test link resolution for:
+
+- [\`LiteralType\`](LiteralType.md) and uses [LiteralType#x](LiteralType.md)
+- [\`BasicInterface\`](../interfaces/BasicInterface.md) and uses [BasicInterface#prop](../interfaces/BasicInterface.md)
+- [\`BasicClass\`](../classes/BasicClass.md) and uses [BasicClass#prop](../classes/BasicClass.md)
+- [\`BasicEnum\`](../enumerations/BasicEnum.md) and uses [BasicEnum#MemberA](../enumerations/BasicEnum.md)
+
 ## Parameters
 
 | Parameter | Type |

packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap

@@ -1000,11 +1000,11 @@ exports[`Urls should gets Urls with media assets: outputFileStrategy: members 1`
   "interfaces/CommentInterfaceExtended.md",
   "interfaces/InterfacePropertiesTable.md",
   "interfaces/SameName.md",
-  "type-aliases/TypeDeclarationTable.md",
+  "type-aliases/TypeDeclarationType.md",
   "type-aliases/TypeWithGenerics.md",
   "type-aliases/typeWithBlockTags.md",
   "variables/SameName.md",
-  "variables/TypeDeclarationTable.md",
+  "variables/TypeDeclarationConst.md",
   "variables/prop.md",
   "variables/prop_with_underscore.md",
   "variables/propb.md",
@@ -1029,11 +1029,11 @@ exports[`Urls should gets Urls with media assets: outputFileStrategy: members 2`
   "Interface.InterfacePropertiesTable.md",
   "Interface.SameName.md",
   "README.md",
-  "TypeAlias.TypeDeclarationTable.md",
+  "TypeAlias.TypeDeclarationType.md",
   "TypeAlias.TypeWithGenerics.md",
   "TypeAlias.typeWithBlockTags.md",
   "Variable.SameName.md",
-  "Variable.TypeDeclarationTable.md",
+  "Variable.TypeDeclarationConst.md",
   "Variable._prop_with_underscore.md",
   "Variable.prop.md",
   "Variable.propb.md",