Allow leading dot syntax for StaticParserFixIt

Following a similar pattern to StaticParserError,
convert StaticParserFixIt into a struct with
static members in a constrained protocol extension.

Author: hamishknight

Sources/SwiftParser/Diagnostics/DiagnosticExtensions.swift

@@ -14,14 +14,18 @@ import SwiftDiagnostics
 import SwiftSyntax
 
 extension FixIt {
-  init(message: StaticParserFixIt, changes: Changes) {
-    self.init(message: message as FixItMessage, changes: changes)
-  }
-
   public init(message: FixItMessage, changes: [Changes]) {
     self.init(message: message, changes: FixIt.Changes(combining: changes))
   }
 
+  // These overloads shouldn't be needed, but are currently required for the
+  // Swift 5.5 compiler to handle non-trivial FixIt initializations using
+  // leading-dot syntax.
+  // TODO: These can be dropped once we require a minimum of Swift 5.6 to
+  // compile the library.
+  init(message: StaticParserFixIt, changes: Changes) {
+    self.init(message: message as FixItMessage, changes: changes)
+  }
   init(message: StaticParserFixIt, changes: [Changes]) {
     self.init(message: message as FixItMessage, changes: FixIt.Changes(combining: changes))
   }

Sources/SwiftParser/Diagnostics/ParserDiagnosticMessages.swift

@@ -272,18 +272,43 @@ public struct UnknownDirectiveError: ParserError {
 
 // MARK: - Fix-Its (please sort alphabetically)
 
-public enum StaticParserFixIt: String, FixItMessage {
-  case insertSemicolon = "insert ';'"
-  case insertAttributeArguments = "insert attribute argument"
-  case joinIdentifiers = "join the identifiers together"
-  case joinIdentifiersWithCamelCase = "join the identifiers together with camel-case"
-  case removeOperatorBody = "remove operator body"
-  case wrapKeywordInBackticks = "if this name is unavoidable, use backticks to escape it"
+/// A parser fix-it with a static message.
+public struct StaticParserFixIt: FixItMessage {
+  public let message: String
+  private let messageID: String
 
-  public var message: String { self.rawValue }
+  /// This should only be called within a static var on FixItMessage, such
+  /// as the examples below. This allows us to pick up the messageID from the
+  /// var name.
+  fileprivate init(_ message: String, messageID: String = #function) {
+    self.message = message
+    self.messageID = messageID
+  }
 
   public var fixItID: MessageID {
-    MessageID(domain: diagnosticDomain, id: "\(type(of: self)).\(self)")
+    MessageID(domain: diagnosticDomain, id: "\(type(of: self)).\(messageID)")
+  }
+}
+
+extension FixItMessage where Self == StaticParserFixIt {
+  /// Please order alphabetically by property name.
+  public static var insertSemicolon: Self {
+    .init("insert ';'")
+  }
+  public static var insertAttributeArguments: Self {
+    .init("insert attribute argument")
+  }
+  public static var joinIdentifiers: Self {
+    .init("join the identifiers together")
+  }
+  public static var joinIdentifiersWithCamelCase: Self {
+    .init("join the identifiers together with camel-case")
+  }
+  public static var removeOperatorBody: Self {
+    .init("remove operator body")
+  }
+  public static var wrapKeywordInBackticks: Self {
+    .init("if this name is unavoidable, use backticks to escape it")
   }
 }
 

Tests/SwiftParserTest/DiagnosticInfrastructureTests.swift

@@ -15,5 +15,10 @@ public class DiagnosticInfrastructureTests: XCTestCase {
 
     XCTAssertEqual(StaticParserError.throwsInReturnPosition.diagnosticID, MessageID(domain: "SwiftParser", id: "StaticParserError.throwsInReturnPosition"))
     XCTAssertEqual(StaticParserError.throwsInReturnPosition.severity, .error)
+
+    XCTAssertEqual(
+      StaticParserFixIt.insertSemicolon.fixItID,
+      MessageID(domain: "SwiftParser", id: "StaticParserFixIt.insertSemicolon")
+    )
   }
 }