feat: #535 - Add getTypeExpression() to JSDocReturnTag and JSDocTypeTag

lib/ts-morph.d.ts

@@ -4995,6 +4995,10 @@ export declare class JSDocPropertyTag extends JSDocPropertyTagBase<ts.JSDocPrope
  * JS doc return tag node.
  */
 export declare class JSDocReturnTag extends JSDocTag<ts.JSDocReturnTag> {
+    /**
+     * Gets the type expression node of the JS doc property like tag.
+     */
+    getTypeExpression(): JSDocTypeExpression | undefined;
 }
 
 /**
@@ -5042,6 +5046,10 @@ export declare class JSDocTypedefTag extends JSDocTag<ts.JSDocTypedefTag> {
  * JS doc type tag node.
  */
 export declare class JSDocTypeTag extends JSDocTag<ts.JSDocTypeTag> {
+    /**
+     * Gets the type expression node of the JS doc property like tag.
+     */
+    getTypeExpression(): JSDocTypeExpression | undefined;
 }
 
 /**

src/compiler/ast/doc/JSDocReturnTag.ts

@@ -5,5 +5,10 @@ import { JSDocTag } from "./JSDocTag";
  * JS doc return tag node.
  */
 export class JSDocReturnTag extends JSDocTag<ts.JSDocReturnTag> {
-    // todo: helper methods
+    /**
+     * Gets the type expression node of the JS doc property return tag.
+     */
+    getTypeExpression() {
+        return this._getNodeFromCompilerNodeIfExists(this.compilerNode.typeExpression);
+    }
 }

src/compiler/ast/doc/JSDocTypeTag.ts

@@ -5,5 +5,15 @@ import { JSDocTag } from "./JSDocTag";
  * JS doc type tag node.
  */
 export class JSDocTypeTag extends JSDocTag<ts.JSDocTypeTag> {
-    // todo: helper methods
+    /**
+     * Gets the type expression node of the JS doc property type tag.
+     */
+    getTypeExpression() {
+        // for some reason the compiler will still return a node when it doesn't exist
+        const node = this.compilerNode.typeExpression;
+        if (node != null && node.pos === node.end)
+            return undefined;
+
+        return this._getNodeFromCompilerNodeIfExists(this.compilerNode.typeExpression);
+    }
 }

src/tests/compiler/ast/doc/jsDocReturnTagTests.ts

@@ -0,0 +1,22 @@
+import {expect} from "chai";
+import {JSDocReturnTag, TypeGuards} from "../../../../main";
+import {getInfoFromText} from "../../testHelpers";
+
+describe(nameof(JSDocReturnTag), () => {
+    function getInfo(text: string) {
+        const info = getInfoFromText(text);
+        return { descendant: info.sourceFile.getFirstDescendantOrThrow(TypeGuards.isJSDocReturnTag), ...info };
+    }
+
+    describe(nameof<JSDocReturnTag>(d => d.getTypeExpression), () => {
+        it("should get undefined when there is no type given", () => {
+            const { descendant } = getInfo("/** @returns t - String */\nfunction test() {}");
+            expect(descendant.getTypeExpression()).to.be.undefined;
+        });
+
+        it("should get when type is given", () => {
+            const { descendant } = getInfo("/** @returns {boolean} t - String */\nfunction test() {}");
+            expect(descendant.getTypeExpression()!.getTypeNode().getText()).to.equal("boolean");
+        });
+    });
+});

src/tests/compiler/ast/doc/jsDocTypeTagTests.ts

@@ -0,0 +1,22 @@
+import {expect} from "chai";
+import {TypeGuards, JSDocTypeTag} from "../../../../main";
+import {getInfoFromText} from "../../testHelpers";
+
+describe(nameof(JSDocTypeTag), () => {
+    function getInfo(text: string) {
+        const info = getInfoFromText(text);
+        return { descendant: info.sourceFile.getFirstDescendantOrThrow(TypeGuards.isJSDocTypeTag), ...info };
+    }
+
+    describe(nameof<JSDocTypeTag>(d => d.getTypeExpression), () => {
+        it("returns undefined when typeExpression is undefined", () => {
+            const { descendant } = getInfo("/** @type */\nvar bar = 1;");
+            expect(descendant.getTypeExpression()).to.be.undefined;
+        });
+
+        it("should get when type is given", () => {
+            const { descendant } = getInfo("/** @type {boolean} */\nvar bar = 1");
+            expect(descendant.getTypeExpression()!.getTypeNode().getText()).to.equal("boolean");
+        });
+    });
+});

wrapped-nodes.md

@@ -180,14 +180,14 @@ The disadvantage to a node not being wrapped is that it won't have helper method
 * [JSDocParameterTag](src/compiler/ast/doc/JSDocParameterTag.ts)
 * [JSDocPropertyTag](src/compiler/ast/doc/JSDocPropertyTag.ts)
 * [JSDocReturnTag](src/compiler/ast/doc/JSDocReturnTag.ts)
-    * :x: typeExpression
+    * :heavy_check_mark: typeExpression
 * [JSDocTag](src/compiler/ast/doc/JSDocTag.ts)
     * :heavy_check_mark: tagName
     * :heavy_check_mark: comment
 * [JSDocTypeExpression](src/compiler/ast/doc/JSDocTypeExpression.ts)
     * :heavy_check_mark: type
 * [JSDocTypeTag](src/compiler/ast/doc/JSDocTypeTag.ts)
-    * :x: typeExpression
+    * :heavy_check_mark: typeExpression
 * [JSDocTypedefTag](src/compiler/ast/doc/JSDocTypedefTag.ts)
     * :x: fullName
     * :heavy_check_mark: name