From 2ada67e2fb659dc0144f130dc25a643acaca3380 Mon Sep 17 00:00:00 2001 From: John Beresford Date: Sat, 10 Feb 2024 15:20:48 -0800 Subject: [PATCH 1/2] Add module readmes to json output Resolves #2499 --- src/lib/models/reflections/declaration.ts | 1 + src/lib/serialization/schema.ts | 1 + 2 files changed, 2 insertions(+) diff --git a/src/lib/models/reflections/declaration.ts b/src/lib/models/reflections/declaration.ts index ea316449a..bcb6b5616 100644 --- a/src/lib/models/reflections/declaration.ts +++ b/src/lib/models/reflections/declaration.ts @@ -311,6 +311,7 @@ export class DeclarationReflection extends ContainerReflection { this.implementedTypes, ), implementedBy: serializer.toObjectsOptional(this.implementedBy), + readme: Comment.serializeDisplayParts(serializer, this.readme), }; } diff --git a/src/lib/serialization/schema.ts b/src/lib/serialization/schema.ts index ce4f19e83..3709a6d49 100644 --- a/src/lib/serialization/schema.ts +++ b/src/lib/serialization/schema.ts @@ -177,6 +177,7 @@ export interface DeclarationReflection | "getSignature" | "setSignature" | "typeParameters" + | "readme" > {} /** @category Reflections */ From c8ac92ea4816b7a145cfc78a28a255526fb122cd Mon Sep 17 00:00:00 2001 From: John Beresford Date: Sat, 10 Feb 2024 18:49:32 -0800 Subject: [PATCH 2/2] deserialize readme unconditionally --- src/lib/models/reflections/declaration.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/lib/models/reflections/declaration.ts b/src/lib/models/reflections/declaration.ts index bcb6b5616..a3fd3105e 100644 --- a/src/lib/models/reflections/declaration.ts +++ b/src/lib/models/reflections/declaration.ts @@ -321,14 +321,15 @@ export class DeclarationReflection extends ContainerReflection { ): void { super.fromObject(de, obj); + if (obj.readme) { + this.readme = Comment.deserializeDisplayParts(de, obj.readme); + } + // This happens when merging multiple projects together. // If updating this, also check ProjectReflection.fromObject. if (obj.variant === "project") { this.kind = ReflectionKind.Module; this.packageVersion = obj.packageVersion; - if (obj.readme) { - this.readme = Comment.deserializeDisplayParts(de, obj.readme); - } de.defer(() => { for (const [id, sid] of Object.entries(obj.symbolIdMap || {})) {