🐛 Fix not emitting comments between sibling fields of object literals (microsoft#50097)

Co-authored-by: Jake Bailey <[email protected]>

Author: 2 people

src/compiler/emitter.ts

@@ -5120,6 +5120,11 @@ export function createPrinter(printerOptions: PrinterOptions = {}, handlers: Pri
                         shouldDecreaseIndentAfterEmit = true;
                     }
 
+                    if (shouldEmitInterveningComments && format & ListFormat.DelimitersMask && !positionIsSynthesized(child.pos)) {
+                        const commentRange = getCommentRange(child);
+                        emitTrailingCommentsOfPosition(commentRange.pos, /*prefixSpace*/ !!(format & ListFormat.SpaceBetweenSiblings), /*forceNoNewline*/ true);
+                    }
+
                     writeLine(separatingLineTerminatorCount);
                     shouldEmitInterveningComments = false;
                 }

tests/baselines/reference/arrowFunctionParsingDoesNotConfuseParenthesizedObjectForArrowHead.js

@@ -20,7 +20,7 @@ const test = () => ({
 //// [arrowFunctionParsingDoesNotConfuseParenthesizedObjectForArrowHead.js]
 var test = function () { return ({
     // "Identifier expected." error on "!" and two "Duplicate identifier '(Missing)'." errors on space.
-    prop: !value,
+    prop: !value, // remove ! to see that errors will be gone
     run: function () {
         // comment next line or remove "()" to see that errors will be gone
         if (!a.b()) {

tests/baselines/reference/assignmentCompatBug3.js

@@ -30,8 +30,8 @@ foo(x + y);
 //// [assignmentCompatBug3.js]
 function makePoint(x, y) {
     return {
-        get x() { return x; },
-        get y() { return y; },
+        get x() { return x; }, // shouldn't be "void"
+        get y() { return y; }, // shouldn't be "void"
         //x: "yo",
         //y: "boo",
         dist: function () {

tests/baselines/reference/bindingPatternCannotBeOnlyInferenceSource.js

@@ -45,7 +45,7 @@ var _d = useReduxDispatch1(function (d, f) { return ({
             p[_i] = arguments[_i];
         }
         return d(f.funcA.apply(f, p));
-    },
+    }, // p should be inferrable
     funcB: function () {
         var p = [];
         for (var _i = 0; _i < arguments.length; _i++) {

tests/baselines/reference/callSignaturesWithParameterInitializers2.js

@@ -49,7 +49,7 @@ c.foo(1);
 var b = {
     foo: function (x) {
         if (x === void 0) { x = 1; }
-    },
+    }, // error
     foo: function (x) {
         if (x === void 0) { x = 1; }
     },

tests/baselines/reference/circularResolvedSignature.js

@@ -24,7 +24,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Component = void 0;
 function Component() {
     var _a = useState(function () { return ({
-        value: "string",
+        value: "string", // this should be a number
         foo: function (arg) { return setState(arg); },
         bar: function (arg) { return setState(arg); },
     }); }), state = _a[0], setState = _a[1];

tests/baselines/reference/commentsOnObjectLiteral5.js

@@ -0,0 +1,18 @@
+//// [tests/cases/compiler/commentsOnObjectLiteral5.ts] ////
+
+//// [commentsOnObjectLiteral5.ts]
+const a = {
+    p0: 0, // Comment 0
+    p1: 0, /* Comment 1
+    A multiline comment. */
+    p2: 0, // Comment 2
+};
+
+
+//// [commentsOnObjectLiteral5.js]
+var a = {
+    p0: 0, // Comment 0
+    p1: 0, /* Comment 1
+    A multiline comment. */
+    p2: 0, // Comment 2
+};

tests/baselines/reference/commentsOnObjectLiteral5.symbols

@@ -0,0 +1,18 @@
+//// [tests/cases/compiler/commentsOnObjectLiteral5.ts] ////
+
+=== commentsOnObjectLiteral5.ts ===
+const a = {
+>a : Symbol(a, Decl(commentsOnObjectLiteral5.ts, 0, 5))
+
+    p0: 0, // Comment 0
+>p0 : Symbol(p0, Decl(commentsOnObjectLiteral5.ts, 0, 11))
+
+    p1: 0, /* Comment 1
+>p1 : Symbol(p1, Decl(commentsOnObjectLiteral5.ts, 1, 10))
+
+    A multiline comment. */
+    p2: 0, // Comment 2
+>p2 : Symbol(p2, Decl(commentsOnObjectLiteral5.ts, 2, 10))
+
+};
+

tests/baselines/reference/commentsOnObjectLiteral5.types

@@ -0,0 +1,22 @@
+//// [tests/cases/compiler/commentsOnObjectLiteral5.ts] ////
+
+=== commentsOnObjectLiteral5.ts ===
+const a = {
+>a : { p0: number; p1: number; p2: number; }
+>{    p0: 0, // Comment 0    p1: 0, /* Comment 1    A multiline comment. */    p2: 0, // Comment 2} : { p0: number; p1: number; p2: number; }
+
+    p0: 0, // Comment 0
+>p0 : number
+>0 : 0
+
+    p1: 0, /* Comment 1
+>p1 : number
+>0 : 0
+
+    A multiline comment. */
+    p2: 0, // Comment 2
+>p2 : number
+>0 : 0
+
+};
+

tests/baselines/reference/divergentAccessorsTypes6.js

@@ -49,9 +49,9 @@ var o1 = {
 };
 // A setter annotation still implies the getter return type.
 var o2 = {
-    get p1() { return 0; },
+    get p1() { return 0; }, // error - no annotation means type is implied from the setter annotation
     set p1(value) { },
-    get p2() { return 0; },
+    get p2() { return 0; }, // ok - explicit annotation
     set p2(value) { },
 };