Retain synthetic comments on exported variables.

mprobst · mprobst · commit db888b86709b · 2018-07-18T16:30:32.000+02:00
Variables that do not have a local variable created get transformed into
a single exports assignment expression. TypeScript previously just
created a new expression and set the text range to retain original
comments, but for synthetic comments, merging the emit nodes by setting
the original node is required.
diff --git a/src/compiler/transformers/module/module.ts b/src/compiler/transformers/module/module.ts
@@ -1140,7 +1140,7 @@ namespace ts {
                 }
 
                 if (expressions) {
-                    statements = append(statements, setTextRange(createExpressionStatement(inlineExpressions(expressions)), node));
+                    statements = append(statements, setOriginalNode(setTextRange(createExpressionStatement(inlineExpressions(expressions)), node), node));
                 }
             }
             else {
diff --git a/src/testRunner/unittests/transform.ts b/src/testRunner/unittests/transform.ts
@@ -296,6 +296,36 @@ namespace ts {
                 }
             }
         });
+
+        // https://github.com/Microsoft/TypeScript/issues/17594
+        testBaseline("transformAddCommentToExportedVar", () => {
+            return transpileModule(`export const exportedDirectly = 1;
+const exportedSeparately = 2;
+export {exportedSeparately};
+`, {
+                        transformers: {
+                            before: [addSyntheticComment],
+                        },
+                        compilerOptions: {
+                            target: ScriptTarget.ES5,
+                            newLine: NewLineKind.CarriageReturnLineFeed,
+                        }
+                    }).outputText;
+
+                    function addSyntheticComment(context: TransformationContext) {
+                        return (sourceFile: SourceFile): SourceFile => {
+                            return visitNode(sourceFile, rootTransform, isSourceFile);
+                        };
+                        function rootTransform<T extends Node>(node: T): VisitResult<T> {
+                            if (isVariableStatement(node)) {
+                                setEmitFlags(node, EmitFlags.NoLeadingComments);
+                                setSyntheticLeadingComments(node, [{ kind: SyntaxKind.MultiLineCommentTrivia, text: "* @type {number} ", pos: -1, end: -1, hasTrailingNewLine: true }]);
+                                return node;
+                            }
+                            return visitEachChild(node, rootTransform, context);
+                        }
+                    }
+        });
     });
 }
 
diff --git a/tests/baselines/reference/transformApi/transformsCorrectly.transformAddCommentToExportedVar.js b/tests/baselines/reference/transformApi/transformsCorrectly.transformAddCommentToExportedVar.js
@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/** @type {number} */
+exports.exportedDirectly = 1;
+/** @type {number} */
+var exportedSeparately = 2;
+exports.exportedSeparately = exportedSeparately;

Original file line number	Diff line number	Diff line change
`@@ -1140,7 +1140,7 @@ namespace ts {`
`1140`	`1140`	`}`
`1141`	`1141`
`1142`	`1142`	`if (expressions) {`
`1143`		`- statements = append(statements, setTextRange(createExpressionStatement(inlineExpressions(expressions)), node));`
	`1143`	`+ statements = append(statements, setOriginalNode(setTextRange(createExpressionStatement(inlineExpressions(expressions)), node), node));`
`1144`	`1144`	`}`
`1145`	`1145`	`}`
`1146`	`1146`	`else {`