Merge pull request #1441 from ahoppen/ahoppen/highlight

If no explicit highlight range was given, highlight the node the diagnostic is anchored at instead of highlighting nothing

Author: ahoppen

Sources/SwiftDiagnostics/Diagnostic.swift

@@ -33,18 +33,20 @@ public struct Diagnostic: CustomDebugStringConvertible {
   /// Each Fix-It offers a different way to resolve the diagnostic. Usually, there's only one.
   public let fixIts: [FixIt]
 
+  /// If `highlights` is `nil` then `node` will be highlighted. This is a
+  /// reasonable default for almost all diagnostics.
   public init(
     node: Syntax,
     position: AbsolutePosition? = nil,
     message: DiagnosticMessage,
-    highlights: [Syntax] = [],
+    highlights: [Syntax]? = nil,
     notes: [Note] = [],
     fixIts: [FixIt] = []
   ) {
     self.node = node
     self.position = position ?? node.positionAfterSkippingLeadingTrivia
     self.diagMessage = message
-    self.highlights = highlights
+    self.highlights = highlights ?? [node]
     self.notes = notes
     self.fixIts = fixIts
   }

Sources/SwiftParserDiagnostics/ParseDiagnosticsGenerator.swift

@@ -84,11 +84,12 @@ public class ParseDiagnosticsGenerator: SyntaxAnyVisitor {
   // MARK: - Private helper functions
 
   /// Produce a diagnostic.
+  /// If `highlights` is `nil` the `node` will be highlighted.
   func addDiagnostic<T: SyntaxProtocol>(
     _ node: T,
     position: AbsolutePosition? = nil,
     _ message: DiagnosticMessage,
-    highlights: [Syntax] = [],
+    highlights: [Syntax]? = nil,
     notes: [Note] = [],
     fixIts: [FixIt] = [],
     handledNodes: [SyntaxIdentifier] = []

Sources/SwiftSyntaxBuilder/ValidatingSyntaxNodes.swift

@@ -32,7 +32,7 @@ extension SyntaxProtocol {
 }
 
 extension Trivia {
-  /// If `trivia` has contains no unexpected trivia, return `trivia`, otherwise
+  /// If `trivia` contains no unexpected trivia, return `trivia`, otherwise
   /// throw an error with diagnostics describing the unexpected trivia.
   public init(validating trivia: Trivia) throws {
     self = trivia

Tests/SwiftParserTest/translated/RecoveryTests.swift

@@ -747,7 +747,7 @@ final class RecoveryTests: XCTestCase {
       protocol Multi 1️⃣ident {}
       """,
       diagnostics: [
-        DiagnosticSpec(message: "found an unexpected second identifier in protocol")
+        DiagnosticSpec(message: "found an unexpected second identifier in protocol", highlight: "ident")
       ]
     )
   }