fix(parser): use doctrine to unwrap comments

Author: merceyz

Diff for: package.json

@@ -23,6 +23,7 @@
     "@commitlint/cli": "^8.0.0",
     "@commitlint/config-conventional": "^8.0.0",
     "@types/babel__core": "^7.1.2",
+    "@types/doctrine": "^0.0.3",
     "@types/jest": "^24.0.15",
     "@types/lodash": "^4.14.136",
     "@types/node": "^12.6.2",
@@ -41,6 +42,7 @@
     "@babel/plugin-syntax-class-properties": "^7.2.0",
     "@babel/plugin-syntax-jsx": "^7.2.0",
     "@babel/types": "^7.5.0",
+    "doctrine": "^3.0.0",
     "lodash": "^4.17.14",
     "typescript": "3.5.2",
     "uuid": "^3.3.2"

Diff for: src/parser.ts

@@ -1,5 +1,6 @@
 import * as ts from 'typescript';
 import * as t from './types';
+import * as doctrine from 'doctrine';
 
 /**
  * Options that specify how the parser should act
@@ -441,19 +442,7 @@ export function parseFromProgram(
       if (comments && comments.length === 1) {
         const commentNode = comments[0];
         if (ts.isJSDoc(commentNode)) {
-          let commentText = commentNode.comment ? commentNode.comment : '';
-          if (commentNode.tags) {
-            const tags = commentNode.tags
-              .map(tag =>
-                tag
-                  .getText()
-                  .replace(/\* *$/, '')
-                  .trim(),
-              )
-              .reduce((prev, curr) => `${prev}\n${curr}`);
-            commentText = commentText ? `${commentText}\n${tags}` : tags;
-          }
-          return commentText;
+          return doctrine.unwrapComment(commentNode.getText()).trim();
         }
       }
     }

Diff for: yarn.lock

@@ -471,6 +471,11 @@
   dependencies:
     "@babel/types" "^7.3.0"
 
+"@types/doctrine@^0.0.3":
+  version "0.0.3"
+  resolved "https://registry.yarnpkg.com/@types/doctrine/-/doctrine-0.0.3.tgz#e892d293c92c9c1d3f9af72c15a554fbc7e0895a"
+  integrity sha1-6JLSk8ksnB0/mvcsFaVU+8fgiVo=
+
 "@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0":
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.1.tgz#42995b446db9a48a11a07ec083499a860e9138ff"
@@ -1498,6 +1503,13 @@ diff-sequences@^24.3.0:
   resolved "https://registry.yarnpkg.com/diff-sequences/-/diff-sequences-24.3.0.tgz#0f20e8a1df1abddaf4d9c226680952e64118b975"
   integrity sha512-xLqpez+Zj9GKSnPWS0WZw1igGocZ+uua8+y+5dDNTT934N3QuY1sp2LkHzwiaYQGz60hMq0pjAshdeXm5VUOEw==
 
+doctrine@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/doctrine/-/doctrine-3.0.0.tgz#addebead72a6574db783639dc87a121773973961"
+  integrity sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==
+  dependencies:
+    esutils "^2.0.2"
+
 domexception@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/domexception/-/domexception-1.0.1.tgz#937442644ca6a31261ef36e3ec677fe805582c90"