Merge pull request #14274 from Microsoft/master-14217

[Master] Fix 14217 emit shebang at the top of output file

Author: yuit

src/compiler/emitter.ts

@@ -276,6 +276,8 @@ namespace ts {
         function writeBundle(bundle: Bundle, output: EmitTextWriter) {
             const previousWriter = writer;
             setWriter(output);
+            emitShebangIfNeeded(bundle);
+            emitPrologueDirectivesIfNeeded(bundle);
             emitHelpersIndirect(bundle);
             for (const sourceFile of bundle.sourceFiles) {
                 print(EmitHint.SourceFile, sourceFile, sourceFile);
@@ -287,6 +289,8 @@ namespace ts {
         function writeFile(sourceFile: SourceFile, output: EmitTextWriter) {
             const previousWriter = writer;
             setWriter(output);
+            emitShebangIfNeeded(sourceFile);
+            emitPrologueDirectivesIfNeeded(sourceFile);
             print(EmitHint.SourceFile, sourceFile, sourceFile);
             reset();
             writer = previousWriter;
@@ -737,15 +741,6 @@ namespace ts {
             return node && substituteNode && substituteNode(hint, node) || node;
         }
 
-        function emitBodyIndirect(node: Node, elements: NodeArray<Node>, emitCallback: (node: Node) => void): void {
-            if (emitBodyWithDetachedComments) {
-                emitBodyWithDetachedComments(node, elements, emitCallback);
-            }
-            else {
-                emitCallback(node);
-            }
-        }
-
         function emitHelpersIndirect(node: Node) {
             if (onEmitHelpers) {
                 onEmitHelpers(node, writeLines);
@@ -1663,7 +1658,12 @@ namespace ts {
                 ? emitBlockFunctionBodyOnSingleLine
                 : emitBlockFunctionBodyWorker;
 
-            emitBodyIndirect(body, body.statements, emitBlockFunctionBody);
+            if (emitBodyWithDetachedComments) {
+                emitBodyWithDetachedComments(body, body.statements, emitBlockFunctionBody);
+            }
+            else {
+                emitBlockFunctionBody(body);
+            }
 
             decreaseIndent();
             writeToken(SyntaxKind.CloseBraceToken, body.statements.end, body);
@@ -2072,16 +2072,27 @@ namespace ts {
 
         function emitSourceFile(node: SourceFile) {
             writeLine();
-            emitShebang();
-            emitBodyIndirect(node, node.statements, emitSourceFileWorker);
+            const statements = node.statements;
+            if (emitBodyWithDetachedComments) {
+                // Emit detached comment if there are no prologue directives or if the first node is synthesized.
+                // The synthesized node will have no leading comment so some comments may be missed.
+                const shouldEmitDetachedComment = statements.length === 0 ||
+                    !isPrologueDirective(statements[0]) ||
+                    nodeIsSynthesized(statements[0]);
+                if (shouldEmitDetachedComment) {
+                    emitBodyWithDetachedComments(node, statements, emitSourceFileWorker);
+                    return;
+                }
+            }
+            emitSourceFileWorker(node);
         }
 
         function emitSourceFileWorker(node: SourceFile) {
             const statements = node.statements;
-            const statementOffset = emitPrologueDirectives(statements);
             pushNameGenerationScope();
             emitHelpersIndirect(node);
-            emitList(node, statements, ListFormat.MultiLine, statementOffset);
+            const index = findIndex(statements, statement => !isPrologueDirective(statement));
+            emitList(node, statements, ListFormat.MultiLine, index === -1 ? statements.length : index);
             popNameGenerationScope();
         }
 
@@ -2095,13 +2106,20 @@ namespace ts {
          * Emits any prologue directives at the start of a Statement list, returning the
          * number of prologue directives written to the output.
          */
-        function emitPrologueDirectives(statements: Node[], startWithNewLine?: boolean): number {
+        function emitPrologueDirectives(statements: Node[], startWithNewLine?: boolean, seenPrologueDirectives?: Map<String>): number {
             for (let i = 0; i < statements.length; i++) {
-                if (isPrologueDirective(statements[i])) {
-                    if (startWithNewLine || i > 0) {
-                        writeLine();
+                const statement = statements[i];
+                if (isPrologueDirective(statement)) {
+                    const shouldEmitPrologueDirective = seenPrologueDirectives ? !seenPrologueDirectives.has(statement.expression.text) : true;
+                    if (shouldEmitPrologueDirective) {
+                        if (startWithNewLine || i > 0) {
+                            writeLine();
+                        }
+                        emit(statement);
+                        if (seenPrologueDirectives) {
+                            seenPrologueDirectives.set(statement.expression.text, statement.expression.text);
+                        }
                     }
-                    emit(statements[i]);
                 }
                 else {
                     // return index of the first non prologue directive
@@ -2112,18 +2130,43 @@ namespace ts {
             return statements.length;
         }
 
-        //
-        // Helpers
-        //
+        function emitPrologueDirectivesIfNeeded(sourceFileOrBundle: Bundle | SourceFile) {
+            if (isSourceFile(sourceFileOrBundle)) {
+                setSourceFile(sourceFileOrBundle as SourceFile);
+                emitPrologueDirectives((sourceFileOrBundle as SourceFile).statements);
+            }
+            else {
+                const seenPrologueDirectives = createMap<String>();
+                for (const sourceFile of (sourceFileOrBundle as Bundle).sourceFiles) {
+                    setSourceFile(sourceFile);
+                    emitPrologueDirectives(sourceFile.statements, /*startWithNewLine*/ true, seenPrologueDirectives);
+                }
+            }
+        }
 
-        function emitShebang() {
-            const shebang = getShebang(currentSourceFile.text);
-            if (shebang) {
-                write(shebang);
-                writeLine();
+        function emitShebangIfNeeded(sourceFileOrBundle: Bundle | SourceFile) {
+            if (isSourceFile(sourceFileOrBundle)) {
+                const shebang = getShebang(sourceFileOrBundle.text);
+                if (shebang) {
+                    write(shebang);
+                    writeLine();
+                    return true;
+                }
+            }
+            else {
+                for (const sourceFile of sourceFileOrBundle.sourceFiles) {
+                    // Emit only the first encountered shebang
+                    if (emitShebangIfNeeded(sourceFile)) {
+                        break;
+                    }
+                }
             }
         }
 
+        //
+        // Helpers
+        //
+
         function emitModifiers(node: Node, modifiers: NodeArray<Modifier>) {
             if (modifiers && modifiers.length) {
                 emitList(node, modifiers, ListFormat.Modifiers);

src/harness/harness.ts

@@ -1797,7 +1797,7 @@ namespace Harness {
                     if (currentFileContent === undefined) {
                         currentFileContent = "";
                     }
-                    else {
+                    else if (currentFileContent !== "") {
                         // End-of-line
                         currentFileContent = currentFileContent + "\n";
                     }

tests/baselines/reference/APISample_compile.js

@@ -1,5 +1,4 @@
 //// [APISample_compile.ts]
-
 /*
  * Note: This test is a public API sample. The sample sources can be found 
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#a-minimal-compiler
@@ -35,12 +34,12 @@ compile(process.argv.slice(2), {
 });
 
 //// [APISample_compile.js]
+"use strict";
 /*
  * Note: This test is a public API sample. The sample sources can be found
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#a-minimal-compiler
  *       Please log a "breaking change" issue for any API breaking change affecting this issue
  */
-"use strict";
 exports.__esModule = true;
 var ts = require("typescript");
 function compile(fileNames, options) {

tests/baselines/reference/APISample_linter.js

@@ -1,5 +1,4 @@
 //// [APISample_linter.ts]
-
 /*
  * Note: This test is a public API sample. The sample sources can be found 
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#traversing-the-ast-with-a-little-linter
@@ -65,12 +64,12 @@ fileNames.forEach(fileName => {
 });
 
 //// [APISample_linter.js]
+"use strict";
 /*
  * Note: This test is a public API sample. The sample sources can be found
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#traversing-the-ast-with-a-little-linter
  *       Please log a "breaking change" issue for any API breaking change affecting this issue
  */
-"use strict";
 exports.__esModule = true;
 var ts = require("typescript");
 function delint(sourceFile) {

tests/baselines/reference/APISample_parseConfig.js

@@ -1,5 +1,4 @@
 //// [APISample_parseConfig.ts]
-
 /*
  * Note: This test is a public API sample. The sample sources can be found 
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#a-minimal-compiler
@@ -37,12 +36,12 @@ export function createProgram(rootFiles: string[], compilerOptionsJson: string):
 }
 
 //// [APISample_parseConfig.js]
+"use strict";
 /*
  * Note: This test is a public API sample. The sample sources can be found
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#a-minimal-compiler
  *       Please log a "breaking change" issue for any API breaking change affecting this issue
  */
-"use strict";
 exports.__esModule = true;
 var ts = require("typescript");
 function printError(error) {

tests/baselines/reference/APISample_transform.js

@@ -1,5 +1,4 @@
 //// [APISample_transform.ts]
-
 /*
  * Note: This test is a public API sample. The sample sources can be found 
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#a-simple-transform-function
@@ -17,12 +16,12 @@ let result = ts.transpile(source, { module: ts.ModuleKind.CommonJS });
 console.log(JSON.stringify(result));
 
 //// [APISample_transform.js]
+"use strict";
 /*
  * Note: This test is a public API sample. The sample sources can be found
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#a-simple-transform-function
  *       Please log a "breaking change" issue for any API breaking change affecting this issue
  */
-"use strict";
 exports.__esModule = true;
 var ts = require("typescript");
 var source = "let x: string  = 'string'";

tests/baselines/reference/APISample_watcher.js

@@ -1,5 +1,4 @@
 //// [APISample_watcher.ts]
-
 /*
  * Note: This test is a public API sample. The sample sources can be found 
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#incremental-build-support-using-the-language-services
@@ -110,12 +109,12 @@ const currentDirectoryFiles = fs.readdirSync(process.cwd()).
 watch(currentDirectoryFiles, { module: ts.ModuleKind.CommonJS });
 
 //// [APISample_watcher.js]
+"use strict";
 /*
  * Note: This test is a public API sample. The sample sources can be found
          at: https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#incremental-build-support-using-the-language-services
  *       Please log a "breaking change" issue for any API breaking change affecting this issue
  */
-"use strict";
 exports.__esModule = true;
 var ts = require("typescript");
 function watch(rootFileNames, options) {

tests/baselines/reference/DeclarationErrorsNoEmitOnError.errors.txt

@@ -1,8 +1,7 @@
-tests/cases/compiler/DeclarationErrorsNoEmitOnError.ts(4,8): error TS4033: Property 'f' of exported interface has or is using private name 'T'.
+tests/cases/compiler/DeclarationErrorsNoEmitOnError.ts(3,8): error TS4033: Property 'f' of exported interface has or is using private name 'T'.
 
 
 ==== tests/cases/compiler/DeclarationErrorsNoEmitOnError.ts (1 errors) ====
-    
     type T = { x : number }
     export interface I {
         f: T;   

tests/baselines/reference/ES5For-ofTypeCheck10.errors.txt

@@ -1,9 +1,8 @@
-tests/cases/conformance/statements/for-ofStatements/ES5For-ofTypeCheck10.ts(10,6): error TS2304: Cannot find name 'Symbol'.
-tests/cases/conformance/statements/for-ofStatements/ES5For-ofTypeCheck10.ts(15,15): error TS2495: Type 'StringIterator' is not an array type or a string type.
+tests/cases/conformance/statements/for-ofStatements/ES5For-ofTypeCheck10.ts(9,6): error TS2304: Cannot find name 'Symbol'.
+tests/cases/conformance/statements/for-ofStatements/ES5For-ofTypeCheck10.ts(14,15): error TS2495: Type 'StringIterator' is not an array type or a string type.
 
 
 ==== tests/cases/conformance/statements/for-ofStatements/ES5For-ofTypeCheck10.ts (2 errors) ====
-    
     // In ES3/5, you cannot for...of over an arbitrary iterable.
     class StringIterator {
         next() {

tests/baselines/reference/ES5For-ofTypeCheck10.js

@@ -1,5 +1,4 @@
 //// [ES5For-ofTypeCheck10.ts]
-
 // In ES3/5, you cannot for...of over an arbitrary iterable.
 class StringIterator {
     next() {