Handle header comments better by comparing its end line with first node line (microsoft#36413)

Fixes microsoft#31508

Author: sheetalkamat

src/services/textChanges.ts

@@ -1152,23 +1152,46 @@ namespace ts.textChanges {
             advancePastLineBreak();
         }
 
-        // For a source file, it is possible there are detached comments we should not skip
-        let ranges = getLeadingCommentRanges(text, position);
+        const ranges = getLeadingCommentRanges(text, position);
         if (!ranges) return position;
-        // However we should still skip a pinned comment at the top
-        if (ranges.length && ranges[0].kind === SyntaxKind.MultiLineCommentTrivia && isPinnedComment(text, ranges[0].pos)) {
-            position = ranges[0].end;
-            advancePastLineBreak();
-            ranges = ranges.slice(1);
-        }
-        // As well as any triple slash references
+
+        // Find the first attached comment to the first node and add before it
+        let lastComment: { range: CommentRange; pinnedOrTripleSlash: boolean; } | undefined;
+        let firstNodeLine: number | undefined;
         for (const range of ranges) {
-            if (range.kind === SyntaxKind.SingleLineCommentTrivia && isRecognizedTripleSlashComment(text, range.pos, range.end)) {
-                position = range.end;
-                advancePastLineBreak();
+            if (range.kind === SyntaxKind.MultiLineCommentTrivia) {
+                if (isPinnedComment(text, range.pos)) {
+                    lastComment = { range, pinnedOrTripleSlash: true };
+                    continue;
+                }
+            }
+            else if (isRecognizedTripleSlashComment(text, range.pos, range.end)) {
+                lastComment = { range, pinnedOrTripleSlash: true };
                 continue;
             }
-            break;
+
+            if (lastComment) {
+                // Always insert after pinned or triple slash comments
+                if (lastComment.pinnedOrTripleSlash) break;
+
+                // There was a blank line between the last comment and this comment.
+                // This comment is not part of the copyright comments
+                const commentLine = sourceFile.getLineAndCharacterOfPosition(range.pos).line;
+                const lastCommentEndLine = sourceFile.getLineAndCharacterOfPosition(lastComment.range.end).line;
+                if (commentLine >= lastCommentEndLine + 2) break;
+            }
+
+            if (sourceFile.statements.length) {
+                if (firstNodeLine === undefined) firstNodeLine = sourceFile.getLineAndCharacterOfPosition(sourceFile.statements[0].getStart()).line;
+                const commentEndLine = sourceFile.getLineAndCharacterOfPosition(range.end).line;
+                if (firstNodeLine < commentEndLine + 2) break;
+            }
+            lastComment = { range, pinnedOrTripleSlash: false };
+        }
+
+        if (lastComment) {
+            position = lastComment.range.end;
+            advancePastLineBreak();
         }
         return position;
 

tests/cases/fourslash/importNameCodeFixWithCopyright.ts

@@ -0,0 +1,90 @@
+/// <reference path='fourslash.ts' />
+
+// @Filename: /a.ts
+////export class A { }
+
+// @Filename: /b.ts
+/////*---------------------------------------------------------------------------------------------
+//// *  Copyright (c) Microsoft Corporation. All rights reserved.
+//// *  Licensed under the MIT License. See License.txt in the project root for license information.
+//// *--------------------------------------------------------------------------------------------*/
+////
+////export class B extends A { }
+
+// @Filename: /c.ts
+/////*---------------------------------------------------------------------------------------------
+//// *  Copyright (c) Microsoft Corporation. All rights reserved.
+//// *  Licensed under the MIT License. See License.txt in the project root for license information.
+//// *--------------------------------------------------------------------------------------------*/
+////
+//// /// <reference types="node" />
+//// /// <reference path="./a.ts" />
+//// /// <amd-dependency path="./b.ts" />
+////export class C extends A { }
+
+// @Filename: /d.ts
+/////*---------------------------------------------------------------------------------------------
+//// *  Copyright (c) Microsoft Corporation. All rights reserved.
+//// *  Licensed under the MIT License. See License.txt in the project root for license information.
+//// *--------------------------------------------------------------------------------------------*/
+////
+//// /// <reference types="node" />
+//// /// <reference path="./a.ts" />
+//// /// <amd-dependency path="./b.ts" />
+//// /**
+////  * This is a comment intended to be attached to this interface
+////  */
+////export class D extends A { }
+
+goTo.file("/b.ts");
+verify.codeFix({
+    description: ignoreInterpolations(ts.Diagnostics.Import_0_from_module_1),
+    newFileContent:
+        `/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { A } from "./a";
+
+export class B extends A { }`,
+});
+
+goTo.file("/c.ts");
+verify.codeFix({
+    description: ignoreInterpolations(ts.Diagnostics.Import_0_from_module_1),
+    newFileContent:
+        `/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+ /// <reference types="node" />
+ /// <reference path="./a.ts" />
+ /// <amd-dependency path="./b.ts" />
+
+import { A } from "./a";
+
+export class C extends A { }`,
+});
+
+goTo.file("/d.ts");
+verify.codeFix({
+    description: ignoreInterpolations(ts.Diagnostics.Import_0_from_module_1),
+    newFileContent:
+        `/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+ /// <reference types="node" />
+ /// <reference path="./a.ts" />
+ /// <amd-dependency path="./b.ts" />
+
+import { A } from "./a";
+
+ /**
+  * This is a comment intended to be attached to this interface
+  */
+export class D extends A { }`,
+});