Make CodeGeneration depend on swift-syntax 509.0.0

Having CodeGeneration depend on a stable version of swift-syntax makes rebasing changes a lot easier because CodeGeneration no longer depends on itself.

Author: ahoppen

CodeGeneration/Package.swift

@@ -3,6 +3,13 @@
 import Foundation
 import PackageDescription
 
+func isOptionEnabled(_ name: String) -> Bool {
+  if let value = ProcessInfo.processInfo.environment[name] {
+    return value == "1" || value == "YES"
+  }
+  return false
+}
+
 let package = Package(
   name: "CodeGeneration",
   platforms: [
@@ -12,17 +19,7 @@ let package = Package(
     .executable(name: "generate-swift-syntax", targets: ["generate-swift-syntax"])
   ],
   dependencies: [
-    // This directory is a standalone package that uses swift-syntax from the
-    // outer directory.
-    // If you are making significant changs to `CodeGeneration` locally and want
-    // to avoid breaking the build of `CodeGeneration` itself by generating new
-    // files in the parent swift-syntax package, it is encouraged to change the
-    // dependency to the following. That way `CodeGeneration` has its own
-    // checkout of swift-syntax that is unaffected by the newly generated files.
-    // Be sure to revert the change before committing your changes.
-    //
-    // .package(url: "https://github.com/apple/swift-syntax", branch: "main")
-    .package(path: "..")
+    .package(url: "https://github.com/apple/swift-syntax", from: "509.0.0")
   ],
   targets: [
     .executableTarget(
@@ -64,7 +61,7 @@ let package = Package(
   ]
 )
 
-if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
+if isOptionEnabled("SWIFTCI_USE_LOCAL_DEPS") {
   // Building standalone.
   package.dependencies += [
     .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.2")

CodeGeneration/README.md

@@ -4,17 +4,6 @@ This directory contains file to generate source code that is part of the SwiftSy
 
 Some source code inside SwiftSyntax is generated using [SwiftSyntaxBuilder](../Sources/SwiftSyntaxBuilder), a Swift library whose purpose is to generate Swift code using Swift itself. This kind of code generation is performed by the Swift package defined in this directory.
 
-This directory is a standalone package that uses swift-syntax from the outer directory. 
-If you are making significant changes to `CodeGeneration` locally and want to avoid breaking the build of `CodeGeneration` itself by generating new files in the parent swift-syntax package, it is encouraged to change the dependency from
-```swift
-.package(path: "..")
-```
-to 
-```swift
-.package(url: "https://github.com/apple/swift-syntax", branch: "main")
-```
-That way `CodeGeneration` has its own checkout of swift-syntax that is unaffected by the newly generated files. Be sure to revert the change before committing your changes.
-
 To re-generate the files after changing `CodeGeneration` run the `generate-swift-syntax` 
 target of `CodeGeneration` and pass `path/to/swift-syntax/Sources` as the argument.
 

CodeGeneration/Sources/generate-swift-syntax/templates/swiftsyntax/RawSyntaxNodesFile.swift

@@ -218,9 +218,9 @@ func rawSyntaxNodesFile(nodesStartingWith: [Character]) -> SourceFileSyntax {
               let list = ExprListSyntax {
                 ExprSyntax("layout.initialize(repeating: nil)")
                 for (index, child) in node.children.enumerated() {
-                  let optionalMark = child.isOptional ? TokenSyntax.postfixQuestionMarkToken() : nil
+                  let optionalMark = child.isOptional ? "?" : ""
 
-                  ExprSyntax("layout[\(raw: index)] = \(child.varOrCaseName.backtickedIfNeeded)\(optionalMark).raw")
+                  ExprSyntax("layout[\(raw: index)] = \(child.varOrCaseName.backtickedIfNeeded)\(raw: optionalMark).raw")
                     .with(\.leadingTrivia, .newline)
                 }
               }
@@ -241,12 +241,12 @@ func rawSyntaxNodesFile(nodesStartingWith: [Character]) -> SourceFileSyntax {
 
           for (index, child) in node.children.enumerated() {
             try VariableDeclSyntax("public var \(child.varOrCaseName.backtickedIfNeeded): Raw\(child.buildableType.buildable)") {
-              let exclamationMark = child.isOptional ? nil : TokenSyntax.exclamationMarkToken()
+              let exclamationMark = child.isOptional ? "" : "!"
 
               if child.syntaxNodeKind == .syntax {
-                ExprSyntax("layoutView.children[\(raw: index)]\(exclamationMark)")
+                ExprSyntax("layoutView.children[\(raw: index)]\(raw: exclamationMark)")
               } else {
-                ExprSyntax("layoutView.children[\(raw: index)].map(\(child.syntaxNodeKind.rawType).init(raw:))\(exclamationMark)")
+                ExprSyntax("layoutView.children[\(raw: index)].map(\(child.syntaxNodeKind.rawType).init(raw:))\(raw: exclamationMark)")
               }
             }
           }

CodeGeneration/Sources/generate-swift-syntax/templates/swiftsyntax/SyntaxTraitsFile.swift

@@ -26,12 +26,12 @@ let syntaxTraitsFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
       """
     ) {
       for child in trait.children {
-        let questionMark = child.isOptional ? TokenSyntax.postfixQuestionMarkToken() : nil
+        let questionMark = child.isOptional ? "?" : ""
 
         DeclSyntax(
           """
           \(child.documentation)
-          \(child.apiAttributes)var \(child.varOrCaseName): \(child.syntaxNodeKind.syntaxType)\(questionMark) { get set }
+          \(child.apiAttributes)var \(child.varOrCaseName): \(child.syntaxNodeKind.syntaxType)\(raw: questionMark) { get set }
           """
         )
       }

Package.swift

@@ -5,29 +5,32 @@ import PackageDescription
 
 // MARK: - Parse build arguments
 
-func hasEnvironmentVariable(_ name: String) -> Bool {
-  return ProcessInfo.processInfo.environment[name] != nil
+func isOptionEnabled(_ name: String) -> Bool {
+  if let value = ProcessInfo.processInfo.environment[name] {
+    return value == "1" || value == "YES"
+  }
+  return false
 }
 
 /// Set when building swift-syntax using swift-syntax-dev-utils or in Swift CI in general.
 ///
 /// Modifies the build in the following ways
 ///  - Enables assertions even in release builds
 ///  - Removes the dependency of swift-syntax on os_log
-let buildScriptEnvironment = hasEnvironmentVariable("SWIFT_BUILD_SCRIPT_ENVIRONMENT")
+let buildScriptEnvironment = isOptionEnabled("SWIFT_BUILD_SCRIPT_ENVIRONMENT")
 
 /// Check that the layout of the syntax tree is correct.
 ///
 /// See CONTRIBUTING.md for more information
-let rawSyntaxValidation = hasEnvironmentVariable("SWIFTSYNTAX_ENABLE_RAWSYNTAX_VALIDATION")
+let rawSyntaxValidation = isOptionEnabled("SWIFTSYNTAX_ENABLE_RAWSYNTAX_VALIDATION")
 
 /// Mutate the input of `assertParse` test cases.
 ///
 /// See CONTRIBUTING.md for more information
-let alternateTokenIntrospection = hasEnvironmentVariable("SWIFTPARSER_ENABLE_ALTERNATE_TOKEN_INTROSPECTION")
+let alternateTokenIntrospection = isOptionEnabled("SWIFTPARSER_ENABLE_ALTERNATE_TOKEN_INTROSPECTION")
 
 /// Assume that swift-argument-parser is checked out next to swift-syntax and use that instead of fetching a remote dependency.
-let useLocalDependencies = hasEnvironmentVariable("SWIFTCI_USE_LOCAL_DEPS")
+let useLocalDependencies = isOptionEnabled("SWIFTCI_USE_LOCAL_DEPS")
 
 // MARK: - Compute custom build settings
 

Sources/SwiftParser/generated/ExperimentalFeatures.swift

@@ -25,14 +25,14 @@ extension Parser {
 
 extension Parser.ExperimentalFeatures {
   /// Whether to enable the parsing of reference bindings.
-  public static let referenceBindings = Self(rawValue: 1 << 0)
+  public static let referenceBindings = Self (rawValue: 1 << 0)
 
   /// Whether to enable the parsing of 'then' statements.
-  public static let thenStatements = Self(rawValue: 1 << 1)
+  public static let thenStatements = Self (rawValue: 1 << 1)
 
   /// Whether to enable the parsing of typed throws.
-  public static let typedThrows = Self(rawValue: 1 << 2)
+  public static let typedThrows = Self (rawValue: 1 << 2)
 
   /// Whether to enable the parsing of 'do' expressions.
-  public static let doExpressions = Self(rawValue: 1 << 3)
+  public static let doExpressions = Self (rawValue: 1 << 3)
 }

SwiftSyntaxDevUtils/Sources/swift-syntax-dev-utils/common/SourceCodeGeneratorCommand.swift

@@ -35,6 +35,7 @@ extension SourceCodeGeneratorCommand {
     let additionalEnvironment = [
       "SWIFT_BUILD_SCRIPT_ENVIRONMENT": "1",
       "SWIFTSYNTAX_ENABLE_RAWSYNTAX_VALIDATION": "1",
+      "SWIFTCI_USE_LOCAL_DEPS": "0",
     ]
 
     let process = ProcessRunner(