Generate compatibility layer for renamed syntax nodes

Author: ahoppen

CodeGeneration/Sources/SyntaxSupport/SyntaxNodeKind.swift

@@ -369,4 +369,23 @@ public enum SyntaxNodeKind: String, CaseIterable {
       return "Raw\(raw: rawValue.withFirstCharacterUppercased)SyntaxNodeProtocol"
     }
   }
+
+  public var deprecatedRawValue: String? {
+    switch self {
+    case .importPathComponentList:
+      return "accessPath"
+    case .importPathComponent:
+      return "accessPathComponent"
+    case .documentationAttributeArgumentList:
+      return "documentationAttributeArguments"
+    case .effectsArgumentList:
+      return "effectsArguments"
+    case .objCSelectorPieceList:
+      return "objCSelector"
+    case .stringLiteralSegmentList:
+      return "stringLiteralSegments"
+    default:
+      return nil
+    }
+  }
 }

CodeGeneration/Sources/generate-swiftsyntax/GenerateSwiftSyntax.swift

@@ -97,6 +97,7 @@ struct GenerateSwiftSyntax: ParsableCommand {
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["raw", "RawSyntaxNodes.swift"], rawSyntaxNodesFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["raw", "RawSyntaxValidation.swift"], rawSyntaxValidationFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["RenamedChildrenCompatibility.swift"], renamedChildrenCompatibilityFile),
+        GeneratedFileSpec(swiftSyntaxGeneratedDir + ["RenamedNodesCompatibility.swift"], renamedSyntaxNodesFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["SyntaxAnyVisitor.swift"], syntaxAnyVisitorFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["SyntaxBaseNodes.swift"], syntaxBaseNodesFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["SyntaxCollections.swift"], syntaxCollectionsFile),

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntax/RenamedSyntaxNodesFile.swift

@@ -0,0 +1,43 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import SwiftSyntax
+import SwiftSyntaxBuilder
+import SyntaxSupport
+import Utils
+
+let renamedSyntaxNodesFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
+  for syntaxKind in SyntaxNodeKind.allCases.sorted(by: { $0.deprecatedRawValue ?? "" < $1.deprecatedRawValue ?? "" }) {
+    if let deprecatedName = syntaxKind.deprecatedRawValue {
+      DeclSyntax(
+        """
+        @available(*, deprecated, renamed: "\(syntaxKind.syntaxType)")
+        public typealias \(raw: deprecatedName.withFirstCharacterUppercased)Syntax = \(syntaxKind.syntaxType)
+        """
+      )
+    }
+  }
+
+  try! ExtensionDeclSyntax("public extension SyntaxKind") {
+    for syntaxKind in SyntaxNodeKind.allCases.sorted(by: { $0.deprecatedRawValue ?? "" < $1.deprecatedRawValue ?? "" }) {
+      if let deprecatedName = syntaxKind.deprecatedRawValue {
+        DeclSyntax(
+          """
+          static var \(raw: deprecatedName): Self {
+            return .\(syntaxKind.varOrCaseName)
+          }
+          """
+        )
+      }
+    }
+  }
+}

Sources/SwiftSyntax/SwiftSyntaxCompatibility.swift

@@ -13,12 +13,6 @@
 // This file provides compatibility aliases to keep dependents of SwiftSyntax building.
 // All users of the declarations in this file should transition away from them ASAP.
 
-@available(*, deprecated, renamed: "ImportPathSyntax")
-public typealias AccessPathSyntax = ImportPathSyntax
-
-@available(*, deprecated, renamed: "ImportPathComponentSyntax")
-public typealias AccessPathComponentSyntax = ImportPathComponentSyntax
-
 extension AttributeSyntax {
   @available(*, deprecated, renamed: "Arguments")
   public typealias Argument = Arguments
@@ -51,12 +45,6 @@ public extension DeclGroupSyntax {
   }
 }
 
-@available(*, deprecated, renamed: "DocumentationAttributeArgumentListSyntax")
-public typealias DocumentationAttributeArgumentsSyntax = DocumentationAttributeArgumentListSyntax
-
-@available(*, deprecated, renamed: "EffectsArgumentListSyntax")
-public typealias EffectsArgumentsSyntax = EffectsArgumentListSyntax
-
 public extension FreestandingMacroExpansionSyntax {
   @available(*, deprecated, renamed: "genericArgumentClause")
   var genericArguments: GenericArgumentClauseSyntax? {
@@ -89,47 +77,16 @@ extension IdentifiedDeclSyntax where Self: NamedDeclSyntax {
   }
 }
 
-@available(*, deprecated, renamed: "ImportPathComponentListSyntax")
-public typealias ImportPathSyntax = ImportPathComponentListSyntax
-
-@available(*, deprecated, renamed: "ObjCSelectorPieceListSyntax")
-public typealias ObjCSelector = ObjCSelectorPieceListSyntax
-
 extension PatternBindingSyntax {
   @available(*, deprecated, renamed: "Accessors")
   public typealias Accessor = Accessors
 }
 
-@available(*, deprecated, renamed: "StringLiteralSegmentListSyntax")
-public typealias StringLiteralSegmentsSyntax = StringLiteralSegmentListSyntax
-
 extension SubscriptDeclSyntax {
   @available(*, deprecated, renamed: "Accessors")
   public typealias Accessor = Accessors
 }
 
-public extension SyntaxKind {
-  static var documentationAttributeArguments: Self {
-    return .documentationAttributeArgumentList
-  }
-
-  static var effectsArguments: Self {
-    return .effectsArgumentList
-  }
-
-  static var importPath: Self {
-    return .importPathComponentList
-  }
-
-  static var objCSelector: Self {
-    return .objCSelectorPieceList
-  }
-
-  static var stringLiteralSegments: Self {
-    return .stringLiteralSegmentList
-  }
-}
-
 public extension SyntaxProtocol {
   @available(*, deprecated, message: "Use detached computed property instead.")
   func detach() -> Self {

Sources/SwiftSyntax/generated/RenamedNodesCompatibility.swift

@@ -0,0 +1,57 @@
+//// Automatically generated by generate-swiftsyntax
+//// Do not edit directly!
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+@available(*, deprecated, renamed: "ImportPathComponentListSyntax")
+public typealias AccessPathSyntax = ImportPathComponentListSyntax
+
+@available(*, deprecated, renamed: "ImportPathComponentSyntax")
+public typealias AccessPathComponentSyntax = ImportPathComponentSyntax
+
+@available(*, deprecated, renamed: "DocumentationAttributeArgumentListSyntax")
+public typealias DocumentationAttributeArgumentsSyntax = DocumentationAttributeArgumentListSyntax
+
+@available(*, deprecated, renamed: "EffectsArgumentListSyntax")
+public typealias EffectsArgumentsSyntax = EffectsArgumentListSyntax
+
+@available(*, deprecated, renamed: "ObjCSelectorPieceListSyntax")
+public typealias ObjCSelectorSyntax = ObjCSelectorPieceListSyntax
+
+@available(*, deprecated, renamed: "StringLiteralSegmentListSyntax")
+public typealias StringLiteralSegmentsSyntax = StringLiteralSegmentListSyntax
+
+public extension SyntaxKind {
+  static var accessPath: Self {
+    return .importPathComponentList
+  }
+  
+  static var accessPathComponent: Self {
+    return .importPathComponent
+  }
+  
+  static var documentationAttributeArguments: Self {
+    return .documentationAttributeArgumentList
+  }
+  
+  static var effectsArguments: Self {
+    return .effectsArgumentList
+  }
+  
+  static var objCSelector: Self {
+    return .objCSelectorPieceList
+  }
+  
+  static var stringLiteralSegments: Self {
+    return .stringLiteralSegmentList
+  }
+}