Skip asterisks after newline when printing JSDoc types

Author: tschaub

src/compiler/utilities.ts

@@ -490,12 +490,29 @@ namespace ts {
         return getTextOfNodeFromSourceText(sourceFile.text, node, includeTrivia);
     }
 
+    function isJSDocTypeExpressionOrChild(node: Node): boolean {
+        if (node.kind === SyntaxKind.JSDocTypeExpression) {
+            return true;
+        }
+        if (node.parent) {
+            return isJSDocTypeExpressionOrChild(node.parent);
+        }
+        return false;
+    }
+
     export function getTextOfNodeFromSourceText(sourceText: string, node: Node, includeTrivia = false): string {
         if (nodeIsMissing(node)) {
             return "";
         }
 
-        return sourceText.substring(includeTrivia ? node.pos : skipTrivia(sourceText, node.pos), node.end);
+        let text = sourceText.substring(includeTrivia ? node.pos : skipTrivia(sourceText, node.pos), node.end);
+
+        if (isJSDocTypeExpressionOrChild(node)) {
+            // strip space + asterisk at line start
+            text = text.replace(/(^|\r?\n|\r)\s*\*\s*/g, "$1");
+        }
+
+        return text;
     }
 
     export function getTextOfNode(node: Node, includeTrivia = false): string {

tests/baselines/reference/typedefTagWrapping.symbols

@@ -1,13 +1,13 @@
 === tests/cases/conformance/jsdoc/mod1.js ===
 /** 
  * @typedef {function(string): boolean}
- * MyType
+ * Type1
  */
 
 /**
  * Tries to use a type whose name is on a different
  * line than the typedef tag.
- * @param {MyType} func The function to call.
+ * @param {Type1} func The function to call.
  * @param {string} arg The argument to call it with.
  * @returns {boolean} The return.
  */
@@ -21,3 +21,33 @@ function callIt(func, arg) {
 >arg : Symbol(arg, Decl(mod1.js, 12, 21))
 }
 
+=== tests/cases/conformance/jsdoc/mod2.js ===
+/** 
+ * @typedef {{
+ *   num: number,
+ *   str: string,
+ *   boo: boolean
+ * }} Type2
+ */
+
+/**
+ * Makes use of a type with a multiline type expression.
+ * @param {Type2} obj The object.
+ * @returns {string|number} The return.
+ */
+function check(obj) {
+>check : Symbol(check, Decl(mod2.js, 0, 0))
+>obj : Symbol(obj, Decl(mod2.js, 13, 15))
+
+  return obj.boo ? obj.num : obj.str;
+>obj.boo : Symbol(boo, Decl(mod2.js, 3, 17))
+>obj : Symbol(obj, Decl(mod2.js, 13, 15))
+>boo : Symbol(boo, Decl(mod2.js, 3, 17))
+>obj.num : Symbol(num, Decl(mod2.js, 1, 14))
+>obj : Symbol(obj, Decl(mod2.js, 13, 15))
+>num : Symbol(num, Decl(mod2.js, 1, 14))
+>obj.str : Symbol(str, Decl(mod2.js, 2, 17))
+>obj : Symbol(obj, Decl(mod2.js, 13, 15))
+>str : Symbol(str, Decl(mod2.js, 2, 17))
+}
+

tests/baselines/reference/typedefTagWrapping.types

@@ -1,13 +1,13 @@
 === tests/cases/conformance/jsdoc/mod1.js ===
 /** 
  * @typedef {function(string): boolean}
- * MyType
+ * Type1
  */
 
 /**
  * Tries to use a type whose name is on a different
  * line than the typedef tag.
- * @param {MyType} func The function to call.
+ * @param {Type1} func The function to call.
  * @param {string} arg The argument to call it with.
  * @returns {boolean} The return.
  */
@@ -22,3 +22,34 @@ function callIt(func, arg) {
 >arg : string
 }
 
+=== tests/cases/conformance/jsdoc/mod2.js ===
+/** 
+ * @typedef {{
+ *   num: number,
+ *   str: string,
+ *   boo: boolean
+ * }} Type2
+ */
+
+/**
+ * Makes use of a type with a multiline type expression.
+ * @param {Type2} obj The object.
+ * @returns {string|number} The return.
+ */
+function check(obj) {
+>check : (obj: { num: number; str: string; boo: boolean; }) => string | number
+>obj : { num: number; str: string; boo: boolean; }
+
+  return obj.boo ? obj.num : obj.str;
+>obj.boo ? obj.num : obj.str : string | number
+>obj.boo : boolean
+>obj : { num: number; str: string; boo: boolean; }
+>boo : boolean
+>obj.num : number
+>obj : { num: number; str: string; boo: boolean; }
+>num : number
+>obj.str : string
+>obj : { num: number; str: string; boo: boolean; }
+>str : string
+}
+

tests/cases/conformance/jsdoc/typedefTagWrapping.ts

@@ -1,20 +1,40 @@
 // @noEmit: true
 // @allowJs: true
 // @checkJs: true
+
 // @Filename: mod1.js
 
 /** 
  * @typedef {function(string): boolean}
- * MyType
+ * Type1
  */
 
 /**
  * Tries to use a type whose name is on a different
  * line than the typedef tag.
- * @param {MyType} func The function to call.
+ * @param {Type1} func The function to call.
  * @param {string} arg The argument to call it with.
  * @returns {boolean} The return.
  */
 function callIt(func, arg) {
   return func(arg);
 }
+
+// @Filename: mod2.js
+
+/** 
+ * @typedef {{
+ *   num: number,
+ *   str: string,
+ *   boo: boolean
+ * }} Type2
+ */
+
+/**
+ * Makes use of a type with a multiline type expression.
+ * @param {Type2} obj The object.
+ * @returns {string|number} The return.
+ */
+function check(obj) {
+  return obj.boo ? obj.num : obj.str;
+}

tests/cases/fourslash/jsDocFunctionSignatures12.ts

@@ -1,13 +1,22 @@
-
 ///<reference path="fourslash.ts" />
+
 // @allowJs: true
-// @Filename: Foo.js
+// @Filename: jsDocFunctionSignatures.js
+
 /////**
-//// * @param {{ stringProp: string,
-//// *           numProp: number }} o
+//// * @param {{
+//// *   stringProp: string,
+//// *   numProp: number,
+//// *   boolProp: boolean
+//// * }} o
 //// */
 ////function f1(o) {
 ////    o/**/;
 ////}
+
 goTo.marker();
-verify.quickInfoIs("(parameter) o: any");
+verify.quickInfoIs(`(parameter) o: {
+    stringProp: string;
+    numProp: number;
+    boolProp: boolean;
+}`);