Remove hidden reflections from class hierarchy

Author: Gerrit0

CHANGELOG.md

@@ -13,6 +13,8 @@ title: Changelog
 
 - TypeDoc's default theme now uses the same chevron for all collapsible elements, #2924
   The `chevronSmall` helper is now deprecated and will be removed with v0.29.0.
+- Classes/interfaces marked with `@hidden` will no longer appear in the
+  "Hierarchy" section of the docs.
 
 ### Thanks!
 

src/lib/converter/plugins/ImplementsPlugin.ts

@@ -9,7 +9,7 @@ import {
     ReflectionKind,
     SignatureReflection,
 } from "../../models/index.js";
-import { ReferenceType, ReflectionType, type Type } from "../../models/types.js";
+import { ReferenceType, ReflectionType, type SomeType, type Type } from "../../models/types.js";
 import { filterMap, type TranslatedString, zip } from "#utils";
 import { ConverterComponent } from "../components.js";
 import type { Context } from "../context.js";
@@ -234,6 +234,18 @@ export class ImplementsPlugin extends ConverterComponent {
             });
         }
 
+        // Remove hidden classes/interfaces which we inherit from
+        if (reflection.kindOf(ReflectionKind.ClassOrInterface)) {
+            const notHiddenType = (t: SomeType) =>
+                !(t instanceof ReferenceType) ||
+                !t.symbolId ||
+                !project.symbolIdHasBeenRemoved(t.symbolId);
+            reflection.implementedTypes = reflection.implementedTypes?.filter(notHiddenType);
+            if (!reflection.implementedTypes?.length) delete reflection.implementedTypes;
+            reflection.extendedTypes = reflection.extendedTypes?.filter(notHiddenType);
+            if (!reflection.extendedTypes?.length) delete reflection.extendedTypes;
+        }
+
         if (
             reflection.kindOf(ReflectionKind.ClassOrInterface) &&
             reflection.extendedTypes

src/test/behavior.c2.test.ts

@@ -988,10 +988,25 @@ describe("Behavior Tests", () => {
         project.removeReflection(query(project, "nested"));
         equal(
             Object.values(project.reflections).map((r) => r.name),
-            ["typedoc"],
+            ["typedoc", "Base", "NotHidden", "NotHiddenImpl", "constructor", "NotHiddenImpl"],
         );
     });
 
+    it("Removes heritage clause references to hidden classes.", () => {
+        const project = convert("removeReflection");
+        const Base = query(project, "Base");
+        equal(Base.extendedBy, undefined);
+        equal(Base.implementedBy, undefined);
+
+        const NotHidden = query(project, "NotHidden");
+        equal(NotHidden.extendedTypes, undefined);
+        equal(NotHidden.implementedTypes, undefined);
+
+        const NotHiddenImpl = query(project, "NotHiddenImpl");
+        equal(NotHiddenImpl.extendedTypes, undefined);
+        equal(NotHiddenImpl.implementedTypes, undefined);
+    });
+
     it("Handles @see tags", () => {
         const project = convert("seeTags");
         const foo = query(project, "foo");

src/test/converter2/behavior/removeReflection.ts

@@ -5,3 +5,10 @@ export function foo(first: string, second: string, third: string) {
 }
 
 export function nested(a: 1 | { a; 1 }) {}
+
+export interface Base {}
+/** @hidden */
+export interface Hidden extends Base {}
+export interface NotHidden extends Hidden {}
+
+export class NotHiddenImpl implements Hidden {}