feat(typewriter): Add docTags map to DocsSpec interface. (#538)

Add `docTags` field to the DocSpec interface. This is a dependency of aws/aws-cdk#26839. --------- Co-authored-by: Mike Wrighton <[email protected]>
cdklabs · Sep 20, 2023 · 54cd5c3 · 54cd5c3
1 parent 5ea9934
commit 54cd5c3
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/packages/@cdklabs/typewriter/src/documented.ts b/packages/@cdklabs/typewriter/src/documented.ts
@@ -85,6 +85,12 @@ export interface DocsSpec {
    * @default none
    */
   see?: string;
+  /**
+   * A map of document tags where the key represents the tag name.
+   *
+   * @default none
+   */
+  docTags?: Record<string, string>;
   /**
    * Description of the default
    *

diff --git a/packages/@cdklabs/typewriter/src/renderer/typescript.ts b/packages/@cdklabs/typewriter/src/renderer/typescript.ts
@@ -714,7 +714,13 @@ export class TypeScriptRenderer extends Renderer {
     if (options?.forceStruct) {
       line('@struct');
     }
+
     tagged('deprecated', el.docs?.deprecated);
+
+    for (const key in el.docs?.docTags) {
+      tagged(key, el.docs?.docTags[key]);
+    }
+
     tagged('stability', el.docs?.stability);
     tagged('default -', el.docs?.default);
     tagged('returns', el.docs?.returns);