Retain comments inside return statements by including the return keyword in the parse tree

weswigham · weswigham · commit 5d2142edb1ff · 2017-08-01T21:04:00.000-07:00
diff --git a/src/compiler/binder.ts b/src/compiler/binder.ts
@@ -1001,6 +1001,7 @@ namespace ts {
         function bindReturnOrThrow(node: ReturnStatement | ThrowStatement): void {
             bind(node.expression);
             if (node.kind === SyntaxKind.ReturnStatement) {
+                bind(node.returnKeyword);
                 hasExplicitReturn = true;
                 if (currentReturnTarget) {
                     addAntecedent(currentReturnTarget, currentFlow);
diff --git a/src/compiler/emitter.ts b/src/compiler/emitter.ts
@@ -1571,7 +1571,7 @@ namespace ts {
         }
 
         function emitReturnStatement(node: ReturnStatement) {
-            writeToken(SyntaxKind.ReturnKeyword, node.pos, /*contextNode*/ node);
+            emit(node.returnKeyword);
             emitExpressionWithPrefix(" ", node.expression);
             write(";");
         }
diff --git a/src/compiler/factory.ts b/src/compiler/factory.ts
@@ -1460,15 +1460,17 @@ namespace ts {
             : node;
     }
 
-    export function createReturn(expression?: Expression): ReturnStatement {
+    export function createReturn(expression?: Expression, returnKeyword: Token<SyntaxKind.ReturnKeyword> = createToken(SyntaxKind.ReturnKeyword)): ReturnStatement {
         const node = <ReturnStatement>createSynthesizedNode(SyntaxKind.ReturnStatement);
+        node.returnKeyword = returnKeyword;
         node.expression = expression;
         return node;
     }
 
-    export function updateReturn(node: ReturnStatement, expression: Expression | undefined) {
-        return node.expression !== expression
-            ? updateNode(createReturn(expression), node)
+    export function updateReturn(node: ReturnStatement, returnKeyword: Token<SyntaxKind.ReturnKeyword>, expression: Expression | undefined) {
+        return node.expression !== expression ||
+            node.returnKeyword !== returnKeyword
+            ? updateNode(createReturn(expression, returnKeyword), node)
             : node;
     }
 
diff --git a/src/compiler/parser.ts b/src/compiler/parser.ts
@@ -259,7 +259,8 @@ namespace ts {
             case SyntaxKind.BreakStatement:
                 return visitNode(cbNode, (<BreakOrContinueStatement>node).label);
             case SyntaxKind.ReturnStatement:
-                return visitNode(cbNode, (<ReturnStatement>node).expression);
+                return visitNode(cbNode, (<ReturnStatement>node).returnKeyword) ||
+                    visitNode(cbNode, (<ReturnStatement>node).expression);
             case SyntaxKind.WithStatement:
                 return visitNode(cbNode, (<WithStatement>node).expression) ||
                     visitNode(cbNode, (<WithStatement>node).statement);
@@ -4687,7 +4688,7 @@ namespace ts {
         function parseReturnStatement(): ReturnStatement {
             const node = <ReturnStatement>createNode(SyntaxKind.ReturnStatement);
 
-            parseExpected(SyntaxKind.ReturnKeyword);
+            node.returnKeyword = parseExpectedToken(SyntaxKind.ReturnKeyword, /*reportAtCurrentPosition*/ true, Diagnostics._0_expected, "return");
             if (!canParseSemicolon()) {
                 node.expression = allowInAnd(parseExpression);
             }
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -1750,6 +1750,7 @@ namespace ts {
 
     export interface ReturnStatement extends Statement {
         kind: SyntaxKind.ReturnStatement;
+        returnKeyword: Token<SyntaxKind.ReturnKeyword>;
         expression?: Expression;
     }
 
diff --git a/src/compiler/visitor.ts b/src/compiler/visitor.ts
@@ -634,6 +634,7 @@ namespace ts {
 
             case SyntaxKind.ReturnStatement:
                 return updateReturn(<ReturnStatement>node,
+                    visitNode((<ReturnStatement>node).returnKeyword, visitor, isToken),
                     visitNode((<ReturnStatement>node).expression, visitor, isExpression));
 
             case SyntaxKind.WithStatement:
diff --git a/src/harness/unittests/incrementalParser.ts b/src/harness/unittests/incrementalParser.ts
@@ -647,7 +647,7 @@ module m3 { }\
             const oldText = ScriptSnapshot.fromString(source);
             const newTextAndChange = withInsert(oldText, 0, "");
 
-            compareTrees(oldText, newTextAndChange.text, newTextAndChange.textChangeRange, 7);
+            compareTrees(oldText, newTextAndChange.text, newTextAndChange.textChangeRange, 8);
         });
 
         it("Class to interface", () => {
diff --git a/tests/baselines/reference/jsdocCastCommentEmit.js b/tests/baselines/reference/jsdocCastCommentEmit.js
@@ -0,0 +1,17 @@
+//// [jsdocCastCommentEmit.ts]
+// allowJs: true
+// checkJs: true
+// outDir: out/
+// filename: input.js
+function f() {
+    return /* @type {number} */ 42;
+}
+
+//// [jsdocCastCommentEmit.js]
+// allowJs: true
+// checkJs: true
+// outDir: out/
+// filename: input.js
+function f() {
+    return /* @type {number} */ 42;
+}
diff --git a/tests/baselines/reference/jsdocCastCommentEmit.symbols b/tests/baselines/reference/jsdocCastCommentEmit.symbols
@@ -0,0 +1,10 @@
+=== tests/cases/compiler/jsdocCastCommentEmit.ts ===
+// allowJs: true
+// checkJs: true
+// outDir: out/
+// filename: input.js
+function f() {
+>f : Symbol(f, Decl(jsdocCastCommentEmit.ts, 0, 0))
+
+    return /* @type {number} */ 42;
+}
diff --git a/tests/baselines/reference/jsdocCastCommentEmit.types b/tests/baselines/reference/jsdocCastCommentEmit.types
@@ -0,0 +1,11 @@
+=== tests/cases/compiler/jsdocCastCommentEmit.ts ===
+// allowJs: true
+// checkJs: true
+// outDir: out/
+// filename: input.js
+function f() {
+>f : () => number
+
+    return /* @type {number} */ 42;
+>42 : 42
+}
diff --git a/tests/cases/compiler/jsdocCastCommentEmit.ts b/tests/cases/compiler/jsdocCastCommentEmit.ts
@@ -0,0 +1,7 @@
+// allowJs: true
+// checkJs: true
+// outDir: out/
+// filename: input.js
+function f() {
+    return /* @type {number} */ 42;
+}

Original file line number	Diff line number	Diff line change
`@@ -1571,7 +1571,7 @@ namespace ts {`
`1571`	`1571`	`}`
`1572`	`1572`
`1573`	`1573`	`function emitReturnStatement(node: ReturnStatement) {`
`1574`		`- writeToken(SyntaxKind.ReturnKeyword, node.pos, /contextNode/ node);`
	`1574`	`+ emit(node.returnKeyword);`
`1575`	`1575`	`emitExpressionWithPrefix(" ", node.expression);`
`1576`	`1576`	`write(";");`
`1577`	`1577`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1460,15 +1460,17 @@ namespace ts {`
`1460`	`1460`	`: node;`
`1461`	`1461`	`}`
`1462`	`1462`
`1463`		`- export function createReturn(expression?: Expression): ReturnStatement {`
	`1463`	`+ export function createReturn(expression?: Expression, returnKeyword: Token<SyntaxKind.ReturnKeyword> = createToken(SyntaxKind.ReturnKeyword)): ReturnStatement {`
`1464`	`1464`	`const node = <ReturnStatement>createSynthesizedNode(SyntaxKind.ReturnStatement);`
	`1465`	`+ node.returnKeyword = returnKeyword;`
`1465`	`1466`	`node.expression = expression;`
`1466`	`1467`	`return node;`
`1467`	`1468`	`}`
`1468`	`1469`
`1469`		`- export function updateReturn(node: ReturnStatement, expression: Expression \| undefined) {`
`1470`		`- return node.expression !== expression`
`1471`		`- ? updateNode(createReturn(expression), node)`
	`1470`	`+ export function updateReturn(node: ReturnStatement, returnKeyword: Token<SyntaxKind.ReturnKeyword>, expression: Expression \| undefined) {`
	`1471`	`+ return node.expression !== expression \|\|`
	`1472`	`+ node.returnKeyword !== returnKeyword`
	`1473`	`+ ? updateNode(createReturn(expression, returnKeyword), node)`
`1472`	`1474`	`: node;`
`1473`	`1475`	`}`
`1474`	`1476`
Original file line number	Diff line number	Diff line change
`@@ -1750,6 +1750,7 @@ namespace ts {`
`1750`	`1750`
`1751`	`1751`	`export interface ReturnStatement extends Statement {`
`1752`	`1752`	`kind: SyntaxKind.ReturnStatement;`
	`1753`	`+ returnKeyword: Token<SyntaxKind.ReturnKeyword>;`
`1753`	`1754`	`expression?: Expression;`
`1754`	`1755`	`}`
`1755`	`1756`