Retain synthetic comments on classes and their properties.

mprobst · mprobst · commit 2529b864f4ab · 2018-07-18T17:23:27.000+02:00
diff --git a/src/compiler/transformers/ts.ts b/src/compiler/transformers/ts.ts
@@ -1245,6 +1245,7 @@ namespace ts {
                 const statement = createExpressionStatement(transformInitializedProperty(property, receiver));
                 setSourceMapRange(statement, moveRangePastModifiers(property));
                 setCommentRange(statement, property);
+                setOriginalNode(statement, property);
                 statements.push(statement);
             }
         }
@@ -1262,6 +1263,7 @@ namespace ts {
                 startOnNewLine(expression);
                 setSourceMapRange(expression, moveRangePastModifiers(property));
                 setCommentRange(expression, property);
+                setOriginalNode(expression, property);
                 expressions.push(expression);
             }
 
diff --git a/src/testRunner/unittests/transform.ts b/src/testRunner/unittests/transform.ts
@@ -334,6 +334,29 @@ export {Value};
                         }
                     }).outputText;
         });
+
+        // https://github.com/Microsoft/TypeScript/issues/17594
+        testBaseline("transformAddCommentToProperties", () => {
+            return transpileModule(`
+// class comment.
+class Clazz {
+    // original comment 1.
+    static staticProp: number = 1;
+    // original comment 2.
+    instanceProp: number = 2;
+    // original comment 3.
+    constructor(readonly field = 1) {}
+}
+`, {
+                        transformers: {
+                            before: [addSyntheticComment(n => isPropertyDeclaration(n) || isParameterPropertyDeclaration(n) || isClassDeclaration(n) || isConstructorDeclaration(n))],
+                        },
+                        compilerOptions: {
+                            target: ScriptTarget.ES2015,
+                            newLine: NewLineKind.CarriageReturnLineFeed,
+                        }
+                    }).outputText;
+        });
     });
 }
 
diff --git a/tests/baselines/reference/transformApi/transformsCorrectly.transformAddCommentToClassProp.js b/tests/baselines/reference/transformApi/transformsCorrectly.transformAddCommentToClassProp.js
@@ -0,0 +1,7 @@
+class X {
+    constructor() {
+        // new comment!
+        // original comment.
+        this.foo = 1;
+    }
+}
diff --git a/tests/baselines/reference/transformApi/transformsCorrectly.transformAddCommentToProperties.js b/tests/baselines/reference/transformApi/transformsCorrectly.transformAddCommentToProperties.js
@@ -0,0 +1,12 @@
+/*comment*/
+class Clazz {
+    /*comment*/
+    constructor(/*comment*/
+    field = 1) {
+        this.field = field;
+        /*comment*/
+        this.instanceProp = 2;
+    }
+}
+/*comment*/
+Clazz.staticProp = 1;

Original file line number	Diff line number	Diff line change
`@@ -1245,6 +1245,7 @@ namespace ts {`
`1245`	`1245`	`const statement = createExpressionStatement(transformInitializedProperty(property, receiver));`
`1246`	`1246`	`setSourceMapRange(statement, moveRangePastModifiers(property));`
`1247`	`1247`	`setCommentRange(statement, property);`
	`1248`	`+ setOriginalNode(statement, property);`
`1248`	`1249`	`statements.push(statement);`
`1249`	`1250`	`}`
`1250`	`1251`	`}`
`@@ -1262,6 +1263,7 @@ namespace ts {`
`1262`	`1263`	`startOnNewLine(expression);`
`1263`	`1264`	`setSourceMapRange(expression, moveRangePastModifiers(property));`
`1264`	`1265`	`setCommentRange(expression, property);`
	`1266`	`+ setOriginalNode(expression, property);`
`1265`	`1267`	`expressions.push(expression);`
`1266`	`1268`	`}`
`1267`	`1269`