fix: Fix JSDocTag#getStructure() not returning the whole tag text.

This was due to a bug in the compiler API that has been reported previously.
dsherret · Dec 8, 2019 · c096d30 · c096d30
1 parent 0f6182f
commit c096d30
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/packages/ts-morph/src/compiler/ast/doc/JSDocTag.ts b/packages/ts-morph/src/compiler/ast/doc/JSDocTag.ts
@@ -126,7 +126,7 @@ export class JSDocTag<NodeType extends ts.JSDocTag = ts.JSDocTag> extends JSDocT
 }
 
 function getText(jsDocTag: JSDocTag) {
-    return getTextWithoutStars(jsDocTag.getSourceFile().getFullText().substring(jsDocTag.getTagNameNode().getEnd(), jsDocTag.getEnd()).trim());
+    return getTextWithoutStars(jsDocTag.getSourceFile().getFullText().substring(jsDocTag.getTagNameNode().getEnd(), getTagEnd(jsDocTag)).trim());
 }
 
 function getTagEnd(jsDocTag: JSDocTag) {

diff --git a/packages/ts-morph/src/tests/compiler/ast/doc/jsDocTagTests.ts b/packages/ts-morph/src/tests/compiler/ast/doc/jsDocTagTests.ts
@@ -230,5 +230,10 @@ describe(nameof(JSDocTag), () => {
         it("should get when there is multi-line text following the tag name", () => {
             doTest("/** @param t - Test\n * Other. */\nfunction test() {}", { tagName: "param", text: "t - Test\nOther." });
         });
+
+        it("should get the text for non-param tags", () => {
+            // necessary because of inconsistencies with js doc tag with in the compiler
+            doTest("/** @example Something\n * Other. */\nfunction test() {}", { tagName: "example", text: "Something\nOther." });
+        });
     });
 });