fix: Categorization was broken with a single entry point

TypeStrong · Dec 27, 2020 · 7f6e924 · 7f6e924
1 parent 23cb492
commit 7f6e924
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 14 deletions.
diff --git a/bin/typedoc b/bin/typedoc
@@ -42,6 +42,11 @@ async function run(app) {
         return ExitCodes.Ok;
     }
 
+    if (app.options.getValue("showConfig")) {
+        console.log(app.options.getRawValues());
+        return ExitCodes.Ok;
+    }
+
     if (app.logger.hasErrors()) {
         return ExitCodes.OptionError;
     }

diff --git a/src/lib/converter/plugins/CategoryPlugin.ts b/src/lib/converter/plugins/CategoryPlugin.ts
@@ -96,6 +96,8 @@ export class CategoryPlugin extends ConverterComponent {
             return;
         }
         obj.groups.forEach((group) => {
+            if (group.categories) return;
+
             group.categories = CategoryPlugin.getReflectionCategories(
                 group.children
             );
@@ -112,7 +114,7 @@ export class CategoryPlugin extends ConverterComponent {
     }
 
     private lumpCategorize(obj: ContainerReflection) {
-        if (!obj.children || obj.children.length === 0) {
+        if (!obj.children || obj.children.length === 0 || obj.categories) {
             return;
         }
         obj.categories = CategoryPlugin.getReflectionCategories(obj.children);
@@ -196,11 +198,14 @@ export class CategoryPlugin extends ConverterComponent {
             reflection.signatures
         ) {
             // If a reflection has signatures, use the first category tag amongst them
-            reflection.signatures.forEach((sig) => {
-                if (sig.comment && category === "") {
+            for (const sig of reflection.signatures) {
+                if (sig.comment) {
                     category = extractCategoryTag(sig.comment);
                 }
-            });
+                if (category != "") {
+                    break;
+                }
+            }
         }
         return category;
     }

diff --git a/src/lib/converter/plugins/GroupPlugin.ts b/src/lib/converter/plugins/GroupPlugin.ts
@@ -9,6 +9,7 @@ import { SourceDirectory } from "../../models/sources/directory";
 import { Component, ConverterComponent } from "../components";
 import { Converter } from "../converter";
 import { Context } from "../context";
+import { ReflectionCategory } from "../../models";
 
 /**
  * A handler that sorts and groups the found reflections in the resolving phase.
@@ -88,12 +89,7 @@ export class GroupPlugin extends ConverterComponent {
         reflection.kindString = GroupPlugin.getKindSingular(reflection.kind);
 
         if (reflection instanceof ContainerReflection) {
-            if (reflection.children && reflection.children.length > 0) {
-                reflection.children.sort(GroupPlugin.sortCallback);
-                reflection.groups = GroupPlugin.getReflectionGroups(
-                    reflection.children
-                );
-            }
+            this.group(reflection);
         }
     }
 
@@ -114,17 +110,27 @@ export class GroupPlugin extends ConverterComponent {
         }
 
         const project = context.project;
-        if (project.children && project.children.length > 0) {
-            project.children.sort(GroupPlugin.sortCallback);
-            project.groups = GroupPlugin.getReflectionGroups(project.children);
-        }
+        this.group(project);
 
         walkDirectory(project.directory);
         project.files.forEach((file) => {
             file.groups = GroupPlugin.getReflectionGroups(file.reflections);
         });
     }
 
+    private group(reflection: ContainerReflection) {
+        if (
+            reflection.children &&
+            reflection.children.length > 0 &&
+            !reflection.groups
+        ) {
+            reflection.children.sort(GroupPlugin.sortCallback);
+            reflection.groups = GroupPlugin.getReflectionGroups(
+                reflection.children
+            );
+        }
+    }
+
     /**
      * Create a grouped representation of the given list of reflections.
      *

diff --git a/src/lib/utils/options/declaration.ts b/src/lib/utils/options/declaration.ts
@@ -69,6 +69,7 @@ export interface TypeDocOptionMap {
 
     help: boolean;
     version: boolean;
+    showConfig: boolean;
     plugin: string[];
     logger: unknown; // string | Function
     logLevel: typeof LogLevel;

diff --git a/src/lib/utils/options/sources/typedoc.ts b/src/lib/utils/options/sources/typedoc.ts
@@ -183,6 +183,11 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         help: "Print TypeDoc's version.",
         type: ParameterType.Boolean,
     });
+    options.addDeclaration({
+        name: "showConfig",
+        help: "Print the resolved configuration and exit",
+        type: ParameterType.Boolean,
+    });
     options.addDeclaration({
         name: "plugin",
         help: