@teambit/typescript 0.0.758 → 0.0.761

package/dist/transformers/utils/jsdoc-to-doc-schema.js

@@ -77,75 +77,77 @@ async function jsDocToDocSchema(node, context) {
   const location = context.getLocation(jsDoc);
   const comment = (0, _typescript().getTextOfJSDocComment)(jsDoc.comment);
   const tags = jsDoc.tags ? await (0, _pMapSeries().default)(jsDoc.tags, tag => tagParser(tag, context)) : undefined;
-  return new (_semanticsEntities().DocSchema)(location, comment, tags);
+  return new (_semanticsEntities().DocSchema)(location, jsDoc.getText(), comment, tags);
 }
 
 async function tagParser(tag, context) {
-  let tagName = tag.tagName.getText();
-
+  // for some reason, in some cases, if `tag.getSourceFile()` is not provided to the `getText()`, it throws "Cannot read property 'text' of undefined"
   switch (tag.kind) {
     case _typescript().SyntaxKind.JSDocReturnTag:
       return returnTag(tag, context);
 
+    case _typescript().SyntaxKind.JSDocPropertyTag:
+      return propertyLikeTag(tag, context);
+
+    case _typescript().SyntaxKind.JSDocParameterTag:
+      return propertyLikeTag(tag, context);
+
     case _typescript().SyntaxKind.JSDocAugmentsTag:
-      tagName = _semanticsEntities().TagName.augments;
+      return simpleTag(tag, _semanticsEntities().TagName.augments, context);
 
     case _typescript().SyntaxKind.JSDocAuthorTag:
-      tagName = _semanticsEntities().TagName.author;
+      return simpleTag(tag, _semanticsEntities().TagName.author, context);
 
     case _typescript().SyntaxKind.JSDocClassTag:
-      tagName = _semanticsEntities().TagName.class;
+      return simpleTag(tag, _semanticsEntities().TagName.class, context);
 
     case _typescript().SyntaxKind.JSDocCallbackTag:
-      tagName = _semanticsEntities().TagName.callback;
+      return simpleTag(tag, _semanticsEntities().TagName.callback, context);
 
     case _typescript().SyntaxKind.JSDocPublicTag:
-      tagName = _semanticsEntities().TagName.public;
+      return simpleTag(tag, _semanticsEntities().TagName.public, context);
 
     case _typescript().SyntaxKind.JSDocPrivateTag:
-      tagName = _semanticsEntities().TagName.private;
+      return simpleTag(tag, _semanticsEntities().TagName.private, context);
 
     case _typescript().SyntaxKind.JSDocProtectedTag:
-      tagName = _semanticsEntities().TagName.protected;
+      return simpleTag(tag, _semanticsEntities().TagName.protected, context);
 
     case _typescript().SyntaxKind.JSDocReadonlyTag:
-      tagName = _semanticsEntities().TagName.readonly;
+      return simpleTag(tag, _semanticsEntities().TagName.readonly, context);
 
     case _typescript().SyntaxKind.JSDocOverrideTag:
-      tagName = _semanticsEntities().TagName.override;
+      return simpleTag(tag, _semanticsEntities().TagName.override, context);
 
     case _typescript().SyntaxKind.JSDocDeprecatedTag:
-      tagName = _semanticsEntities().TagName.deprecated;
+      return simpleTag(tag, _semanticsEntities().TagName.deprecated, context);
 
     case _typescript().SyntaxKind.JSDocSeeTag:
-      tagName = _semanticsEntities().TagName.see;
+      return simpleTag(tag, _semanticsEntities().TagName.see, context);
 
     case _typescript().SyntaxKind.JSDocEnumTag:
-      tagName = _semanticsEntities().TagName.enum;
-
-    case _typescript().SyntaxKind.JSDocParameterTag:
-      tagName = _semanticsEntities().TagName.parameter;
+      return simpleTag(tag, _semanticsEntities().TagName.enum, context);
 
     case _typescript().SyntaxKind.JSDocThisTag:
-      tagName = _semanticsEntities().TagName.this;
+      return simpleTag(tag, _semanticsEntities().TagName.this, context);
 
     case _typescript().SyntaxKind.JSDocTypeTag:
-      tagName = _semanticsEntities().TagName.type;
+      return simpleTag(tag, _semanticsEntities().TagName.type, context);
 
     case _typescript().SyntaxKind.JSDocTemplateTag:
-      tagName = _semanticsEntities().TagName.template;
+      return simpleTag(tag, _semanticsEntities().TagName.template, context);
 
     case _typescript().SyntaxKind.JSDocTypedefTag:
-      tagName = _semanticsEntities().TagName.typedef;
-
-    case _typescript().SyntaxKind.JSDocPropertyTag:
-      tagName = _semanticsEntities().TagName.property;
+      return simpleTag(tag, _semanticsEntities().TagName.typedef, context);
 
     case _typescript().SyntaxKind.JSDocImplementsTag:
-      tagName = _semanticsEntities().TagName.implements;
+      return simpleTag(tag, _semanticsEntities().TagName.implements, context);
 
     default:
-      return simpleTag(tag, tagName, context);
+      {
+        const tagName = tag.tagName.getText(tag.getSourceFile());
+        return simpleTag(tag, tagName, context);
+      }
   }
 }
 
@@ -157,7 +159,14 @@ async function returnTag(tag, context) {
   var _tag$typeExpression, _tag$typeExpression2;
 
   const type = (_tag$typeExpression = tag.typeExpression) !== null && _tag$typeExpression !== void 0 && _tag$typeExpression.type ? await (0, _typeNodeToSchema().typeNodeToSchema)((_tag$typeExpression2 = tag.typeExpression) === null || _tag$typeExpression2 === void 0 ? void 0 : _tag$typeExpression2.type, context) : undefined;
-  return new (_semanticsEntities().ReturnTagSchema)(context.getLocation(tag), _semanticsEntities().TagName.return, (0, _typescript().getTextOfJSDocComment)(tag.comment), type);
+  return new (_semanticsEntities().ReturnTagSchema)(context.getLocation(tag), (0, _typescript().getTextOfJSDocComment)(tag.comment), type);
+}
+
+async function propertyLikeTag(tag, context) {
+  var _tag$typeExpression3, _tag$typeExpression4;
+
+  const type = (_tag$typeExpression3 = tag.typeExpression) !== null && _tag$typeExpression3 !== void 0 && _tag$typeExpression3.type ? await (0, _typeNodeToSchema().typeNodeToSchema)((_tag$typeExpression4 = tag.typeExpression) === null || _tag$typeExpression4 === void 0 ? void 0 : _tag$typeExpression4.type, context) : undefined;
+  return new (_semanticsEntities().PropertyLikeTagSchema)(context.getLocation(tag), tag.name.getText(), (0, _typescript().getTextOfJSDocComment)(tag.comment), type);
 }
 
 //# sourceMappingURL=jsdoc-to-doc-schema.js.map

package/dist/transformers/utils/jsdoc-to-doc-schema.js.map

@@ -1 +1 @@
-{"version":3,"names":["jsDocToDocSchema","node","context","canHaveJsDoc","undefined","jsDocs","getJsDoc","length","jsDoc","location","getLocation","comment","getTextOfJSDocComment","tags","pMapSeries","tag","tagParser","DocSchema","tagName","getText","kind","SyntaxKind","JSDocReturnTag","returnTag","JSDocAugmentsTag","TagName","augments","JSDocAuthorTag","author","JSDocClassTag","class","JSDocCallbackTag","callback","JSDocPublicTag","public","JSDocPrivateTag","private","JSDocProtectedTag","protected","JSDocReadonlyTag","readonly","JSDocOverrideTag","override","JSDocDeprecatedTag","deprecated","JSDocSeeTag","see","JSDocEnumTag","enum","JSDocParameterTag","parameter","JSDocThisTag","this","JSDocTypeTag","type","JSDocTemplateTag","template","JSDocTypedefTag","typedef","JSDocPropertyTag","property","JSDocImplementsTag","implements","simpleTag","TagSchema","typeExpression","typeNodeToSchema","ReturnTagSchema","return"],"sources":["jsdoc-to-doc-schema.ts"],"sourcesContent":["/* eslint-disable no-fallthrough */\nimport { getTextOfJSDocComment, JSDocReturnTag, JSDocTag, Node, SyntaxKind } from 'typescript';\nimport { getJsDoc, canHaveJsDoc } from 'tsutils';\nimport pMapSeries from 'p-map-series';\nimport { DocSchema, ReturnTagSchema, TagName, TagSchema } from '@teambit/semantics.entities.semantic-schema';\nimport { SchemaExtractorContext } from '../../schema-extractor-context';\nimport { typeNodeToSchema } from './type-node-to-schema';\n\nexport async function jsDocToDocSchema(node: Node, context: SchemaExtractorContext): Promise<DocSchema | undefined> {\n  if (!canHaveJsDoc(node)) {\n    return undefined;\n  }\n  const jsDocs = getJsDoc(node);\n  if (!jsDocs.length) {\n    return undefined;\n  }\n  // not sure how common it is to have multiple JSDocs. never seen it before.\n  // regardless, in typescript implementation of methods like `getJSDocDeprecatedTag()`, they use the first one. (`getFirstJSDocTag()`)\n  const jsDoc = jsDocs[0];\n  const location = context.getLocation(jsDoc);\n  const comment = getTextOfJSDocComment(jsDoc.comment);\n  const tags = jsDoc.tags ? await pMapSeries(jsDoc.tags, (tag) => tagParser(tag, context)) : undefined;\n  return new DocSchema(location, comment, tags);\n}\n\nasync function tagParser(tag: JSDocTag, context: SchemaExtractorContext): Promise<TagSchema> {\n  let tagName: TagName | string = tag.tagName.getText();\n  switch (tag.kind) {\n    case SyntaxKind.JSDocReturnTag:\n      return returnTag(tag as JSDocReturnTag, context);\n    case SyntaxKind.JSDocAugmentsTag:\n      tagName = TagName.augments;\n    case SyntaxKind.JSDocAuthorTag:\n      tagName = TagName.author;\n    case SyntaxKind.JSDocClassTag:\n      tagName = TagName.class;\n    case SyntaxKind.JSDocCallbackTag:\n      tagName = TagName.callback;\n    case SyntaxKind.JSDocPublicTag:\n      tagName = TagName.public;\n    case SyntaxKind.JSDocPrivateTag:\n      tagName = TagName.private;\n    case SyntaxKind.JSDocProtectedTag:\n      tagName = TagName.protected;\n    case SyntaxKind.JSDocReadonlyTag:\n      tagName = TagName.readonly;\n    case SyntaxKind.JSDocOverrideTag:\n      tagName = TagName.override;\n    case SyntaxKind.JSDocDeprecatedTag:\n      tagName = TagName.deprecated;\n    case SyntaxKind.JSDocSeeTag:\n      tagName = TagName.see;\n    case SyntaxKind.JSDocEnumTag:\n      tagName = TagName.enum;\n    case SyntaxKind.JSDocParameterTag:\n      tagName = TagName.parameter;\n    case SyntaxKind.JSDocThisTag:\n      tagName = TagName.this;\n    case SyntaxKind.JSDocTypeTag:\n      tagName = TagName.type;\n    case SyntaxKind.JSDocTemplateTag:\n      tagName = TagName.template;\n    case SyntaxKind.JSDocTypedefTag:\n      tagName = TagName.typedef;\n    case SyntaxKind.JSDocPropertyTag:\n      tagName = TagName.property;\n    case SyntaxKind.JSDocImplementsTag:\n      tagName = TagName.implements;\n    default:\n      return simpleTag(tag, tagName, context);\n  }\n}\n\nfunction simpleTag(tag: JSDocTag, tagName: TagName | string, context: SchemaExtractorContext): TagSchema {\n  return new TagSchema(context.getLocation(tag), tagName, getTextOfJSDocComment(tag.comment));\n}\n\nasync function returnTag(tag: JSDocReturnTag, context: SchemaExtractorContext) {\n  const type = tag.typeExpression?.type ? await typeNodeToSchema(tag.typeExpression?.type, context) : undefined;\n  return new ReturnTagSchema(context.getLocation(tag), TagName.return, getTextOfJSDocComment(tag.comment), type);\n}\n"],"mappings":";;;;;;;;;;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AANA;AAQO,eAAeA,gBAAf,CAAgCC,IAAhC,EAA4CC,OAA5C,EAA6G;EAClH,IAAI,CAAC,IAAAC,uBAAA,EAAaF,IAAb,CAAL,EAAyB;IACvB,OAAOG,SAAP;EACD;;EACD,MAAMC,MAAM,GAAG,IAAAC,mBAAA,EAASL,IAAT,CAAf;;EACA,IAAI,CAACI,MAAM,CAACE,MAAZ,EAAoB;IAClB,OAAOH,SAAP;EACD,CAPiH,CAQlH;EACA;;;EACA,MAAMI,KAAK,GAAGH,MAAM,CAAC,CAAD,CAApB;EACA,MAAMI,QAAQ,GAAGP,OAAO,CAACQ,WAAR,CAAoBF,KAApB,CAAjB;EACA,MAAMG,OAAO,GAAG,IAAAC,mCAAA,EAAsBJ,KAAK,CAACG,OAA5B,CAAhB;EACA,MAAME,IAAI,GAAGL,KAAK,CAACK,IAAN,GAAa,MAAM,IAAAC,qBAAA,EAAWN,KAAK,CAACK,IAAjB,EAAwBE,GAAD,IAASC,SAAS,CAACD,GAAD,EAAMb,OAAN,CAAzC,CAAnB,GAA8EE,SAA3F;EACA,OAAO,KAAIa,8BAAJ,EAAcR,QAAd,EAAwBE,OAAxB,EAAiCE,IAAjC,CAAP;AACD;;AAED,eAAeG,SAAf,CAAyBD,GAAzB,EAAwCb,OAAxC,EAA6F;EAC3F,IAAIgB,OAAyB,GAAGH,GAAG,CAACG,OAAJ,CAAYC,OAAZ,EAAhC;;EACA,QAAQJ,GAAG,CAACK,IAAZ;IACE,KAAKC,wBAAA,CAAWC,cAAhB;MACE,OAAOC,SAAS,CAACR,GAAD,EAAwBb,OAAxB,CAAhB;;IACF,KAAKmB,wBAAA,CAAWG,gBAAhB;MACEN,OAAO,GAAGO,4BAAA,CAAQC,QAAlB;;IACF,KAAKL,wBAAA,CAAWM,cAAhB;MACET,OAAO,GAAGO,4BAAA,CAAQG,MAAlB;;IACF,KAAKP,wBAAA,CAAWQ,aAAhB;MACEX,OAAO,GAAGO,4BAAA,CAAQK,KAAlB;;IACF,KAAKT,wBAAA,CAAWU,gBAAhB;MACEb,OAAO,GAAGO,4BAAA,CAAQO,QAAlB;;IACF,KAAKX,wBAAA,CAAWY,cAAhB;MACEf,OAAO,GAAGO,4BAAA,CAAQS,MAAlB;;IACF,KAAKb,wBAAA,CAAWc,eAAhB;MACEjB,OAAO,GAAGO,4BAAA,CAAQW,OAAlB;;IACF,KAAKf,wBAAA,CAAWgB,iBAAhB;MACEnB,OAAO,GAAGO,4BAAA,CAAQa,SAAlB;;IACF,KAAKjB,wBAAA,CAAWkB,gBAAhB;MACErB,OAAO,GAAGO,4BAAA,CAAQe,QAAlB;;IACF,KAAKnB,wBAAA,CAAWoB,gBAAhB;MACEvB,OAAO,GAAGO,4BAAA,CAAQiB,QAAlB;;IACF,KAAKrB,wBAAA,CAAWsB,kBAAhB;MACEzB,OAAO,GAAGO,4BAAA,CAAQmB,UAAlB;;IACF,KAAKvB,wBAAA,CAAWwB,WAAhB;MACE3B,OAAO,GAAGO,4BAAA,CAAQqB,GAAlB;;IACF,KAAKzB,wBAAA,CAAW0B,YAAhB;MACE7B,OAAO,GAAGO,4BAAA,CAAQuB,IAAlB;;IACF,KAAK3B,wBAAA,CAAW4B,iBAAhB;MACE/B,OAAO,GAAGO,4BAAA,CAAQyB,SAAlB;;IACF,KAAK7B,wBAAA,CAAW8B,YAAhB;MACEjC,OAAO,GAAGO,4BAAA,CAAQ2B,IAAlB;;IACF,KAAK/B,wBAAA,CAAWgC,YAAhB;MACEnC,OAAO,GAAGO,4BAAA,CAAQ6B,IAAlB;;IACF,KAAKjC,wBAAA,CAAWkC,gBAAhB;MACErC,OAAO,GAAGO,4BAAA,CAAQ+B,QAAlB;;IACF,KAAKnC,wBAAA,CAAWoC,eAAhB;MACEvC,OAAO,GAAGO,4BAAA,CAAQiC,OAAlB;;IACF,KAAKrC,wBAAA,CAAWsC,gBAAhB;MACEzC,OAAO,GAAGO,4BAAA,CAAQmC,QAAlB;;IACF,KAAKvC,wBAAA,CAAWwC,kBAAhB;MACE3C,OAAO,GAAGO,4BAAA,CAAQqC,UAAlB;;IACF;MACE,OAAOC,SAAS,CAAChD,GAAD,EAAMG,OAAN,EAAehB,OAAf,CAAhB;EA1CJ;AA4CD;;AAED,SAAS6D,SAAT,CAAmBhD,GAAnB,EAAkCG,OAAlC,EAA6DhB,OAA7D,EAAyG;EACvG,OAAO,KAAI8D,8BAAJ,EAAc9D,OAAO,CAACQ,WAAR,CAAoBK,GAApB,CAAd,EAAwCG,OAAxC,EAAiD,IAAAN,mCAAA,EAAsBG,GAAG,CAACJ,OAA1B,CAAjD,CAAP;AACD;;AAED,eAAeY,SAAf,CAAyBR,GAAzB,EAA8Cb,OAA9C,EAA+E;EAAA;;EAC7E,MAAMoD,IAAI,GAAG,uBAAAvC,GAAG,CAACkD,cAAJ,oEAAoBX,IAApB,GAA2B,MAAM,IAAAY,oCAAA,0BAAiBnD,GAAG,CAACkD,cAArB,yDAAiB,qBAAoBX,IAArC,EAA2CpD,OAA3C,CAAjC,GAAuFE,SAApG;EACA,OAAO,KAAI+D,oCAAJ,EAAoBjE,OAAO,CAACQ,WAAR,CAAoBK,GAApB,CAApB,EAA8CU,4BAAA,CAAQ2C,MAAtD,EAA8D,IAAAxD,mCAAA,EAAsBG,GAAG,CAACJ,OAA1B,CAA9D,EAAkG2C,IAAlG,CAAP;AACD"}
+{"version":3,"names":["jsDocToDocSchema","node","context","canHaveJsDoc","undefined","jsDocs","getJsDoc","length","jsDoc","location","getLocation","comment","getTextOfJSDocComment","tags","pMapSeries","tag","tagParser","DocSchema","getText","kind","SyntaxKind","JSDocReturnTag","returnTag","JSDocPropertyTag","propertyLikeTag","JSDocParameterTag","JSDocAugmentsTag","simpleTag","TagName","augments","JSDocAuthorTag","author","JSDocClassTag","class","JSDocCallbackTag","callback","JSDocPublicTag","public","JSDocPrivateTag","private","JSDocProtectedTag","protected","JSDocReadonlyTag","readonly","JSDocOverrideTag","override","JSDocDeprecatedTag","deprecated","JSDocSeeTag","see","JSDocEnumTag","enum","JSDocThisTag","this","JSDocTypeTag","type","JSDocTemplateTag","template","JSDocTypedefTag","typedef","JSDocImplementsTag","implements","tagName","getSourceFile","TagSchema","typeExpression","typeNodeToSchema","ReturnTagSchema","PropertyLikeTagSchema","name"],"sources":["jsdoc-to-doc-schema.ts"],"sourcesContent":["/* eslint-disable no-fallthrough */\nimport {\n  getTextOfJSDocComment,\n  JSDocParameterTag,\n  JSDocPropertyLikeTag,\n  JSDocPropertyTag,\n  JSDocReturnTag,\n  JSDocTag,\n  Node,\n  SyntaxKind,\n} from 'typescript';\nimport { getJsDoc, canHaveJsDoc } from 'tsutils';\nimport pMapSeries from 'p-map-series';\nimport {\n  DocSchema,\n  PropertyLikeTagSchema,\n  ReturnTagSchema,\n  TagName,\n  TagSchema,\n} from '@teambit/semantics.entities.semantic-schema';\nimport { SchemaExtractorContext } from '../../schema-extractor-context';\nimport { typeNodeToSchema } from './type-node-to-schema';\n\nexport async function jsDocToDocSchema(node: Node, context: SchemaExtractorContext): Promise<DocSchema | undefined> {\n  if (!canHaveJsDoc(node)) {\n    return undefined;\n  }\n  const jsDocs = getJsDoc(node);\n  if (!jsDocs.length) {\n    return undefined;\n  }\n  // not sure how common it is to have multiple JSDocs. never seen it before.\n  // regardless, in typescript implementation of methods like `getJSDocDeprecatedTag()`, they use the first one. (`getFirstJSDocTag()`)\n  const jsDoc = jsDocs[0];\n  const location = context.getLocation(jsDoc);\n  const comment = getTextOfJSDocComment(jsDoc.comment);\n  const tags = jsDoc.tags ? await pMapSeries(jsDoc.tags, (tag) => tagParser(tag, context)) : undefined;\n  return new DocSchema(location, jsDoc.getText(), comment, tags);\n}\n\nasync function tagParser(tag: JSDocTag, context: SchemaExtractorContext): Promise<TagSchema> {\n  // for some reason, in some cases, if `tag.getSourceFile()` is not provided to the `getText()`, it throws \"Cannot read property 'text' of undefined\"\n\n  switch (tag.kind) {\n    case SyntaxKind.JSDocReturnTag:\n      return returnTag(tag as JSDocReturnTag, context);\n    case SyntaxKind.JSDocPropertyTag:\n      return propertyLikeTag(tag as JSDocPropertyTag, context);\n    case SyntaxKind.JSDocParameterTag:\n      return propertyLikeTag(tag as JSDocParameterTag, context);\n    case SyntaxKind.JSDocAugmentsTag:\n      return simpleTag(tag, TagName.augments, context);\n    case SyntaxKind.JSDocAuthorTag:\n      return simpleTag(tag, TagName.author, context);\n    case SyntaxKind.JSDocClassTag:\n      return simpleTag(tag, TagName.class, context);\n    case SyntaxKind.JSDocCallbackTag:\n      return simpleTag(tag, TagName.callback, context);\n    case SyntaxKind.JSDocPublicTag:\n      return simpleTag(tag, TagName.public, context);\n    case SyntaxKind.JSDocPrivateTag:\n      return simpleTag(tag, TagName.private, context);\n    case SyntaxKind.JSDocProtectedTag:\n      return simpleTag(tag, TagName.protected, context);\n    case SyntaxKind.JSDocReadonlyTag:\n      return simpleTag(tag, TagName.readonly, context);\n    case SyntaxKind.JSDocOverrideTag:\n      return simpleTag(tag, TagName.override, context);\n    case SyntaxKind.JSDocDeprecatedTag:\n      return simpleTag(tag, TagName.deprecated, context);\n    case SyntaxKind.JSDocSeeTag:\n      return simpleTag(tag, TagName.see, context);\n    case SyntaxKind.JSDocEnumTag:\n      return simpleTag(tag, TagName.enum, context);\n    case SyntaxKind.JSDocThisTag:\n      return simpleTag(tag, TagName.this, context);\n    case SyntaxKind.JSDocTypeTag:\n      return simpleTag(tag, TagName.type, context);\n    case SyntaxKind.JSDocTemplateTag:\n      return simpleTag(tag, TagName.template, context);\n    case SyntaxKind.JSDocTypedefTag:\n      return simpleTag(tag, TagName.typedef, context);\n    case SyntaxKind.JSDocImplementsTag:\n      return simpleTag(tag, TagName.implements, context);\n    default: {\n      const tagName: TagName | string = tag.tagName.getText(tag.getSourceFile());\n      return simpleTag(tag, tagName, context);\n    }\n  }\n}\n\nfunction simpleTag(tag: JSDocTag, tagName: TagName | string, context: SchemaExtractorContext): TagSchema {\n  return new TagSchema(context.getLocation(tag), tagName, getTextOfJSDocComment(tag.comment));\n}\n\nasync function returnTag(tag: JSDocReturnTag, context: SchemaExtractorContext) {\n  const type = tag.typeExpression?.type ? await typeNodeToSchema(tag.typeExpression?.type, context) : undefined;\n  return new ReturnTagSchema(context.getLocation(tag), getTextOfJSDocComment(tag.comment), type);\n}\n\nasync function propertyLikeTag(tag: JSDocPropertyLikeTag, context: SchemaExtractorContext) {\n  const type = tag.typeExpression?.type ? await typeNodeToSchema(tag.typeExpression?.type, context) : undefined;\n  return new PropertyLikeTagSchema(\n    context.getLocation(tag),\n    tag.name.getText(),\n    getTextOfJSDocComment(tag.comment),\n    type\n  );\n}\n"],"mappings":";;;;;;;;;;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAUA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAQA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AArBA;AAuBO,eAAeA,gBAAf,CAAgCC,IAAhC,EAA4CC,OAA5C,EAA6G;EAClH,IAAI,CAAC,IAAAC,uBAAA,EAAaF,IAAb,CAAL,EAAyB;IACvB,OAAOG,SAAP;EACD;;EACD,MAAMC,MAAM,GAAG,IAAAC,mBAAA,EAASL,IAAT,CAAf;;EACA,IAAI,CAACI,MAAM,CAACE,MAAZ,EAAoB;IAClB,OAAOH,SAAP;EACD,CAPiH,CAQlH;EACA;;;EACA,MAAMI,KAAK,GAAGH,MAAM,CAAC,CAAD,CAApB;EACA,MAAMI,QAAQ,GAAGP,OAAO,CAACQ,WAAR,CAAoBF,KAApB,CAAjB;EACA,MAAMG,OAAO,GAAG,IAAAC,mCAAA,EAAsBJ,KAAK,CAACG,OAA5B,CAAhB;EACA,MAAME,IAAI,GAAGL,KAAK,CAACK,IAAN,GAAa,MAAM,IAAAC,qBAAA,EAAWN,KAAK,CAACK,IAAjB,EAAwBE,GAAD,IAASC,SAAS,CAACD,GAAD,EAAMb,OAAN,CAAzC,CAAnB,GAA8EE,SAA3F;EACA,OAAO,KAAIa,8BAAJ,EAAcR,QAAd,EAAwBD,KAAK,CAACU,OAAN,EAAxB,EAAyCP,OAAzC,EAAkDE,IAAlD,CAAP;AACD;;AAED,eAAeG,SAAf,CAAyBD,GAAzB,EAAwCb,OAAxC,EAA6F;EAC3F;EAEA,QAAQa,GAAG,CAACI,IAAZ;IACE,KAAKC,wBAAA,CAAWC,cAAhB;MACE,OAAOC,SAAS,CAACP,GAAD,EAAwBb,OAAxB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWG,gBAAhB;MACE,OAAOC,eAAe,CAACT,GAAD,EAA0Bb,OAA1B,CAAtB;;IACF,KAAKkB,wBAAA,CAAWK,iBAAhB;MACE,OAAOD,eAAe,CAACT,GAAD,EAA2Bb,OAA3B,CAAtB;;IACF,KAAKkB,wBAAA,CAAWM,gBAAhB;MACE,OAAOC,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQC,QAAd,EAAwB3B,OAAxB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWU,cAAhB;MACE,OAAOH,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQG,MAAd,EAAsB7B,OAAtB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWY,aAAhB;MACE,OAAOL,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQK,KAAd,EAAqB/B,OAArB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWc,gBAAhB;MACE,OAAOP,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQO,QAAd,EAAwBjC,OAAxB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWgB,cAAhB;MACE,OAAOT,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQS,MAAd,EAAsBnC,OAAtB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWkB,eAAhB;MACE,OAAOX,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQW,OAAd,EAAuBrC,OAAvB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWoB,iBAAhB;MACE,OAAOb,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQa,SAAd,EAAyBvC,OAAzB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWsB,gBAAhB;MACE,OAAOf,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQe,QAAd,EAAwBzC,OAAxB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWwB,gBAAhB;MACE,OAAOjB,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQiB,QAAd,EAAwB3C,OAAxB,CAAhB;;IACF,KAAKkB,wBAAA,CAAW0B,kBAAhB;MACE,OAAOnB,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQmB,UAAd,EAA0B7C,OAA1B,CAAhB;;IACF,KAAKkB,wBAAA,CAAW4B,WAAhB;MACE,OAAOrB,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQqB,GAAd,EAAmB/C,OAAnB,CAAhB;;IACF,KAAKkB,wBAAA,CAAW8B,YAAhB;MACE,OAAOvB,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQuB,IAAd,EAAoBjD,OAApB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWgC,YAAhB;MACE,OAAOzB,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQyB,IAAd,EAAoBnD,OAApB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWkC,YAAhB;MACE,OAAO3B,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQ2B,IAAd,EAAoBrD,OAApB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWoC,gBAAhB;MACE,OAAO7B,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQ6B,QAAd,EAAwBvD,OAAxB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWsC,eAAhB;MACE,OAAO/B,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQ+B,OAAd,EAAuBzD,OAAvB,CAAhB;;IACF,KAAKkB,wBAAA,CAAWwC,kBAAhB;MACE,OAAOjC,SAAS,CAACZ,GAAD,EAAMa,4BAAA,CAAQiC,UAAd,EAA0B3D,OAA1B,CAAhB;;IACF;MAAS;QACP,MAAM4D,OAAyB,GAAG/C,GAAG,CAAC+C,OAAJ,CAAY5C,OAAZ,CAAoBH,GAAG,CAACgD,aAAJ,EAApB,CAAlC;QACA,OAAOpC,SAAS,CAACZ,GAAD,EAAM+C,OAAN,EAAe5D,OAAf,CAAhB;MACD;EA5CH;AA8CD;;AAED,SAASyB,SAAT,CAAmBZ,GAAnB,EAAkC+C,OAAlC,EAA6D5D,OAA7D,EAAyG;EACvG,OAAO,KAAI8D,8BAAJ,EAAc9D,OAAO,CAACQ,WAAR,CAAoBK,GAApB,CAAd,EAAwC+C,OAAxC,EAAiD,IAAAlD,mCAAA,EAAsBG,GAAG,CAACJ,OAA1B,CAAjD,CAAP;AACD;;AAED,eAAeW,SAAf,CAAyBP,GAAzB,EAA8Cb,OAA9C,EAA+E;EAAA;;EAC7E,MAAMqD,IAAI,GAAG,uBAAAxC,GAAG,CAACkD,cAAJ,oEAAoBV,IAApB,GAA2B,MAAM,IAAAW,oCAAA,0BAAiBnD,GAAG,CAACkD,cAArB,yDAAiB,qBAAoBV,IAArC,EAA2CrD,OAA3C,CAAjC,GAAuFE,SAApG;EACA,OAAO,KAAI+D,oCAAJ,EAAoBjE,OAAO,CAACQ,WAAR,CAAoBK,GAApB,CAApB,EAA8C,IAAAH,mCAAA,EAAsBG,GAAG,CAACJ,OAA1B,CAA9C,EAAkF4C,IAAlF,CAAP;AACD;;AAED,eAAe/B,eAAf,CAA+BT,GAA/B,EAA0Db,OAA1D,EAA2F;EAAA;;EACzF,MAAMqD,IAAI,GAAG,wBAAAxC,GAAG,CAACkD,cAAJ,sEAAoBV,IAApB,GAA2B,MAAM,IAAAW,oCAAA,0BAAiBnD,GAAG,CAACkD,cAArB,yDAAiB,qBAAoBV,IAArC,EAA2CrD,OAA3C,CAAjC,GAAuFE,SAApG;EACA,OAAO,KAAIgE,0CAAJ,EACLlE,OAAO,CAACQ,WAAR,CAAoBK,GAApB,CADK,EAELA,GAAG,CAACsD,IAAJ,CAASnD,OAAT,EAFK,EAGL,IAAAN,mCAAA,EAAsBG,GAAG,CAACJ,OAA1B,CAHK,EAIL4C,IAJK,CAAP;AAMD"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/typescript",
-  "version": "0.0.758",
+  "version": "0.0.761",
   "homepage": "https://bit.dev/teambit/typescript/typescript",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.typescript",
     "name": "typescript",
-    "version": "0.0.758"
+    "version": "0.0.761"
   },
   "dependencies": {
     "lodash": "4.17.21",
@@ -18,21 +18,21 @@
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
     "@teambit/harmony": "0.3.3",
-    "@teambit/compiler": "0.0.758",
+    "@teambit/compiler": "0.0.761",
     "@teambit/typescript.modules.ts-config-mutator": "0.0.68",
-    "@teambit/component": "0.0.758",
-    "@teambit/dependency-resolver": "0.0.758",
-    "@teambit/semantics.entities.semantic-schema": "0.0.20",
+    "@teambit/component": "0.0.761",
+    "@teambit/dependency-resolver": "0.0.761",
+    "@teambit/semantics.entities.semantic-schema": "0.0.21",
     "@teambit/ts-server": "0.0.32",
-    "@teambit/aspect-loader": "0.0.758",
+    "@teambit/aspect-loader": "0.0.761",
     "@teambit/bit-error": "0.0.394",
-    "@teambit/builder": "0.0.758",
-    "@teambit/isolator": "0.0.758",
-    "@teambit/logger": "0.0.594",
-    "@teambit/schema": "0.0.758",
-    "@teambit/workspace": "0.0.758",
-    "@teambit/cli": "0.0.501",
-    "@teambit/pkg": "0.0.758"
+    "@teambit/builder": "0.0.761",
+    "@teambit/isolator": "0.0.761",
+    "@teambit/logger": "0.0.596",
+    "@teambit/schema": "0.0.761",
+    "@teambit/workspace": "0.0.761",
+    "@teambit/cli": "0.0.503",
+    "@teambit/pkg": "0.0.761"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -48,7 +48,7 @@
     "@teambit/typescript.aspect-docs.typescript": "0.0.138"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.281",
+    "@teambit/legacy": "1.0.283",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -76,7 +76,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.281",
+        "@teambit/legacy": "1.0.283",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/{preview-1654918011878.js → preview-1655263660719.js}

@@ -1,2 +1,2 @@
-export const compositions = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.typescript_typescript@0.0.758/dist/typescript.composition.js')]
-export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.typescript_typescript@0.0.758/dist/typescript.docs.mdx')]
+export const compositions = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.typescript_typescript@0.0.761/dist/typescript.composition.js')]
+export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.typescript_typescript@0.0.761/dist/typescript.docs.mdx')]

package/transformers/utils/jsdoc-to-doc-schema.ts

@@ -1,8 +1,23 @@
 /* eslint-disable no-fallthrough */
-import { getTextOfJSDocComment, JSDocReturnTag, JSDocTag, Node, SyntaxKind } from 'typescript';
+import {
+  getTextOfJSDocComment,
+  JSDocParameterTag,
+  JSDocPropertyLikeTag,
+  JSDocPropertyTag,
+  JSDocReturnTag,
+  JSDocTag,
+  Node,
+  SyntaxKind,
+} from 'typescript';
 import { getJsDoc, canHaveJsDoc } from 'tsutils';
 import pMapSeries from 'p-map-series';
-import { DocSchema, ReturnTagSchema, TagName, TagSchema } from '@teambit/semantics.entities.semantic-schema';
+import {
+  DocSchema,
+  PropertyLikeTagSchema,
+  ReturnTagSchema,
+  TagName,
+  TagSchema,
+} from '@teambit/semantics.entities.semantic-schema';
 import { SchemaExtractorContext } from '../../schema-extractor-context';
 import { typeNodeToSchema } from './type-node-to-schema';
 
@@ -20,54 +35,57 @@ export async function jsDocToDocSchema(node: Node, context: SchemaExtractorConte
   const location = context.getLocation(jsDoc);
   const comment = getTextOfJSDocComment(jsDoc.comment);
   const tags = jsDoc.tags ? await pMapSeries(jsDoc.tags, (tag) => tagParser(tag, context)) : undefined;
-  return new DocSchema(location, comment, tags);
+  return new DocSchema(location, jsDoc.getText(), comment, tags);
 }
 
 async function tagParser(tag: JSDocTag, context: SchemaExtractorContext): Promise<TagSchema> {
-  let tagName: TagName | string = tag.tagName.getText();
+  // for some reason, in some cases, if `tag.getSourceFile()` is not provided to the `getText()`, it throws "Cannot read property 'text' of undefined"
+
   switch (tag.kind) {
     case SyntaxKind.JSDocReturnTag:
       return returnTag(tag as JSDocReturnTag, context);
+    case SyntaxKind.JSDocPropertyTag:
+      return propertyLikeTag(tag as JSDocPropertyTag, context);
+    case SyntaxKind.JSDocParameterTag:
+      return propertyLikeTag(tag as JSDocParameterTag, context);
     case SyntaxKind.JSDocAugmentsTag:
-      tagName = TagName.augments;
+      return simpleTag(tag, TagName.augments, context);
     case SyntaxKind.JSDocAuthorTag:
-      tagName = TagName.author;
+      return simpleTag(tag, TagName.author, context);
     case SyntaxKind.JSDocClassTag:
-      tagName = TagName.class;
+      return simpleTag(tag, TagName.class, context);
     case SyntaxKind.JSDocCallbackTag:
-      tagName = TagName.callback;
+      return simpleTag(tag, TagName.callback, context);
     case SyntaxKind.JSDocPublicTag:
-      tagName = TagName.public;
+      return simpleTag(tag, TagName.public, context);
     case SyntaxKind.JSDocPrivateTag:
-      tagName = TagName.private;
+      return simpleTag(tag, TagName.private, context);
     case SyntaxKind.JSDocProtectedTag:
-      tagName = TagName.protected;
+      return simpleTag(tag, TagName.protected, context);
     case SyntaxKind.JSDocReadonlyTag:
-      tagName = TagName.readonly;
+      return simpleTag(tag, TagName.readonly, context);
     case SyntaxKind.JSDocOverrideTag:
-      tagName = TagName.override;
+      return simpleTag(tag, TagName.override, context);
     case SyntaxKind.JSDocDeprecatedTag:
-      tagName = TagName.deprecated;
+      return simpleTag(tag, TagName.deprecated, context);
     case SyntaxKind.JSDocSeeTag:
-      tagName = TagName.see;
+      return simpleTag(tag, TagName.see, context);
     case SyntaxKind.JSDocEnumTag:
-      tagName = TagName.enum;
-    case SyntaxKind.JSDocParameterTag:
-      tagName = TagName.parameter;
+      return simpleTag(tag, TagName.enum, context);
     case SyntaxKind.JSDocThisTag:
-      tagName = TagName.this;
+      return simpleTag(tag, TagName.this, context);
     case SyntaxKind.JSDocTypeTag:
-      tagName = TagName.type;
+      return simpleTag(tag, TagName.type, context);
     case SyntaxKind.JSDocTemplateTag:
-      tagName = TagName.template;
+      return simpleTag(tag, TagName.template, context);
     case SyntaxKind.JSDocTypedefTag:
-      tagName = TagName.typedef;
-    case SyntaxKind.JSDocPropertyTag:
-      tagName = TagName.property;
+      return simpleTag(tag, TagName.typedef, context);
     case SyntaxKind.JSDocImplementsTag:
-      tagName = TagName.implements;
-    default:
+      return simpleTag(tag, TagName.implements, context);
+    default: {
+      const tagName: TagName | string = tag.tagName.getText(tag.getSourceFile());
       return simpleTag(tag, tagName, context);
+    }
   }
 }
 
@@ -77,5 +95,15 @@ function simpleTag(tag: JSDocTag, tagName: TagName | string, context: SchemaExtr
 
 async function returnTag(tag: JSDocReturnTag, context: SchemaExtractorContext) {
   const type = tag.typeExpression?.type ? await typeNodeToSchema(tag.typeExpression?.type, context) : undefined;
-  return new ReturnTagSchema(context.getLocation(tag), TagName.return, getTextOfJSDocComment(tag.comment), type);
+  return new ReturnTagSchema(context.getLocation(tag), getTextOfJSDocComment(tag.comment), type);
+}
+
+async function propertyLikeTag(tag: JSDocPropertyLikeTag, context: SchemaExtractorContext) {
+  const type = tag.typeExpression?.type ? await typeNodeToSchema(tag.typeExpression?.type, context) : undefined;
+  return new PropertyLikeTagSchema(
+    context.getLocation(tag),
+    tag.name.getText(),
+    getTextOfJSDocComment(tag.comment),
+    type
+  );
 }