Support nested namespaces

Resolves #2582
TypeStrong · Jun 1, 2024 · 0875618 · 0875618
1 parent ff65a58
commit 0875618
Show file tree

Hide file tree

Showing 7 changed files with 80 additions and 19 deletions.
diff --git a/src/lib/converter/comments/discovery.ts b/src/lib/converter/comments/discovery.ts
@@ -10,6 +10,7 @@ const variablePropertyKinds = [
     ts.SyntaxKind.PropertySignature,
     ts.SyntaxKind.BinaryExpression,
     ts.SyntaxKind.PropertyAssignment,
+    ts.SyntaxKind.ShorthandPropertyAssignment,
     // class X { constructor(/** Comment */ readonly z: string) }
     ts.SyntaxKind.Parameter,
     // Variable values
@@ -43,6 +44,9 @@ const wantedKinds: Record<ReflectionKind, ts.SyntaxKind[]> = {
         ts.SyntaxKind.BindingElement,
         ts.SyntaxKind.ExportAssignment,
         ts.SyntaxKind.PropertyAccessExpression,
+        ts.SyntaxKind.PropertyDeclaration,
+        ts.SyntaxKind.PropertyAssignment,
+        ts.SyntaxKind.ShorthandPropertyAssignment,
     ],
     [ReflectionKind.Enum]: [
         ts.SyntaxKind.EnumDeclaration,
@@ -61,6 +65,9 @@ const wantedKinds: Record<ReflectionKind, ts.SyntaxKind[]> = {
         ts.SyntaxKind.VariableDeclaration,
         ts.SyntaxKind.ExportAssignment,
         ts.SyntaxKind.PropertyAccessExpression,
+        ts.SyntaxKind.PropertyDeclaration,
+        ts.SyntaxKind.PropertyAssignment,
+        ts.SyntaxKind.ShorthandPropertyAssignment,
     ],
     [ReflectionKind.Class]: [
         ts.SyntaxKind.ClassDeclaration,

diff --git a/src/lib/converter/symbols.ts b/src/lib/converter/symbols.ts
@@ -1007,10 +1007,7 @@ function convertVariableAsNamespace(
     context.finalizeDeclarationReflection(reflection);
     const rc = context.withScope(reflection);
 
-    const declaration = symbol.declarations?.find(ts.isVariableDeclaration);
-    assert(declaration, "Missing variable declaration");
-    const type = context.checker.getTypeAtLocation(declaration);
-
+    const type = context.checker.getTypeOfSymbol(symbol);
     convertSymbols(rc, type.getProperties());
 
     return ts.SymbolFlags.Property;

diff --git a/src/lib/models/MediaRegistry.ts b/src/lib/models/MediaRegistry.ts
@@ -32,6 +32,7 @@ export class MediaRegistry {
         return this.nextId++;
     }
 
+    /** Called by {@link ProjectReflection.registerReflection} @internal*/
     registerReflection(absolute: string, reflection: Reflection) {
         absolute = normalizePath(absolute);
         const id = this.registerAbsolute(absolute);
@@ -106,12 +107,7 @@ export class MediaRegistry {
     fromObject(de: Deserializer, obj: JSONMediaRegistry): void {
         for (const [key, val] of Object.entries(obj.entries)) {
             const absolute = normalizePath(resolve(de.projectRoot, val));
-            const existingId = this.pathToMedia.get(absolute);
-            if (existingId) return;
-
-            de.oldMediaToNewMedia[+key] = this.nextId;
-            this.mediaToPath.set(this.nextId, absolute);
-            this.pathToMedia.set(absolute, this.nextId++);
+            de.oldMediaToNewMedia[+key] = this.registerAbsolute(absolute);
         }
 
         de.defer((project) => {
@@ -145,9 +141,6 @@ export class ValidatingMediaRegistry extends MediaRegistry {
     override fromObject(de: Deserializer, obj: JSONMediaRegistry) {
         for (const [key, val] of Object.entries(obj.entries)) {
             const absolute = normalizePath(resolve(de.projectRoot, val));
-            const existingId = this.pathToMedia.get(absolute);
-            if (existingId) return;
-
             if (!existsSync(absolute)) {
                 de.logger.warn(
                     de.logger.i18n.saved_relative_path_0_resolved_from_1_does_not_exist(
@@ -158,9 +151,7 @@ export class ValidatingMediaRegistry extends MediaRegistry {
                 continue;
             }
 
-            de.oldMediaToNewMedia[+key] = this.nextId;
-            this.mediaToPath.set(this.nextId, absolute);
-            this.pathToMedia.set(absolute, this.nextId++);
+            de.oldMediaToNewMedia[+key] = this.registerAbsolute(absolute);
         }
 
         de.defer((project) => {
@@ -173,6 +164,12 @@ export class ValidatingMediaRegistry extends MediaRegistry {
                         de.oldMediaToNewMedia[+media]!,
                         refl,
                     );
+                } else {
+                    de.logger.warn(
+                        de.logger.i18n.serialized_project_referenced_0_not_part_of_project(
+                            reflId.toString(),
+                        ),
+                    );
                 }
             }
         });

diff --git a/src/lib/models/comments/index.ts b/src/lib/models/comments/index.ts
@@ -1,2 +1,6 @@
 export { Comment, CommentTag } from "./comment";
-export type { CommentDisplayPart, InlineTagDisplayPart } from "./comment";
+export type {
+    CommentDisplayPart,
+    InlineTagDisplayPart,
+    RelativeLinkDisplayPart,
+} from "./comment";
diff --git a/src/test/converter2/issues/gh2582.ts b/src/test/converter2/issues/gh2582.ts
@@ -0,0 +1,22 @@
+function getApi<T>(Ctor: new () => T) {
+    return {
+        /** Member comment */
+        member: 1,
+        /** Fn comment */
+        fn: () => new Ctor(),
+    };
+}
+
+function getAPIs<T1, T2>(Ctor1: new () => T1, Ctor2: new () => T2) {
+    const a = getApi(Ctor1);
+
+    return {
+        /** A comment @namespace*/
+        a,
+        /** B comment @namespace */
+        b: getApi(Ctor2),
+    };
+}
+
+/** f32 comment @namespace */
+export const f32 = getAPIs(Float32Array, Float64Array);
diff --git a/src/test/issues.c2.test.ts b/src/test/issues.c2.test.ts
@@ -27,7 +27,14 @@ import {
     getConverter2Program,
 } from "./programs";
 import { TestLogger } from "./TestLogger";
-import { getComment, getLinks, getSigComment, query, querySig } from "./utils";
+import {
+    equalKind,
+    getComment,
+    getLinks,
+    getSigComment,
+    query,
+    querySig,
+} from "./utils";
 import { DefaultTheme, PageEvent } from "..";
 
 const base = getConverter2Base();
@@ -1526,4 +1533,22 @@ describe("Issue Tests", () => {
             "Incorrect qualified name",
         );
     });
+
+    it("#2582 nested @namespace", () => {
+        const project = convert();
+
+        equalKind(query(project, "f32"), ReflectionKind.Namespace);
+        equalKind(query(project, "f32.a"), ReflectionKind.Namespace);
+        equalKind(query(project, "f32.a.member"), ReflectionKind.Variable);
+        equalKind(query(project, "f32.a.fn"), ReflectionKind.Function);
+        equalKind(query(project, "f32.b"), ReflectionKind.Namespace);
+        equalKind(query(project, "f32.b.member"), ReflectionKind.Reference); // Somewhat odd, but not wrong...
+        equalKind(query(project, "f32.b.fn"), ReflectionKind.Function);
+
+        equal(getComment(project, "f32"), "f32 comment");
+        equal(getComment(project, "f32.a"), "A comment");
+        equal(getComment(project, "f32.a.member"), "Member comment");
+        equal(getComment(project, "f32.a.fn"), "Fn comment");
+        equal(getComment(project, "f32.b"), "B comment");
+    });
 });
diff --git a/src/test/utils.ts b/src/test/utils.ts
@@ -4,10 +4,11 @@ import {
     DeclarationReflection,
     type ProjectReflection,
     Reflection,
-    type ReflectionKind,
+    ReflectionKind,
     type SignatureReflection,
 } from "..";
 import { filterMap } from "../lib/utils";
+import { equal } from "assert/strict";
 
 export function query(
     project: ProjectReflection,
@@ -68,3 +69,11 @@ export function getLinks(refl: Reflection): Array<{
         }
     });
 }
+
+export function equalKind(refl: Reflection, kind: ReflectionKind) {
+    equal(
+        refl.kind,
+        kind,
+        `Expected ${ReflectionKind[kind]} but got ${ReflectionKind[refl.kind]}`,
+    );
+}