Fix @category tag for real

Closes #1745
TypeStrong · Oct 31, 2021 · 07a2d58 · 07a2d58
1 parent 78c779b
commit 07a2d58
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Unreleased
 
+### Bug Fixes
+
+-   Actually fixed `@category` tag incorrectly appearing on function types if used on a type alias, #1745.
+
 ## v0.22.7 (2021-10-25)
 
 ### Features

diff --git a/src/lib/converter/plugins/CategoryPlugin.ts b/src/lib/converter/plugins/CategoryPlugin.ts
@@ -3,7 +3,6 @@ import {
     ContainerReflection,
     DeclarationReflection,
     CommentTag,
-    ReflectionKind,
 } from "../../models";
 import { ReflectionCategory } from "../../models/ReflectionCategory";
 import { Component, ConverterComponent } from "../components";
@@ -179,8 +178,10 @@ export class CategoryPlugin extends ConverterComponent {
      * @returns The category the reflection belongs to
      */
     static getCategories(reflection: DeclarationReflection) {
-        function extractCategoryTag(comment: Comment) {
+        function extractCategoryTag(comment: Comment | undefined) {
             const categories = new Set<string>();
+            if (!comment) return categories;
+
             const tags = comment.tags;
             const commentTags: CommentTag[] = [];
             tags.forEach((tag) => {
@@ -198,28 +199,23 @@ export class CategoryPlugin extends ConverterComponent {
             return categories;
         }
 
-        const categories = new Set<string>();
+        let categories = new Set<string>();
 
         if (reflection.comment) {
-            return extractCategoryTag(reflection.comment);
-        } else if (
-            reflection instanceof DeclarationReflection &&
-            reflection.signatures
-        ) {
+            categories = extractCategoryTag(reflection.comment);
+        } else if (reflection.signatures) {
             for (const sig of reflection.signatures) {
-                for (const cat of sig.comment
-                    ? extractCategoryTag(sig.comment)
-                    : []) {
+                for (const cat of extractCategoryTag(sig.comment)) {
                     categories.add(cat);
                 }
             }
         }
 
-        if (
-            reflection.kind === ReflectionKind.TypeAlias &&
-            reflection.type?.type === "reflection"
-        ) {
+        if (reflection.type?.type === "reflection") {
             reflection.type.declaration.comment?.removeTags("category");
+            reflection.type.declaration.signatures?.forEach((s) =>
+                s.comment?.removeTags("category")
+            );
         }
 
         return categories;

diff --git a/src/lib/models/reflections/declaration.ts b/src/lib/models/reflections/declaration.ts
@@ -55,7 +55,7 @@ export class DeclarationReflection extends ContainerReflection {
     /**
      * A list of call signatures attached to this declaration.
      *
-     * TypeDoc creates one declaration per function that may contain ore or more
+     * TypeDoc creates one declaration per function that may contain one or more
      * signature reflections.
      */
     signatures?: SignatureReflection[];

diff --git a/src/test/issueTests.ts b/src/test/issueTests.ts
@@ -274,5 +274,11 @@ export const issueTests: {
 
         ok(cat.children.includes(Foo));
         ok(!Foo.comment?.hasTag("category"));
+        ok(!Foo.type.declaration.comment?.hasTag("category"));
+        ok(
+            !Foo.type.declaration.signatures?.some((s) =>
+                s.comment?.hasTag("category")
+            )
+        );
     },
 };