Address code review feedback

Author: DougGregor

Sources/SwiftDiagnostics/DiagnosticsFormatter.swift

@@ -20,11 +20,15 @@ public struct DiagnosticsFormatter {
     var diagnostics: [Diagnostic]
     var sourceString: String
 
-    /// Non-diagnostic text.
+    /// Non-diagnostic text that is appended after this source line.
+    ///
+    /// Suffix text can be used to provide more information following a source
+    /// line, such as to provide an inset source buffer for a macro expansion
+    /// that occurs on that line.
     var suffixText: String
 
     /// Whether this line is free of annotations.
-    var isEmpty: Bool {
+    var isFreeOfAnnotations: Bool {
       return diagnostics.isEmpty && suffixText.isEmpty
     }
   }
@@ -51,15 +55,19 @@ public struct DiagnosticsFormatter {
   }
 
   /// Print given diagnostics for a given syntax tree on the command line
+  ///
+  /// - Parameters:
+  ///   - suffixTexts: suffix text to be printed at the given absolute
+  ///                  locations within the source file.
   func annotatedSource<SyntaxType: SyntaxProtocol>(
     fileName: String?,
     tree: SyntaxType,
     diags: [Diagnostic],
     indentString: String,
-    suffixText: [(AbsolutePosition, String)],
+    suffixTexts: [(AbsolutePosition, String)],
     sourceLocationConverter: SourceLocationConverter? = nil
   ) -> String {
-    let slc = sourceLocationConverter ?? SourceLocationConverter(file: "", tree: tree)
+    let slc = sourceLocationConverter ?? SourceLocationConverter(file: fileName ?? "", tree: tree)
 
     // First, we need to put each line and its diagnostics together
     var annotatedSourceLines = [AnnotatedSourceLine]()
@@ -68,7 +76,7 @@ public struct DiagnosticsFormatter {
       let diagsForLine = diags.filter { diag in
         return diag.location(converter: slc).line == (sourceLineIndex + 1)
       }
-      let suffixText = suffixText.compactMap { (position, text) in
+      let suffixText = suffixTexts.compactMap { (position, text) in
         if slc.location(for: position).line == (sourceLineIndex + 1) {
           return text
         }
@@ -82,7 +90,7 @@ public struct DiagnosticsFormatter {
     // Only lines with diagnostic messages should be printed, but including some context
     let rangesToPrint = annotatedSourceLines.enumerated().compactMap { (lineIndex, sourceLine) -> Range<Int>? in
       let lineNumber = lineIndex + 1
-      if !sourceLine.isEmpty {
+      if !sourceLine.isFreeOfAnnotations {
         return Range<Int>(uncheckedBounds: (lower: lineNumber - contextSize, upper: lineNumber + contextSize + 1))
       }
       return nil
@@ -178,7 +186,7 @@ public struct DiagnosticsFormatter {
       tree: tree,
       diags: diags,
       indentString: "",
-      suffixText: []
+      suffixTexts: []
     )
   }
 

Sources/SwiftDiagnostics/GroupedDiagnostics.swift

@@ -191,7 +191,7 @@ extension GroupedDiagnostics {
         tree: sourceFile.tree,
         diags: sourceFile.diagnostics,
         indentString: colorizeBufferOutline(indentString),
-        suffixText: childSources,
+        suffixTexts: childSources,
         sourceLocationConverter: slc
       ) + suffixString
   }

Tests/SwiftDiagnosticsTest/GroupDiagnosticsFormatterTests.swift

@@ -81,27 +81,27 @@ final class GroupedDiagnosticsFormatterTests: XCTestCase {
     let (mainSourceID, mainSourceMarkers) = group.addTestFile(
       """
       let pi = 3.14159
-      0️⃣#myAssert(pi == 3)
+      1️⃣#myAssert(pi == 3)
       print("hello"
       """,
       displayName: "main.swift",
-      extraDiagnostics: ["0️⃣": ("in expansion of macro 'myAssert' here", .note)]
+      extraDiagnostics: ["1️⃣": ("in expansion of macro 'myAssert' here", .note)]
     )
-    let inExpansionNotePos = mainSourceMarkers["0️⃣"]!
+    let inExpansionNotePos = mainSourceMarkers["1️⃣"]!
 
     // Expansion source file
     _ = group.addTestFile(
       """
       let __a = pi
       let __b = 3
-      if !(__a 0️⃣== __b) {
+      if !(__a 1️⃣== __b) {
         fatalError("assertion failed: pi != 3")
       }
       """,
       displayName: "#myAssert",
       parent: (mainSourceID, inExpansionNotePos),
       extraDiagnostics: [
-        "0️⃣": ("no matching operator '==' for types 'Double' and 'Int'", .error)
+        "1️⃣": ("no matching operator '==' for types 'Double' and 'Int'", .error)
       ]
     )
 
@@ -137,40 +137,40 @@ final class GroupedDiagnosticsFormatterTests: XCTestCase {
     let (mainSourceID, mainSourceMarkers) = group.addTestFile(
       """
       let pi = 3.14159
-      0️⃣#myAssert(pi == 3)
+      1️⃣#myAssert(pi == 3)
       print("hello"
       """,
       displayName: "main.swift",
-      extraDiagnostics: ["0️⃣": ("in expansion of macro 'myAssert' here", .note)]
+      extraDiagnostics: ["1️⃣": ("in expansion of macro 'myAssert' here", .note)]
     )
-    let inExpansionNotePos = mainSourceMarkers["0️⃣"]!
+    let inExpansionNotePos = mainSourceMarkers["1️⃣"]!
 
     // Outer expansion source file
     let (outerExpansionSourceID, outerExpansionSourceMarkers) = group.addTestFile(
       """
       let __a = pi
       let __b = 3
-      if 0️⃣#invertedEqualityCheck(__a, __b) {
+      if 1️⃣#invertedEqualityCheck(__a, __b) {
         fatalError("assertion failed: pi != 3")
       }
       """,
       displayName: "#myAssert",
       parent: (mainSourceID, inExpansionNotePos),
       extraDiagnostics: [
-        "0️⃣": ("in expansion of macro 'invertedEqualityCheck' here", .note)
+        "1️⃣": ("in expansion of macro 'invertedEqualityCheck' here", .note)
       ]
     )
-    let inInnerExpansionNotePos = outerExpansionSourceMarkers["0️⃣"]!
+    let inInnerExpansionNotePos = outerExpansionSourceMarkers["1️⃣"]!
 
     // Expansion source file
     _ = group.addTestFile(
       """
-      !(__a 0️⃣== __b)
+      !(__a 1️⃣== __b)
       """,
       displayName: "#invertedEqualityCheck",
       parent: (outerExpansionSourceID, inInnerExpansionNotePos),
       extraDiagnostics: [
-        "0️⃣": ("no matching operator '==' for types 'Double' and 'Int'", .error)
+        "1️⃣": ("no matching operator '==' for types 'Double' and 'Int'", .error)
       ]
     )