Improving the hack that ensures we don't keep adding new lines before a file ending comment (#1427)

closes #1426

Author: belav

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/Comments_EndOfFileManyLines.expected.test

@@ -0,0 +1,5 @@
+using System;
+
+namespace MyCompany.MyNamespace;
+
+// Comment block

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/Comments_EndOfFileManyLines.test

@@ -0,0 +1,8 @@
+using System;
+
+namespace MyCompany.MyNamespace;
+
+
+
+
+// Comment block

Src/CSharpier/SyntaxPrinter/SyntaxNodePrinters/CompilationUnit.cs

@@ -8,6 +8,8 @@ public static Doc Print(CompilationUnitSyntax node, PrintingContext context)
 
         NamespaceLikePrinter.Print(node, docs, context);
 
+        // this is what ends up adding multiple HardLineSkipBreakIfFirstInGroup, but it is needed for some cases
+        // and trying to change the logic in there to not print multiple lines was taking me down a rabbit hole
         var finalTrivia = Token.PrintLeadingTriviaWithNewLines(
             node.EndOfFileToken.LeadingTrivia,
             context
@@ -17,14 +19,16 @@ public static Doc Print(CompilationUnitSyntax node, PrintingContext context)
             // really ugly code to prevent a comment at the end of a file from continually inserting new blank lines
             if (
                 finalTrivia is Concat { Contents.Count: > 1 } list
-                && list.Contents[1] is LeadingComment
                 && docs.Count > 0
                 && docs[^1] is Concat { Contents.Count: > 1 } previousList
                 && previousList.Contents[^1] is HardLine
                 && previousList.Contents[^2] is HardLine
             )
             {
-                list.Contents.RemoveAt(0);
+                while (list.Contents[0] is HardLine { SkipBreakIfFirstInGroup: true })
+                {
+                    list.Contents.RemoveAt(0);
+                }
 
                 docs.Add(finalTrivia);
             }