Fix to produce a single diagnostic that says it's invalid when an unexpected node exists between the argument and the right paren in AttributeSyntax

Author: TTOzzi

Sources/SwiftParserDiagnostics/ParseDiagnosticsGenerator.swift

@@ -459,6 +459,29 @@ public class ParseDiagnosticsGenerator: SyntaxAnyVisitor {
       )
       return .visitChildren
     }
+    if let unexpectedBetweenArgumentAndRightParen = node.unexpectedBetweenArgumentAndRightParen,
+      var missingArgumentNode = node.argument?.missingNodes.only
+    {
+      if missingArgumentNode.kind == .token,
+        let expectedNode = missingArgumentNode.parent?.ancestorOrSelf(mapping: { node in
+          if node.nodeTypeNameForDiagnostics(allowBlockNames: false) != nil {
+            return node
+          } else {
+            return nil
+          }
+        })
+      {
+        missingArgumentNode = expectedNode
+      }
+      addDiagnostic(
+        missingArgumentNode,
+        ConnectedExpectedNodeAndUnexpectedNodesError(expectedNode: missingArgumentNode, unexpectedNodes: unexpectedBetweenArgumentAndRightParen),
+        handledNodes: [
+          missingArgumentNode.id,
+          unexpectedBetweenArgumentAndRightParen.id,
+        ]
+      )
+    }
     return .visitChildren
   }
 

Sources/SwiftParserDiagnostics/ParserDiagnosticMessages.swift

@@ -287,6 +287,34 @@ public struct CannotParseVersionTuple: ParserError {
   }
 }
 
+public struct ConnectedExpectedNodeAndUnexpectedNodesError: ParserError {
+  public let expectedNode: Syntax
+  public let unexpectedNodes: UnexpectedNodesSyntax
+
+  public var message: String {
+    if let expectedNodeTypeName = expectedNode.nodeTypeNameForDiagnostics(allowBlockNames: false) {
+      if expectedNode.isMissingAllTokens {
+        return "expected \(expectedNodeTypeName), \(unexpectedNodes.shortSingleLineContentDescription) is not the valid \(expectedNodeTypeName)"
+      } else {
+        if expectedNode.position > unexpectedNodes.position {
+          if expectedNode.leadingTrivia.isEmpty {
+            return "expected \(expectedNodeTypeName), code '\(unexpectedNodes.description + expectedNode.description)' is not the valid \(expectedNodeTypeName)"
+          } else {
+            return "expected \(expectedNodeTypeName), \(unexpectedNodes.shortSingleLineContentDescription) and \(expectedNode.shortSingleLineContentDescription) are not the valid \(expectedNodeTypeName)"
+          }
+        } else if expectedNode.position < unexpectedNodes.position {
+          if expectedNode.trailingTrivia.isEmpty {
+            return "expected \(expectedNodeTypeName), code '\(expectedNode.description + unexpectedNodes.description)' is not the valid \(expectedNodeTypeName)"
+          } else {
+            return "expected \(expectedNodeTypeName), \(unexpectedNodes.shortSingleLineContentDescription) and \(expectedNode.shortSingleLineContentDescription) are not the valid \(expectedNodeTypeName)"
+          }
+        }
+      }
+    }
+    return "unexpected \(unexpectedNodes.shortSingleLineContentDescription)"
+  }
+}
+
 public struct DuplicateEffectSpecifiers: ParserError {
   public let correctSpecifier: TokenSyntax
   public let unexpectedSpecifier: TokenSyntax

Sources/SwiftParserDiagnostics/PresenceUtils.swift

@@ -34,13 +34,33 @@ class PresentNodeChecker: SyntaxAnyVisitor {
   }
 }
 
+/// Walks a tree and collects the missing nodes in it.
+class MissingNodeChecker: SyntaxAnyVisitor {
+  var missingNodes: [Syntax] = []
+
+  override func visitAny(_ node: Syntax) -> SyntaxVisitorContinueKind {
+    if node.isMissingAllTokens {
+      missingNodes.append(node)
+      return .skipChildren
+    }
+    return .visitChildren
+  }
+}
+
 extension SyntaxProtocol {
   /// Returns `true` if all tokens nodes in this tree are missing.
   var isMissingAllTokens: Bool {
     let checker = PresentNodeChecker(viewMode: .all)
     checker.walk(Syntax(self))
     return !checker.hasPresentToken
   }
+
+  /// Returns all missing nodes in this tree
+  var missingNodes: [Syntax] {
+    let checker = MissingNodeChecker(viewMode: .all)
+    checker.walk(Syntax(self))
+    return checker.missingNodes
+  }
 }
 
 /// Transforms a syntax tree by making all missing tokens present.

Tests/SwiftParserTest/AvailabilityTests.swift

@@ -148,28 +148,18 @@ final class AvailabilityTests: XCTestCase {
       func test() {}
       """,
       diagnostics: [
-        DiagnosticSpec(message: "expected version tuple in version restriction", fixIts: ["insert version tuple"]),
-        DiagnosticSpec(message: "unexpected code '10e10' in attribute"),
-      ],
-      fixedSource: """
-        @available(OSX <#integer literal#>10e10)
-        func test() {}
-        """
+        DiagnosticSpec(message: "expected version tuple, code '10e10' is not the valid version tuple")
+      ]
     )
 
     assertParse(
       """
-      @available(OSX 10.1️⃣0e10)
+      @available(OSX 1️⃣10.0e10)
       func test() {}
       """,
       diagnostics: [
-        DiagnosticSpec(message: "expected integer literal in version tuple", fixIts: ["insert integer literal"]),
-        DiagnosticSpec(message: "unexpected code '0e10' in attribute"),
-      ],
-      fixedSource: """
-        @available(OSX 10.<#integer literal#>0e10)
-        func test() {}
-        """
+        DiagnosticSpec(message: "expected version tuple, code '10.0e10' is not the valid version tuple")
+      ]
     )
 
     assertParse(
@@ -178,28 +168,18 @@ final class AvailabilityTests: XCTestCase {
       func test() {}
       """,
       diagnostics: [
-        DiagnosticSpec(message: "expected version tuple in version restriction", fixIts: ["insert version tuple"]),
-        DiagnosticSpec(message: "unexpected code '0xff' in attribute"),
-      ],
-      fixedSource: """
-        @available(OSX <#integer literal#>0xff)
-        func test() {}
-        """
+        DiagnosticSpec(message: "expected version tuple, code '0xff' is not the valid version tuple")
+      ]
     )
 
     assertParse(
       """
-      @available(OSX 1.0.1️⃣0xff)
+      @available(OSX 1️⃣1.0.0xff)
       func test() {}
       """,
       diagnostics: [
-        DiagnosticSpec(message: "expected integer literal in version tuple", fixIts: ["insert integer literal"]),
-        DiagnosticSpec(message: "unexpected code '0xff' in attribute"),
-      ],
-      fixedSource: """
-        @available(OSX 1.0.<#integer literal#>0xff)
-        func test() {}
-        """
+        DiagnosticSpec(message: "expected version tuple, code '1.0.0xff' is not the valid version tuple")
+      ]
     )
   }
 }