Merge remote-tracking branch 'origin_apple/main' into detect-missing-comma-in-tupel

# Conflicts:
#	Tests/SwiftParserTest/Types.swift
#	Tests/SwiftParserTest/translated/InvalidTests.swift

Author: flashspys

CONTRIBUTING.md

@@ -23,9 +23,9 @@ Alternatively you can also build it from the command line using `build-script.py
 
 Because of SwiftSyntax’s integration with the Swift compiler project, testing certain parts of the project is a little bit more involved than others. 
 
-The `SwiftParser` tests have no depdendencies, other `XCTests` require you to use a matching Swift Development Snapshot, `lit`-based test require a compiler build.
+The `SwiftParser` tests have no dependencies, other `XCTests` require you to use a matching Swift Development Snapshot, `lit`-based test require a compiler build.
 
-Run the tests that you belive are necessary locally. CI will always run all test before allowing the PR to be merged.
+Run the tests that you believe are necessary locally. CI will always run all test before allowing the PR to be merged.
 
 ### SwiftParser
 
@@ -39,7 +39,7 @@ The `SwiftSyntaxParser` module (the legacy parser) of this repository depends on
 The syntax node definitions of that parser library need to match those used by your SwiftSyntax checkout.
 Most of the time, the parser library included in the latest Swift Development Snapshot will fulfill this requirement. 
 
-To run the tests in Xcode, select the latest Swift Development Snapshot in Xcode -> Toolchains, select the SwiftSyntax-Package scheme and hit Prodcut -> Test.
+To run the tests in Xcode, select the latest Swift Development Snapshot in Xcode -> Toolchains, select the SwiftSyntax-Package scheme and hit Product -> Test.
 
 You can also run the tests from the command line using
 ```bash
@@ -51,7 +51,7 @@ If you are seeing issues regarding a mismatched parser library, try the followin
 2. Revert your swift-syntax checkout to the date of your Swift Development Snapshot
 3. Wait for a new Swift Development Snapshot
 4. If the above options are not possible, build your own Swift toolchain locally and use that toolchain as the `--toolchain` parameter for SwiftSyntax’s `build-script.py` invocations
-  - Note: Building your own toolchain will take more than 1 hour and even longer if you are running into any issues. We do not recomment building your own Swift toolchain unless you are familiar with Swift compiler development.
+  - Note: Building your own toolchain will take more than 1 hour and even longer if you are running into any issues. We do not recommend building your own Swift toolchain unless you are familiar with Swift compiler development.
 
 Tip: Running SwiftSyntax’s self-parse tests takes the majority of testing time. If you want to iterate quickly, you can skip these tests using the following steps:
 1. Product -> Scheme -> Edit Scheme…

CodeGeneration/Sources/SyntaxSupport/gyb_generated/CommonNodes.swift

@@ -127,7 +127,7 @@ public let COMMON_NODES: [Node] = [
        elementsSeparatedByNewline: true),
 
   Node(name: "CodeBlock",
-       nameForDiagnostics: nil,
+       nameForDiagnostics: "code block",
        kind: "Syntax",
        traits: [
          "Braced",

CodeGeneration/Sources/SyntaxSupport/gyb_generated/DeclNodes.swift

@@ -637,7 +637,7 @@ public let DECL_NODES: [Node] = [
        ]),
 
   Node(name: "MemberDeclBlock",
-       nameForDiagnostics: nil,
+       nameForDiagnostics: "member block",
        kind: "Syntax",
        traits: [
          "Braced"
@@ -1258,7 +1258,7 @@ public let DECL_NODES: [Node] = [
        ]),
 
   Node(name: "OperatorDecl",
-       nameForDiagnostics: "operator",
+       nameForDiagnostics: "operator declaration",
        description: "A Swift `operator` declaration.",
        kind: "Decl",
        traits: [

CodeGeneration/Sources/SyntaxSupport/gyb_generated/GenericNodes.swift

@@ -145,6 +145,12 @@ public let GENERIC_NODES: [Node] = [
                tokenChoices: [
                  "Identifier"
                ]),
+         Child(name: "Ellipsis",
+               kind: "EllipsisToken",
+               isOptional: true,
+               tokenChoices: [
+                 "Ellipsis"
+               ]),
          Child(name: "Colon",
                kind: "ColonToken",
                isOptional: true,

CodeGeneration/Sources/generate-swiftsyntaxbuilder/BuildableCollectionNodesFile.swift

@@ -98,17 +98,11 @@ let buildableCollectionNodesFile = SourceFile {
   }
 }
 
-/// Generate an initializer taking an array of elements.
-private func createArrayInitializer(node: Node) -> InitializerDecl {
-  let type = node.type
-  let elementType = node.collectionElementType
-  var elementsInit: ExprBuildable = IdentifierExpr("elements")
-  if !elementType.isToken {
-    elementsInit = FunctionCallExpr(
-      calledExpression: MemberAccessExpr(base: elementsInit, name: "map"),
-      trailingClosure: ClosureExpr(" { $0.create\(elementType.buildableBaseName)() }")
-    )
-  }
+/// Helper for generating an initializer taking an array of elements.
+private func createArrayInitializer<ElementsInit: ExprBuildable>(
+  type: SyntaxBuildableType, elementType: SyntaxBuildableType,
+  elementsInit: ElementsInit
+) -> InitializerDecl {
   return InitializerDecl(
     """
     /// Creates a `\(type.buildableBaseName)` with the provided list of elements.
@@ -121,6 +115,26 @@ private func createArrayInitializer(node: Node) -> InitializerDecl {
   )
 }
 
+/// Generate an initializer taking an array of elements.
+private func createArrayInitializer(node: Node) -> InitializerDecl {
+  let type = node.type
+  let elementType = node.collectionElementType
+  let elementsInit = IdentifierExpr("elements")
+  if elementType.isToken {
+    return createArrayInitializer(
+      type: type, elementType: elementType, elementsInit: elementsInit
+    )
+  }
+
+  let elementsInitCall = FunctionCallExpr(
+    calledExpression: MemberAccessExpr(base: elementsInit, name: "map"),
+    trailingClosure: ClosureExpr(" { $0.create\(elementType.buildableBaseName)() }")
+  )
+  return createArrayInitializer(
+    type: type, elementType: elementType, elementsInit: elementsInitCall
+  )
+}
+
 /// Generate a flattening initializer taking an array of collections.
 private func createCombiningInitializer(node: Node) -> InitializerDecl {
   let type = node.type

Documentation/SwiftParser.md

@@ -2,4 +2,4 @@
 
 Documentation on the Swift parser can be found in [Sources/SwiftParser/SwiftParser.docc](../Sources/SwiftParser/SwiftParser.docc).
 
-You can either directly view this documentation on GitHub or build a documenation bundle by opening the project in Xcode and clicking Product -> Build Documentation
+You can either directly view this documentation on GitHub or build a documentation bundle by opening the project in Xcode and clicking Product -> Build Documentation

Package.swift

@@ -97,6 +97,7 @@ let package = Package(
       dependencies: ["SwiftBasicFormat", "SwiftSyntax", "SwiftParser"],
       exclude: [
         "gyb_helpers",
+        "SyntaxExpressibleByStringInterpolationConformances.swift.gyb",
       ]
     ),
     .target(
@@ -125,7 +126,10 @@ let package = Package(
     ),
     .target(
       name: "SwiftOperators",
-      dependencies: ["SwiftSyntax", "SwiftParser", "SwiftDiagnostics"]
+      dependencies: ["SwiftSyntax", "SwiftParser", "SwiftDiagnostics"],
+      exclude: [
+        "CMakeLists.txt",
+      ]
     ),
     .target(
       name: "SwiftCompilerSupport",
@@ -142,13 +146,12 @@ let package = Package(
     ),
     .executableTarget(
       name: "swift-parser-cli",
-      dependencies: ["_SwiftSyntaxTestSupport", "SwiftDiagnostics",
-                     "SwiftSyntax", "SwiftParser", "SwiftOperators",
+      dependencies: ["SwiftDiagnostics", "SwiftSyntax", "SwiftParser", "SwiftOperators",
                      .product(name: "ArgumentParser", package: "swift-argument-parser")]
     ),
     .testTarget(
       name: "SwiftDiagnosticsTest",
-      dependencies: ["SwiftDiagnostics", "SwiftParser"]
+      dependencies: ["_SwiftSyntaxTestSupport", "SwiftDiagnostics", "SwiftParser"]
     ),
     .testTarget(
       name: "SwiftSyntaxTest",

README.md

@@ -1,21 +1,49 @@
 # SwiftSyntax
 
-SwiftSyntax is a set of Swift bindings for the
-[libSyntax](https://github.com/apple/swift/tree/main/lib/Syntax) library. It
-allows Swift tools to parse, inspect, generate, and transform Swift source
-code.
+SwiftSyntax is a set of Swift libraries for parsing, inspecting, generating, and transforming Swift source code.
 
-Its API is designed for performance-critical applications. It uses value types almost exclusively and aims to avoid existential conversions where possible.
+> Note: SwiftSyntax is still in development, and its API is not guaranteed to
+> be stable. It is subject to change without warning.
 
-> Note: SwiftSyntax is still in development, and the API is not guaranteed to
-> be stable. It's subject to change without warning.
+## Adding SwiftSyntax as a Dependency
 
-## Declare SwiftPM dependency with release tag
+### Trunk Development (main)
 
-Add this repository to the `Package.swift` manifest of your project:
+The mainline branch of SwiftSyntax tracks the latest developments. It is not
+an official release, and is subject to rapid changes in APIs and behaviors. To 
+use it, add this repository to the `Package.swift` manifest of your project:
 
 ```swift
-// swift-tools-version:5.6
+// swift-tools-version:5.7
+import PackageDescription
+
+let package = Package(
+  name: "MyTool",
+  dependencies: [
+    .package(url: "https://github.com/apple/swift-syntax.git", branch: "main"),
+  ],
+  targets: [
+    .target(name: "MyTool", dependencies: [
+      .product(name: "SwiftSyntax", package: "swift-syntax"),
+    ]),
+  ]
+)
+```
+
+Mainline SwiftSyntax also includes 
+
+- `SwiftParser` for natively parsing source code
+- `SwiftOperators` for folding SwiftSyntax trees containing operators
+- `SwiftSyntaxBuilder` for generating Swift code with a result builder-style interface
+
+### Releases
+
+Releases of SwiftSyntax are aligned with corresponding language
+and tooling releases and are stable. To use them, 
+add this repository to the `Package.swift` manifest of your project:
+
+```swift
+// swift-tools-version:5.7
 import PackageDescription
 
 let package = Package(
@@ -42,13 +70,11 @@ Replace `<#Specify Release tag#>` by the version of SwiftSyntax that you want to
 | Xcode 12.0   | swift-5.3-RELEASE   | 0.50300.0 |
 | Xcode 11.4   | swift-5.2-RELEASE   | 0.50200.0 |
 
-Then, import `SwiftSyntax` in your Swift code.
-
 ## Documentation
 
 Documentation can be found in the following places:
 - For the parser: [Sources/SwiftParser/SwiftParser.docc](Sources/SwiftParser/SwiftParser.docc) 
-  - You can either directly view this documentation on GitHub or build a documenation bundle by opening the project in Xcode and clicking Product -> Build Documentation
+  - You can either directly view this documentation on GitHub or build a documentation bundle by opening the project in Xcode and clicking Product -> Build Documentation
 - General documentation: [Documentation](Documentation) 
 - Examples of using SwiftSyntax: [Examples](Examples).
 
@@ -62,4 +88,4 @@ If you should hit any issues while using SwiftSyntax, we appreciate bug reports
 
 ## License
 
- Please see [LICENSE](LICENSE.txt) for more information.
+Please see [LICENSE](LICENSE.txt) for more information.

Sources/SwiftBasicFormat/generated/BasicFormat.swift

@@ -2304,13 +2304,15 @@ open class BasicFormat: SyntaxRewriter {
     let attributes = node.attributes.map(self.visit)?.cast(AttributeListSyntax.self)
     let unexpectedBetweenAttributesAndName = node.unexpectedBetweenAttributesAndName.map(self.visit)?.cast(UnexpectedNodesSyntax.self)
     let name = self.visit(node.name).cast(TokenSyntax.self)
-    let unexpectedBetweenNameAndColon = node.unexpectedBetweenNameAndColon.map(self.visit)?.cast(UnexpectedNodesSyntax.self)
+    let unexpectedBetweenNameAndEllipsis = node.unexpectedBetweenNameAndEllipsis.map(self.visit)?.cast(UnexpectedNodesSyntax.self)
+    let ellipsis = node.ellipsis.map(self.visit)?.cast(TokenSyntax.self)
+    let unexpectedBetweenEllipsisAndColon = node.unexpectedBetweenEllipsisAndColon.map(self.visit)?.cast(UnexpectedNodesSyntax.self)
     let colon = node.colon.map(self.visit)?.cast(TokenSyntax.self)
     let unexpectedBetweenColonAndInheritedType = node.unexpectedBetweenColonAndInheritedType.map(self.visit)?.cast(UnexpectedNodesSyntax.self)
     let inheritedType = node.inheritedType.map(self.visit)?.cast(TypeSyntax.self)
     let unexpectedBetweenInheritedTypeAndTrailingComma = node.unexpectedBetweenInheritedTypeAndTrailingComma.map(self.visit)?.cast(UnexpectedNodesSyntax.self)
     let trailingComma = node.trailingComma.map(self.visit)?.cast(TokenSyntax.self)
-    return Syntax(GenericParameterSyntax(unexpectedBeforeAttributes, attributes: attributes, unexpectedBetweenAttributesAndName, name: name, unexpectedBetweenNameAndColon, colon: colon, unexpectedBetweenColonAndInheritedType, inheritedType: inheritedType, unexpectedBetweenInheritedTypeAndTrailingComma, trailingComma: trailingComma))
+    return Syntax(GenericParameterSyntax(unexpectedBeforeAttributes, attributes: attributes, unexpectedBetweenAttributesAndName, name: name, unexpectedBetweenNameAndEllipsis, ellipsis: ellipsis, unexpectedBetweenEllipsisAndColon, colon: colon, unexpectedBetweenColonAndInheritedType, inheritedType: inheritedType, unexpectedBetweenInheritedTypeAndTrailingComma, trailingComma: trailingComma))
   }
 
   open override func visit(_ node: PrimaryAssociatedTypeListSyntax) -> Syntax {

Sources/SwiftOperators/SwiftOperators.docc/SwiftOperators.md

@@ -45,7 +45,7 @@ import SwiftParser
 import SwiftOperators
 
 var opPrecedence = OperatorTable.standardOperators // Use the Swift standard library operators
-let parsed = try Parser.parse(source: "x + y * z")
+let parsed = Parser.parse(source: "x + y * z")
 dump(parsed) // contains SequenceExprSyntax(x, +, y, *, z)
 let folded = try opPrecedence.foldAll(parsed)
 dump(folded) // contains InfixOperatorExpr(x, +, InfixOperatorExpr(y, *, z))
@@ -65,12 +65,12 @@ let moreOperators =
 
   infix operator **: ExponentiationPrecedence
   """
-let parsedOperators = try Parser.parse(source: moreOperators)
+let parsedOperators = Parser.parse(source: moreOperators)
 
 // Adds **, ExponentiationPrecedence to the set of known operators and precedence groups.
 try opPrecedence.addSourceFile(parsedOperators) 
 
-let parsed2 = try Parser.parse(source: "b ** c ** d")
+let parsed2 = Parser.parse(source: "b ** c ** d")
 dump(parsed2) // contains SequenceExprSyntax(b, **, c, **, d)
 let folded2 = try opPrecedence.foldAll(parsed2)
 dump(folded2) // contains InfixOperatorExpr(b, **, InfixOperatorExpr(c, **, d))