map TS 4.3+ JSDocTagInfo to CompilerJsDocTagInfo

See microsoft/TypeScript#43312

Author: ltm

src/compiler/transformers/decorators-to-static/method-decorator.ts

@@ -5,6 +5,7 @@ import {
   createStaticGetter,
   getAttributeTypeInfo,
   isMemberPrivate,
+  mapJSDocTagInfo,
   serializeSymbol,
   typeToString,
   validateReferences,
@@ -95,7 +96,7 @@ const parseMethodDecorator = (
     },
     docs: {
       text: ts.displayPartsToString(signature.getDocumentationComment(typeChecker)),
-      tags: signature.getJsDocTags(),
+      tags: mapJSDocTagInfo(signature.getJsDocTags()),
     },
   };
   validateReferences(diagnostics, methodMeta.complexType.references, method.type || method.name);

src/compiler/transformers/test/transform-utils.spec.ts

@@ -0,0 +1,29 @@
+import { mapJSDocTagInfo } from '../transform-utils';
+
+describe('transform utils', () => {
+  it('flattens TypeScript JSDocTagInfo to Stencil JSDocTagInfo', () => {
+    const tags = [
+      {
+        name: 'param',
+        text: [
+          { kind: 'text', text: 'foo' },
+          { kind: 'space', text: ' ' },
+          { kind: 'text', text: 'the first parameter' },
+        ],
+      },
+      {
+        name: 'param',
+        text: [
+          { kind: 'text', text: 'bar' },
+          { kind: 'space', text: ' ' },
+          { kind: 'text', text: 'the second parameter' },
+        ],
+      },
+    ];
+
+    expect(mapJSDocTagInfo(tags)).toEqual([
+      { name: 'param', text: 'foo the first parameter' },
+      { name: 'param', text: 'bar the second parameter' },
+    ]);
+  });
+});

src/compiler/transformers/transform-utils.ts

@@ -515,11 +515,20 @@ export const serializeSymbol = (checker: ts.TypeChecker, symbol: ts.Symbol): d.C
     };
   }
   return {
-    tags: symbol.getJsDocTags().map((tag) => ({ text: tag.text, name: tag.name })),
+    tags: mapJSDocTagInfo(symbol.getJsDocTags()),
     text: ts.displayPartsToString(symbol.getDocumentationComment(checker)),
   };
 };
 
+/**
+ * Maps a TypeScript 4.3+ JSDocTagInfo to a flattened Stencil CompilerJsDocTagInfo.
+ * @param tags An array of JSDocTagInfo objects.
+ * @return An array of CompilerJsDocTagInfo objects.
+ */
+export const mapJSDocTagInfo = (tags: ts.JSDocTagInfo[]): d.CompilerJsDocTagInfo[] => {
+  return tags.map((tag) => ({ ...tag, text: tag.text?.map((part) => part.text).join('') }));
+};
+
 export const serializeDocsSymbol = (checker: ts.TypeChecker, symbol: ts.Symbol) => {
   const type = checker.getTypeOfSymbolAtLocation(symbol, symbol.valueDeclaration);
   const set = new Set<string>();