Use token nameForDiagnostics to generate diagnostic messages

Author: ahoppen

Sources/SwiftParser/Diagnostics/ParserDiagnosticMessages.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import SwiftDiagnostics
-import SwiftSyntax
+@_spi(RawSyntax) import SwiftSyntax
 
 let diagnosticDomain: String = "SwiftParser"
 
@@ -139,22 +139,27 @@ public struct MissingTokenError: ParserError {
   public let missingToken: TokenSyntax
 
   public var message: String {
-    guard let parent = missingToken.parent, let parentTypeName = parent.nodeTypeNameForDiagnostics() else {
-      return "Expected '\(missingToken.text)'"
+    var message = "Expected"
+    if missingToken.text.isEmpty {
+      message += " \(missingToken.tokenKind.decomposeToRaw().rawKind.nameForDiagnostics)"
+    } else {
+      message += " '\(missingToken.text)'"
     }
-    switch missingToken.tokenKind {
-    case .leftAngle, .leftBrace, .leftParen, .leftSquareBracket:
-      if parent.children(viewMode: .fixedUp).first?.as(TokenSyntax.self) == missingToken {
-        return "Expected '\(missingToken.text)' to start \(parentTypeName)"
-      }
-    case .rightAngle, .rightBrace, .rightParen, .rightSquareBracket:
-      if parent.children(viewMode: .fixedUp).last?.as(TokenSyntax.self) == missingToken {
-        return "Expected '\(missingToken.text)' to end \(parentTypeName)"
+    if let parent = missingToken.parent, let parentTypeName = parent.nodeTypeNameForDiagnostics() {
+      switch missingToken.tokenKind {
+      case .leftAngle, .leftBrace, .leftParen, .leftSquareBracket:
+        if parent.children(viewMode: .fixedUp).first?.as(TokenSyntax.self) == missingToken {
+          message += " to start \(parentTypeName)"
+        }
+      case .rightAngle, .rightBrace, .rightParen, .rightSquareBracket:
+        if parent.children(viewMode: .fixedUp).last?.as(TokenSyntax.self) == missingToken {
+          message += " to end \(parentTypeName)"
+        }
+      default:
+        message += " in \(parentTypeName)"
       }
-    default:
-      break
     }
-    return "Expected '\(missingToken.text)' in \(parentTypeName)"
+    return message
   }
 
   public var handledNodes: [Syntax] {

Tests/SwiftParserTest/Declarations.swift

@@ -38,7 +38,7 @@ final class DeclarationTests: XCTestCase {
                 r#^DIAG2^#
                 """,
                 diagnostics: [
-                  DiagnosticSpec(locationMarker: "DIAG1", message: "Expected '' in function"),
+                  DiagnosticSpec(locationMarker: "DIAG1", message: "Expected identifier in function"),
                   DiagnosticSpec(locationMarker: "DIAG1", message: "Expected argument list in function declaration"),
                   DiagnosticSpec(locationMarker: "DIAG2", message: "Expected '=' in same type requirement"),
                 ])
@@ -142,7 +142,7 @@ final class DeclarationTests: XCTestCase {
       "protocol P{#^DIAG_1^#{}case#^DIAG_2^#",
       diagnostics: [
         DiagnosticSpec(locationMarker: "DIAG_1", message: "Unexpected text '{}' before enum case"),
-        DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected '' in enum case"),
+        DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected identifier in enum case"),
         DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected '}' to end protocol"),
       ])
   }
@@ -795,8 +795,7 @@ final class DeclarationTests: XCTestCase {
       diagnostics: [
         DiagnosticSpec(locationMarker: "MISSING_COLON", message: "Expected ':' in function parameter"),
         DiagnosticSpec(locationMarker: "MISSING_RPAREN", message: "Expected ')' to end parameter clause"),
-        // FIXME: We should issues something like "Expected identifier in declaration"
-        DiagnosticSpec(locationMarker: "MISSING_IDENTIFIER", message: "Expected '' in struct"),
+        DiagnosticSpec(locationMarker: "MISSING_IDENTIFIER", message: "Expected identifier in struct"),
         DiagnosticSpec(locationMarker: "BRACES", message: "Expected '{' to start struct"),
         DiagnosticSpec(locationMarker: "BRACES", message: "Expected '}' to end struct"),
         DiagnosticSpec(locationMarker: "BRACES", message: "Extraneous ': Int) {}' at top level"),

Tests/SwiftParserTest/Expressions.swift

@@ -443,7 +443,7 @@ final class ExpressionTests: XCTestCase {
 
     AssertParse("#keyPath(#^DIAG^#(b:)",
                 diagnostics: [
-                  DiagnosticSpec(message: "Expected '' in '#keyPath' expression"),
+                  DiagnosticSpec(message: "Expected identifier in '#keyPath' expression"),
                   DiagnosticSpec(message: "Expected ')' to end '#keyPath' expression"),
                 ])
   }

Tests/SwiftParserTest/Types.swift

@@ -58,7 +58,7 @@ final class TypeTests: XCTestCase {
     AssertParse("{[#^DIAG_1^#class]in#^DIAG_2^#",
                 { $0.parseClosureExpression() },
                 diagnostics: [
-                  DiagnosticSpec(locationMarker: "DIAG_1", message: "Expected '' in closure capture item"),
+                  DiagnosticSpec(locationMarker: "DIAG_1", message: "Expected identifier in closure capture item"),
                   DiagnosticSpec(locationMarker: "DIAG_1", message: "Unexpected text 'class' in closure capture signature"),
                   DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected '}' to end closure"),
                 ])
@@ -72,7 +72,7 @@ final class TypeTests: XCTestCase {
     AssertParse("{[weak#^DIAG^#^]in}",
                 { $0.parseClosureExpression() },
                 diagnostics: [
-                  DiagnosticSpec(message: "Expected '' in closure capture item"),
+                  DiagnosticSpec(message: "Expected identifier in closure capture item"),
                   DiagnosticSpec(message: "Unexpected text '^' in closure capture signature"),
                 ])
   }