(WIP) Add diagnostics for missing modifier in operator declaration & update test cases

Author: StevenWong12

Sources/SwiftParser/Declarations.swift

@@ -1964,9 +1964,16 @@ extension Parser {
     } else {
       unexpectedAtEnd = nil
     }
+
+    var modifiers: RawModifierListSyntax? = attrs.modifiers
+    if modifiers == nil {
+      let missedModifier = RawDeclModifierSyntax(name: self.missingToken(.prefix), detail: nil, arena: self.arena)
+      modifiers = RawModifierListSyntax(elements: [missedModifier], arena: self.arena)
+    }
+
     return RawOperatorDeclSyntax(
       attributes: attrs.attributes,
-      modifiers: attrs.modifiers,
+      modifiers: modifiers,
       unexpectedBeforeOperatorKeyword,
       operatorKeyword: operatorKeyword,
       unexpectedBeforeName,

Sources/SwiftParserDiagnostics/ParseDiagnosticsGenerator.swift

@@ -855,6 +855,17 @@ public class ParseDiagnosticsGenerator: SyntaxAnyVisitor {
     if shouldSkip(node) {
       return .skipChildren
     }
+
+    if let modifier = node.modifiers,
+      modifier.isMissingAllTokens == true
+    {
+      addDiagnostic(
+        modifier,
+        .missingModifierForOperatorDecl,
+        handledNodes: [modifier.id]
+      )
+    }
+
     if let unexpected = node.unexpectedAfterOperatorPrecedenceAndTypes,
       unexpected.contains(where: { $0.is(PrecedenceGroupAttributeListSyntax.self) }) == true
     {

Sources/SwiftParserDiagnostics/ParserDiagnosticMessages.swift

@@ -164,6 +164,9 @@ extension DiagnosticMessage where Self == StaticParserError {
   public static var missingConformanceRequirement: Self {
     .init("expected ':' or '==' to indicate a conformance or same-type requirement")
   }
+  public static var missingModifierForOperatorDecl: Self {
+    .init("operator must be declared as 'prefix', 'postfix', or 'infix'")
+  }
   public static var misspelledAsync: Self {
     .init("expected async specifier; did you mean 'async'?")
   }

Tests/SwiftParserTest/Parser+EntryTests.swift

@@ -47,7 +47,7 @@ public class EntryTests: XCTestCase {
 
   func testRemainderUnexpectedDoesntOverrideExistingUnexpected() throws {
     AssertParse(
-      "operator 1️⃣test 2️⃣{} other tokens",
+      "1️⃣operator 2️⃣test 3️⃣{} other tokens",
       { DeclSyntax.parse(from: &$0) },
       substructure: Syntax(
         UnexpectedNodesSyntax([
@@ -58,10 +58,11 @@ public class EntryTests: XCTestCase {
           TokenSyntax.identifier("tokens"),
         ])
       ),
-      substructureAfterMarker: "2️⃣",
+      substructureAfterMarker: "3️⃣",
       diagnostics: [
-        DiagnosticSpec(locationMarker: "1️⃣", message: "'test' is considered an identifier and must not appear within an operator name"),
-        DiagnosticSpec(locationMarker: "2️⃣", message: "operator should not be declared with body"),
+        DiagnosticSpec(locationMarker: "1️⃣", message: "operator must be declared as 'prefix', 'postfix', or 'infix'"),
+        DiagnosticSpec(locationMarker: "2️⃣", message: "'test' is considered an identifier and must not appear within an operator name"),
+        DiagnosticSpec(locationMarker: "3️⃣", message: "operator should not be declared with body"),
       ]
     )
   }

Tests/SwiftParserTest/translated/OperatorDeclTests.swift

@@ -117,34 +117,34 @@ final class OperatorDeclTests: XCTestCase {
   func testOperatorDecl6() {
     AssertParse(
       """
-      operator ++*** : A
+      1️⃣operator ++*** : A
       """,
       diagnostics: [
-        // TODO: Old parser expected error on line 1: operator must be declared as 'prefix', 'postfix', or 'infix'
+        DiagnosticSpec(message: "operator must be declared as 'prefix', 'postfix', or 'infix'")
       ]
     )
   }
 
   func testOperatorDecl7() {
     AssertParse(
       """
-      operator +*+++ 1️⃣{ }
+      1️⃣operator +*+++ 2️⃣{ }
       """,
       diagnostics: [
-        // TODO: Old parser expected error on line 1: operator must be declared as 'prefix', 'postfix', or 'infix'
-        DiagnosticSpec(message: "operator should not be declared with body")
+        DiagnosticSpec(locationMarker: "1️⃣", message: "operator must be declared as 'prefix', 'postfix', or 'infix'"),
+        DiagnosticSpec(locationMarker: "2️⃣", message: "operator should not be declared with body"),
       ]
     )
   }
 
   func testOperatorDecl8() {
     AssertParse(
       """
-      operator +*++* : A 1️⃣{ }
+      1️⃣operator +*++* : A 2️⃣{ }
       """,
       diagnostics: [
-        // TODO: Old parser expected error on line 1: operator must be declared as 'prefix', 'postfix', or 'infix'
-        DiagnosticSpec(message: "operator should not be declared with body")
+        DiagnosticSpec(locationMarker: "1️⃣", message: "operator must be declared as 'prefix', 'postfix', or 'infix'"),
+        DiagnosticSpec(locationMarker: "2️⃣", message: "operator should not be declared with body"),
       ]
     )
   }
@@ -167,7 +167,9 @@ final class OperatorDeclTests: XCTestCase {
       prefix operator %%+
       """,
       diagnostics: [
-        DiagnosticSpec(message: "unexpected code before operator declaration")
+        DiagnosticSpec(message: "operator must be declared as 'prefix', 'postfix', or 'infix'"),
+        // TODO: should be "unexpected code before operator declaration" here
+        DiagnosticSpec(message: "unexpected code in operator declaration"),
       ]
     )
   }