Rename NoteMessage.fixItID to noteID

kimdv · kimdv · commit 4d0448092ed6 · 2023-10-09T20:48:22.000+02:00
diff --git a/Release Notes/510.md b/Release Notes/510.md
@@ -42,6 +42,11 @@
 
 ## API-Incompatible Changes
 
+- Note message Fix-It ID
+  - Description: This was an error that it was named `fixItID` and should have been named `noteID` instead. The deprecation methods
+      emit a warning that informs the developer that it have been renamed. If you previously conformed to `fixItID` it will not compile.
+  - Issue: https://github.com/apple/swift-syntax/issues/2261
+  - Pull Request: https://github.com/apple/swift-syntax/pull/2264
 
 ## Template
 
diff --git a/Sources/SwiftDiagnostics/Note.swift b/Sources/SwiftDiagnostics/Note.swift
@@ -20,7 +20,14 @@ public protocol NoteMessage {
   var message: String { get }
 
   /// See ``MessageID``.
-  var fixItID: MessageID { get }
+  var noteID: MessageID { get }
+}
+
+extension NoteMessage {
+  @available(*, deprecated, message: "Use noteID instead.", renamed: "noteID")
+  public var fixItID: MessageID {
+    return noteID
+  }
 }
 
 /// A note that points to another node that's relevant for a Diagnostic.
diff --git a/Sources/SwiftParserDiagnostics/ParserDiagnosticMessages.swift b/Sources/SwiftParserDiagnostics/ParserDiagnosticMessages.swift
@@ -36,16 +36,21 @@ public extension ParserError {
 }
 
 public protocol ParserNote: NoteMessage {
-  var fixItID: MessageID { get }
+  var noteID: MessageID { get }
 }
 
 public extension ParserNote {
+  @available(*, deprecated, message: "Use noteID instead.", renamed: "noteID")
   static var fixItID: MessageID {
+    return Self.noteID
+  }
+
+  static var noteID: MessageID {
     return MessageID(domain: diagnosticDomain, id: "\(self)")
   }
 
-  var fixItID: MessageID {
-    return Self.fixItID
+  var noteID: MessageID {
+    return Self.noteID
   }
 }
 
@@ -594,7 +599,7 @@ public struct StaticParserNote: NoteMessage {
     self.messageID = messageID
   }
 
-  public var fixItID: MessageID {
+  public var noteID: MessageID {
     MessageID(domain: diagnosticDomain, id: "\(type(of: self)).\(messageID)")
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -36,16 +36,21 @@ public extension ParserError {`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`public protocol ParserNote: NoteMessage {`
`39`		`- var fixItID: MessageID { get }`
	`39`	`+ var noteID: MessageID { get }`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`public extension ParserNote {`
	`43`	`+ @available(*, deprecated, message: "Use noteID instead.", renamed: "noteID")`
`43`	`44`	`static var fixItID: MessageID {`
	`45`	`+ return Self.noteID`
	`46`	`+ }`
	`47`	`+`
	`48`	`+ static var noteID: MessageID {`
`44`	`49`	`return MessageID(domain: diagnosticDomain, id: "\(self)")`
`45`	`50`	`}`
`46`	`51`
`47`		`- var fixItID: MessageID {`
`48`		`- return Self.fixItID`
	`52`	`+ var noteID: MessageID {`
	`53`	`+ return Self.noteID`
`49`	`54`	`}`
`50`	`55`	`}`
`51`	`56`
`@@ -594,7 +599,7 @@ public struct StaticParserNote: NoteMessage {`
`594`	`599`	`self.messageID = messageID`
`595`	`600`	`}`
`596`	`601`
`597`		`- public var fixItID: MessageID {`
	`602`	`+ public var noteID: MessageID {`
`598`	`603`	`MessageID(domain: diagnosticDomain, id: "\(type(of: self)).\(messageID)")`
`599`	`604`	`}`
`600`	`605`	`}`