Merge pull request #1391 from ahoppen/ahoppen/grouped-formatter

Use the grouped diagnostics formatter in `swift-parser-cli print-diags`

Author: ahoppen

Sources/SwiftDiagnostics/GroupedDiagnostics.swift

@@ -61,6 +61,7 @@ public struct GroupedDiagnostics {
   ///     absolute position within that parent source file.
   ///
   /// - Returns: The unique ID for this source file.
+  @discardableResult
   public mutating func addSourceFile(
     tree: SourceFileSyntax,
     displayName: String,
@@ -206,4 +207,13 @@ extension DiagnosticsFormatter {
       group.annotateSource(rootSourceFileID, formatter: self, indentString: "")
     }.joined(separator: "\n")
   }
+
+  public static func annotateSources(
+    in group: GroupedDiagnostics,
+    contextSize: Int = 2,
+    colorize: Bool = false
+  ) -> String {
+    let formatter = DiagnosticsFormatter(contextSize: contextSize, colorize: colorize)
+    return formatter.annotateSources(in: group)
+  }
 }

Sources/swift-parser-cli/swift-parser-cli.swift

@@ -214,9 +214,11 @@ class PrintDiags: ParsableCommand {
       if foldSequences {
         diags += foldAllSequences(tree).1
       }
-      let annotatedSource = DiagnosticsFormatter.annotatedSource(
-        tree: tree,
-        diags: diags,
+
+      var group = GroupedDiagnostics()
+      group.addSourceFile(tree: tree, displayName: sourceFile ?? "stdin", diagnostics: diags)
+      let annotatedSource = DiagnosticsFormatter.annotateSources(
+        in: group,
         colorize: colorize || TerminalHelper.isConnectedToTerminal
       )
 

Tests/SwiftDiagnosticsTest/GroupDiagnosticsFormatterTests.swift

@@ -108,9 +108,7 @@ final class GroupedDiagnosticsFormatterTests: XCTestCase {
       ]
     )
 
-    let formatter = DiagnosticsFormatter()
-    let annotated = formatter.annotateSources(in: group)
-    print(annotated)
+    let annotated = DiagnosticsFormatter.annotateSources(in: group)
     AssertStringsEqualWithDiff(
       annotated,
       """
@@ -179,9 +177,7 @@ final class GroupedDiagnosticsFormatterTests: XCTestCase {
       ]
     )
 
-    let formatter = DiagnosticsFormatter()
-    let annotated = formatter.annotateSources(in: group)
-    print(annotated)
+    let annotated = DiagnosticsFormatter.annotateSources(in: group)
     AssertStringsEqualWithDiff(
       annotated,
       """