Add module readmes to json output (#2500)

* Add module readmes to json output Resolves #2499 * deserialize readme unconditionally
TypeStrong · Feb 11, 2024 · de4d813 · de4d813
1 parent 33db59c
commit de4d813
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git 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),
         };
     }
 
@@ -320,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 || {})) {

diff --git 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 */