fix(core): expose missing entrypoints to navigation (#663)

typedoc2md · Aug 24, 2024 · 310edc6 · 310edc6
1 parent e9ceaa3
commit 310edc6
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 13 deletions.
diff --git a/.changeset/calm-mice-hang.md b/.changeset/calm-mice-hang.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Expose missing entrypoints to navigation (#663)
diff --git a/packages/typedoc-plugin-markdown/src/theme/base/navigation-builder.ts b/packages/typedoc-plugin-markdown/src/theme/base/navigation-builder.ts
@@ -49,9 +49,25 @@ export class NavigationBuilder {
       this.buildNavigationFromProject(this.project);
     }
 
+    this.removeEmptyChildren(this.navigation);
+
     return this.navigation;
   }
 
+  private removeEmptyChildren(navigation: NavigationItem[]): void {
+    navigation.forEach((navItem) => {
+      if (navItem.children) {
+        this.removeEmptyChildren(navItem.children);
+        navItem.children = navItem.children.filter(
+          (child) => Object.keys(child).length > 0,
+        );
+        if (navItem.children.length === 0) {
+          delete navItem.children;
+        }
+      }
+    });
+  }
+
   private buildNavigationFromPackage(projectChild: DeclarationReflection) {
     const fileExtension = this.options.getValue('fileExtension');
 
@@ -252,10 +268,7 @@ export class NavigationBuilder {
     reflection: DeclarationReflection | DocumentReflection,
     outputFileStrategy?: OutputFileStrategy,
   ): NavigationItem[] | null {
-    if (
-      reflection instanceof DeclarationReflection &&
-      reflection.groups?.some((group) => group.allChildrenHaveOwnDocument())
-    ) {
+    if (reflection instanceof DeclarationReflection) {
       if (this.navigationOptions.excludeGroups) {
         return reflection.childrenIncludingDocuments
           ?.filter((child) => child.hasOwnDocument)

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
@@ -633,7 +633,6 @@ exports[`Navigation should get Navigation Json for packages: (Output File Strate
   {
     "title": "package-1b",
     "kind": 2,
-    "children": [],
     "path": "package-1b/index.md"
   },
   {
@@ -759,7 +758,29 @@ exports[`Navigation should get Navigation Json for packages: (Output File Strate
       {
         "title": "module-1",
         "kind": 2,
-        "path": "package-7/module-1.md"
+        "path": "package-7/module-1.md",
+        "children": [
+          {
+            "title": "submodules",
+            "children": [
+              {
+                "title": "submodule-3-with-modules",
+                "children": [
+                  {
+                    "title": "nested-submodule-1",
+                    "kind": 2,
+                    "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md"
+                  },
+                  {
+                    "title": "nested-submodule-2",
+                    "kind": 2,
+                    "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
       },
       {
         "title": "module-2",
@@ -777,13 +798,11 @@ exports[`Navigation should get Navigation Json for packages: (Output File Strate
   {
     "title": "@scope/package-1",
     "kind": 2,
-    "children": [],
     "path": "package-1/README.md"
   },
   {
     "title": "package-1b",
     "kind": 2,
-    "children": [],
     "path": "package-1b/README.md"
   },
   {
@@ -909,7 +928,29 @@ exports[`Navigation should get Navigation Json for packages: (Output File Strate
       {
         "title": "module-1",
         "kind": 2,
-        "path": "package-7/module-1.md"
+        "path": "package-7/module-1.md",
+        "children": [
+          {
+            "title": "submodules",
+            "children": [
+              {
+                "title": "submodule-3-with-modules",
+                "children": [
+                  {
+                    "title": "nested-submodule-1",
+                    "kind": 2,
+                    "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md"
+                  },
+                  {
+                    "title": "nested-submodule-2",
+                    "kind": 2,
+                    "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
       },
       {
         "title": "module-2",
@@ -3973,8 +4014,7 @@ exports[`Navigation should gets Navigation Json for multiple entry points: (Outp
   {
     "title": "has-categories",
     "kind": 2,
-    "path": "has-categories.md",
-    "children": []
+    "path": "has-categories.md"
   },
   {
     "title": "has-custom-groups",
@@ -4116,8 +4156,7 @@ exports[`Navigation should gets Navigation Json for single entry point: (Output
       {
         "title": "ClassWithPropCategories",
         "kind": 128,
-        "path": "classes/ClassWithPropCategories.md",
-        "children": []
+        "path": "classes/ClassWithPropCategories.md"
       },
       {
         "title": "ClassWithSimpleProps",