Emit leading/trailing comments for return statement

sheetalkamat · sheetalkamat · commit 1b5023bad324 · 2014-08-15T15:16:17.000-07:00
Note the detachedComments and copyright headers comment emitting is not part of this change
diff --git a/src/compiler/emitter.ts b/src/compiler/emitter.ts
@@ -212,10 +212,10 @@ module ts {
             var writeEmittedFiles = writeJavaScriptFile;
 
             /** Emit leading comments of the declaration */
-            var emitLeadingComments = compilerOptions.removeComments ? (d: Declaration) => { } : emitLeadingDeclarationComments;
+            var emitLeadingComments = compilerOptions.removeComments ? (d: Node) => { } : emitLeadingDeclarationComments;
 
             /** Emit Trailing comments of the declaration */
-            var emitTrailingComments = compilerOptions.removeComments ? (d: Declaration) => { } : emitTrailingDeclarationComments;
+            var emitTrailingComments = compilerOptions.removeComments ? (d: Node) => { } : emitTrailingDeclarationComments;
 
             var writeComment = writeCommentRange;
 
@@ -1009,9 +1009,11 @@ module ts {
             }
 
             function emitReturnStatement(node: ReturnStatement) {
+                emitLeadingComments(node);
                 emitToken(SyntaxKind.ReturnKeyword, node.pos);
                 emitOptional(" ", node.expression);
                 write(";");
+                emitTrailingComments(node);
             }
 
             function emitWithStatement(node: WhileStatement) {
@@ -1947,14 +1949,14 @@ module ts {
                 }
             }
 
-            function emitLeadingDeclarationComments(node: Declaration) {
+            function emitLeadingDeclarationComments(node: Node) {
                 var leadingComments = getLeadingComments(currentSourceFile.text, node.pos);
                 emitNewLineBeforeLeadingComments(node, leadingComments, writer);
                 // Leading comments are emitted at /*leading comment1 */space/*leading comment*/space
                 emitComments(leadingComments, /*trailingSeparator*/ true, writer, writeComment);
             }
 
-            function emitTrailingDeclarationComments(node: Declaration) {
+            function emitTrailingDeclarationComments(node: Node) {
                 // Emit the trailing declaration comments only if the parent's end doesnt match
                 if (node.parent.kind === SyntaxKind.SourceFile || node.end !== node.parent.end) {
                     var trailingComments = getTrailingComments(currentSourceFile.text, node.end);
diff --git a/tests/baselines/reference/ambiguousCallsWhereReturnTypesAgree.js b/tests/baselines/reference/ambiguousCallsWhereReturnTypesAgree.js
@@ -46,7 +46,7 @@ var TestClass2 = (function () {
         return 0;
     };
     TestClass2.prototype.foo = function (x) {
-        return this.bar(x);
+        return this.bar(x); // should not error
     };
     return TestClass2;
 })();
diff --git a/tests/baselines/reference/arrayAssignmentTest5.js b/tests/baselines/reference/arrayAssignmentTest5.js
@@ -43,7 +43,7 @@ var Test;
             var lineTokens = this.tokenize(line, state, true);
             var tokens = lineTokens.tokens;
             if (tokens.length === 0) {
-                return this.onEnter(line, tokens, offset);
+                return this.onEnter(line, tokens, offset); // <== this should produce an error since onEnter can not be called with (string, IStateToken[], offset)
             }
         };
         Bug.prototype.tokenize = function (line, state, includeStates) {
diff --git a/tests/baselines/reference/bestCommonTypeOfConditionalExpressions.js b/tests/baselines/reference/bestCommonTypeOfConditionalExpressions.js
@@ -75,5 +75,5 @@ var r8 = true ? function (x) {
 var r10 = true ? derived : derived2; // no error since we use the contextual type in BCT
 var r11 = true ? base : derived2;
 function foo5(t, u) {
-    return true ? t : u;
+    return true ? t : u; // BCT is Object
 }
diff --git a/tests/baselines/reference/bestCommonTypeOfConditionalExpressions2.js b/tests/baselines/reference/bestCommonTypeOfConditionalExpressions2.js
@@ -61,7 +61,7 @@ function foo(t, u) {
     return true ? t : u;
 }
 function foo2(t, u) {
-    return true ? t : u;
+    return true ? t : u; // Ok because BCT(T, U) = U
 }
 function foo3(t, u) {
     return true ? t : u;
diff --git a/tests/baselines/reference/collisionThisExpressionAndNameResolution.js b/tests/baselines/reference/collisionThisExpressionAndNameResolution.js
@@ -22,7 +22,7 @@ var Foo = (function () {
         function inner() {
             var _this = this;
             console.log(_this);
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture into function inner
         }
     };
     return Foo;
diff --git a/tests/baselines/reference/collisionThisExpressionAndParameter.js b/tests/baselines/reference/collisionThisExpressionAndParameter.js
@@ -101,19 +101,19 @@ var Foo = (function () {
         var _this = 10; // Local var. No this capture in x(), so no conflict.
         function inner(_this) {
             var _this = this;
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture into function inner
         }
     };
     Foo.prototype.y = function () {
         var _this = this;
         var lamda = function (_this) {
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture
         };
     };
     Foo.prototype.z = function (_this) {
         var _this = this;
         var lambda = function () {
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture
         };
     };
     Foo.prototype.x1 = function () {
@@ -160,7 +160,7 @@ var Foo3 = (function () {
     Foo3.prototype.z = function (_this) {
         var _this = this;
         var lambda = function () {
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture
         };
     };
     return Foo3;
diff --git a/tests/baselines/reference/collisionThisExpressionAndPropertyNameAsConstuctorParameter.js b/tests/baselines/reference/collisionThisExpressionAndPropertyNameAsConstuctorParameter.js
@@ -40,7 +40,7 @@ var Foo2 = (function () {
     function Foo2(_this) {
         var _this = this;
         var lambda = function () {
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture
         };
     }
     return Foo2;
@@ -50,7 +50,7 @@ var Foo3 = (function () {
         var _this = this;
         this._this = _this;
         var lambda = function () {
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture
         };
     }
     return Foo3;
@@ -59,7 +59,7 @@ var Foo4 = (function () {
     function Foo4(_this) {
         var _this = this;
         var lambda = function () {
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture
         };
     }
     return Foo4;
@@ -69,7 +69,7 @@ var Foo5 = (function () {
         var _this = this;
         this._this = _this;
         var lambda = function () {
-            return function (x) { return _this; };
+            return function (x) { return _this; }; // New scope.  So should inject new _this capture
         };
     }
     return Foo5;
diff --git a/tests/baselines/reference/commentsOnReturnStatement1.js b/tests/baselines/reference/commentsOnReturnStatement1.js
@@ -16,6 +16,7 @@ var DebugClass = (function () {
     DebugClass.debugFunc = function () {
         // Start Debugger Test Code
         var i = 0;
+        // End Debugger Test Code
         return true;
     };
     return DebugClass;
diff --git a/tests/baselines/reference/constructorWithAssignableReturnExpression.js b/tests/baselines/reference/constructorWithAssignableReturnExpression.js
@@ -45,7 +45,7 @@ var C = (function () {
 })();
 var D = (function () {
     function D() {
-        return 1;
+        return 1; // error
     }
     return D;
 })();
@@ -57,7 +57,7 @@ var E = (function () {
 })();
 var F = (function () {
     function F() {
-        return { x: 1 };
+        return { x: 1 }; // error
     }
     return F;
 })();
diff --git a/tests/baselines/reference/detachedCommentAtStartOfFunctionBody1.js b/tests/baselines/reference/detachedCommentAtStartOfFunctionBody1.js
@@ -14,6 +14,9 @@ var TestFile = (function () {
     }
     TestFile.prototype.foo = function (message) {
         var _this = this;
+        /// <summary>Test summary</summary>
+        /// <param name="message" type="String" />
+        /// <returns type="Function" />
         return function () { return message + _this.name; };
     };
     return TestFile;
diff --git a/tests/baselines/reference/detachedCommentAtStartOfFunctionBody2.js b/tests/baselines/reference/detachedCommentAtStartOfFunctionBody2.js
@@ -15,6 +15,9 @@ var TestFile = (function () {
     }
     TestFile.prototype.foo = function (message) {
         var _this = this;
+        /// <summary>Test summary</summary>
+        /// <param name="message" type="String" />
+        /// <returns type="Function" />
         return function () { return message + _this.name; };
     };
     return TestFile;
diff --git a/tests/baselines/reference/es6ClassTest8.js b/tests/baselines/reference/es6ClassTest8.js
@@ -47,7 +47,7 @@ function f1(x) {
 var C = (function () {
     function C() {
         var bar = (function () {
-            return bar;
+            return bar; // 'bar' should be resolvable
         });
         var b = f1(f1(bar));
     }
diff --git a/tests/baselines/reference/fatarrowfunctionsInFunctionParameterDefaults.js b/tests/baselines/reference/fatarrowfunctionsInFunctionParameterDefaults.js
@@ -14,6 +14,7 @@ function fn(x, y) {
     var _this = this;
     if (x === void 0) { x = function () { return _this; }; }
     if (y === void 0) { y = x(); }
+    // should be 4
     return y;
 }
 fn.call(4);
diff --git a/tests/baselines/reference/functionImplementations.js b/tests/baselines/reference/functionImplementations.js
@@ -214,7 +214,7 @@ var b = function () {
 var a = function f() {
     return new Base();
     return new Derived();
-    return f();
+    return f(); // ?
 }();
 undefined === function () {
     throw undefined;
diff --git a/tests/baselines/reference/genericClassWithStaticFactory.js b/tests/baselines/reference/genericClassWithStaticFactory.js
@@ -252,6 +252,7 @@ var Editor;
                 return null;
             }
             else if (entry.isHead) {
+                // Can't remove the head of a list!
                 return null;
             }
             else {
diff --git a/tests/baselines/reference/genericConstructorFunction1.js b/tests/baselines/reference/genericConstructorFunction1.js
@@ -20,12 +20,12 @@ function f1(args) {
     var v1;
     var v2 = v1['test'];
     v2(args);
-    return new v2(args);
+    return new v2(args); // used to give error
 }
 ;
 function f2(args) {
     var v1;
     var v2 = v1['test'];
     var y = v2(args);
-    return new v2(args);
+    return new v2(args); // used to give error
 }
diff --git a/tests/baselines/reference/genericNewInterface.js b/tests/baselines/reference/genericNewInterface.js
@@ -13,8 +13,8 @@ function createInstance2<T>(ctor: INewable<T>): T {
 
 //// [genericNewInterface.js]
 function createInstance(ctor) {
-    return new ctor(42);
+    return new ctor(42); //should be an error
 }
 function createInstance2(ctor) {
-    return new ctor(1024);
+    return new ctor(1024); //should be an error
 }
diff --git a/tests/baselines/reference/genericStaticAnyTypeFunction.js b/tests/baselines/reference/genericStaticAnyTypeFunction.js
@@ -29,7 +29,7 @@ var A = (function () {
         return 0;
     };
     A.two = function (source) {
-        return this.one(source, 42);
+        return this.one(source, 42); // should not error
     };
     return A;
 })();
diff --git a/tests/baselines/reference/genericTypeWithCallableMembers2.js b/tests/baselines/reference/genericTypeWithCallableMembers2.js
@@ -9,8 +9,8 @@ function foo2<T extends { new (): string; }>(f: T) {
 
 //// [genericTypeWithCallableMembers2.js]
 function foo1(f) {
-    return f();
+    return f(); // should return 'string', once returned 'any'
 }
 function foo2(f) {
-    return new f();
+    return new f(); // should be legal, once was an error
 }
diff --git a/tests/baselines/reference/localVariablesReturnedFromCatchBlocks.js b/tests/baselines/reference/localVariablesReturnedFromCatchBlocks.js
@@ -13,6 +13,6 @@ function f() {
     }
     catch (e) {
         var stack2 = e.stack;
-        return stack2;
+        return stack2; //error TS2095: Could not find symbol 'stack2'.
     }
 }
diff --git a/tests/baselines/reference/numberToString.js b/tests/baselines/reference/numberToString.js
@@ -13,7 +13,7 @@ f2(3+""); // ok + operator promotes
 
 //// [numberToString.js]
 function f1(n) {
-    return n;
+    return n; // error return type mismatch
 }
 function f2(s) {
 }
diff --git a/tests/baselines/reference/overloadAssignmentCompat.js b/tests/baselines/reference/overloadAssignmentCompat.js
@@ -47,17 +47,21 @@ var Accessor = (function () {
 })();
 function attr(nameOrMap, value) {
     if (nameOrMap && typeof nameOrMap === "object") {
+        // handle map case
         return new Accessor;
     }
     else {
+        // handle string case
         return "s";
     }
 }
 function attr2(nameOrMap, value) {
     if (nameOrMap && typeof nameOrMap === "object") {
+        // handle map case
         return "t";
     }
     else {
+        // handle string case
         return "s";
     }
 }
diff --git a/tests/baselines/reference/overloadReturnTypes.js b/tests/baselines/reference/overloadReturnTypes.js
@@ -31,9 +31,11 @@ var Accessor = (function () {
 })();
 function attr(nameOrMap, value) {
     if (nameOrMap && typeof nameOrMap === "object") {
+        // handle map case
         return new Accessor;
     }
     else {
+        // handle string case
         return "s";
     }
 }
diff --git a/tests/baselines/reference/privacyFunc.js b/tests/baselines/reference/privacyFunc.js
@@ -265,7 +265,7 @@ var m1;
             return new C2_private();
         };
         C3_public.prototype.f8_public = function () {
-            return new C2_private();
+            return new C2_private(); // error
         };
         C3_public.prototype.f9_private = function () {
             return new C1_public();
@@ -277,7 +277,7 @@ var m1;
             return new C2_private();
         };
         C3_public.prototype.f12_public = function () {
-            return new C2_private();
+            return new C2_private(); //error
         };
         return C3_public;
     })();
@@ -362,7 +362,7 @@ var m1;
         return new C2_private();
     }
     function f8_public() {
-        return new C2_private();
+        return new C2_private(); // error
     }
     m1.f8_public = f8_public;
     function f9_private() {
@@ -376,7 +376,7 @@ var m1;
         return new C2_private();
     }
     function f12_public() {
-        return new C2_private();
+        return new C2_private(); //error
     }
     m1.f12_public = f12_public;
 })(m1 || (m1 = {}));
diff --git a/tests/baselines/reference/privacyGetter.js b/tests/baselines/reference/privacyGetter.js
@@ -255,7 +255,7 @@ define(["require", "exports"], function (require, exports) {
             });
             Object.defineProperty(C3_public.prototype, "p4_public", {
                 get: function () {
-                    return new C2_private();
+                    return new C2_private(); //error
                 },
                 set: function (m1_c3_p4_arg) {
                 },
@@ -452,7 +452,7 @@ define(["require", "exports"], function (require, exports) {
         });
         Object.defineProperty(C7_public.prototype, "p4_public", {
             get: function () {
-                return new C5_private();
+                return new C5_private(); //error
             },
             set: function (m1_c3_p4_arg) {
             },
diff --git a/tests/baselines/reference/privacyGloFunc.js b/tests/baselines/reference/privacyGloFunc.js
diff --git a/tests/baselines/reference/privacyGloGetter.js b/tests/baselines/reference/privacyGloGetter.js
diff --git a/tests/baselines/reference/propagationOfPromiseInitialization.js b/tests/baselines/reference/propagationOfPromiseInitialization.js
diff --git a/tests/baselines/reference/propertyOrdering.js b/tests/baselines/reference/propertyOrdering.js
diff --git a/tests/baselines/reference/returnInConstructor1.js b/tests/baselines/reference/returnInConstructor1.js
diff --git a/tests/baselines/reference/sourceMapValidationWithComments.js b/tests/baselines/reference/sourceMapValidationWithComments.js
diff --git a/tests/baselines/reference/sourceMapValidationWithComments.js.map b/tests/baselines/reference/sourceMapValidationWithComments.js.map
diff --git a/tests/baselines/reference/sourceMapValidationWithComments.sourcemap.txt b/tests/baselines/reference/sourceMapValidationWithComments.sourcemap.txt
diff --git a/tests/baselines/reference/unknownSymbolOffContextualType1.js b/tests/baselines/reference/unknownSymbolOffContextualType1.js

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ var Test;`
`43`	`43`	`var lineTokens = this.tokenize(line, state, true);`
`44`	`44`	`var tokens = lineTokens.tokens;`
`45`	`45`	`if (tokens.length === 0) {`
`46`		`- return this.onEnter(line, tokens, offset);`
	`46`	`+ return this.onEnter(line, tokens, offset); // <== this should produce an error since onEnter can not be called with (string, IStateToken[], offset)`
`47`	`47`	`}`
`48`	`48`	`};`
`49`	`49`	`Bug.prototype.tokenize = function (line, state, includeStates) {`
Original file line number	Diff line number	Diff line change
`@@ -75,5 +75,5 @@ var r8 = true ? function (x) {`
`75`	`75`	`var r10 = true ? derived : derived2; // no error since we use the contextual type in BCT`
`76`	`76`	`var r11 = true ? base : derived2;`
`77`	`77`	`function foo5(t, u) {`
`78`		`- return true ? t : u;`
	`78`	`+ return true ? t : u; // BCT is Object`
`79`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ function foo(t, u) {`
`61`	`61`	`return true ? t : u;`
`62`	`62`	`}`
`63`	`63`	`function foo2(t, u) {`
`64`		`- return true ? t : u;`
	`64`	`+ return true ? t : u; // Ok because BCT(T, U) = U`
`65`	`65`	`}`
`66`	`66`	`function foo3(t, u) {`
`67`	`67`	`return true ? t : u;`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ var Foo = (function () {`
`22`	`22`	`function inner() {`
`23`	`23`	`var _this = this;`
`24`	`24`	`console.log(_this);`
`25`		`- return function (x) { return _this; };`
	`25`	`+ return function (x) { return _this; }; // New scope. So should inject new _this capture into function inner`
`26`	`26`	`}`
`27`	`27`	`};`
`28`	`28`	`return Foo;`