Merge pull request #1041 from CodaFi/manticore

Recore deprecated SwiftSyntaxParser on top of SwiftParser

Author: CodaFi

Changelog.md

@@ -4,6 +4,10 @@ Note: This is in reverse chronological order, so newer entries are added to the
 
 ## `main`
 
+* With the introduction of the new `SwiftParser`, the existing `SwiftSyntaxParser` is deprecated and will be removed. The module and it's API surface still exists as a thin wrapper over `SwiftParser`, which no longer requires a matching toolchain or `_InternalSwiftSyntaxParser` shared library to work.
+
+## Swift 5.6
+
 * To clarify that the edits passed to `IncrementalParseTransition` are applied concurrently, introduce a new `ConcurrentEdit` type that provides the guarantee and allows translation of sequentially applied edits to the expected concurrent form.
 * The `SwiftSyntaxParser` type and a few related types now live in their own module (also named `SwiftSyntaxParser`). This allows using `SwiftSyntax` for code generation purposes without having a compatible `_InternalSwiftSyntaxParser.dylib` around. 
 
@@ -86,7 +90,7 @@ Note: This is in reverse chronological order, so newer entries are added to the
     /* ... */
   }
   ```
- 
+
 
 ### Modelling syntax nodes as structs
 

Documentation/Create SwiftSyntax Release.md

@@ -2,74 +2,11 @@
 
 ## Create release tag
 1. Check out the tag you want to release in the SwiftSyntax repository
-2. Download the matching Swift release from <https://swift.org> and install it
-3. Create an `.xcframework` by running 
-```bash
-xcodebuild -create-xcframework -library /Library/Developer/Toolchains/<toolchain-name>.xctoolchain/usr/lib/swift/macosx/lib_InternalSwiftSyntaxParser.dylib -output _InternalSwiftSyntaxParser.xcframework
-```
-4. Zip up the framework
-```bash
-zip -r _InternalSwiftSyntaxParser.xcframework.zip _InternalSwiftSyntaxParser.xcframework
-```
-5. Compute the checksum for the generated `.xcframework.zip`
-```bash
-/Library/Developer/Toolchains/<toolchain-name>.xctoolchain/usr/bin/swift package --package-path /path/to/swift-syntax/ compute-checksum _InternalSwiftSyntaxParser.xcframework.zip
-```
-6. Apply the following diff to `Package.swift`, adjusting `<release tag>` and `<checksum>`
-```diff
-diff --git a/Package.swift b/Package.swift
-index 4c6db83a..7a953fc6 100644
---- a/Package.swift
-+++ b/Package.swift
-@@ -23,6 +23,21 @@ if ProcessInfo.processInfo.environment["SWIFT_BUILD_SCRIPT_ENVIRONMENT"] != nil
-   swiftSyntaxSwiftSettings = []
- }
- 
-+// Include the parser library as a binary dependency if both the host and the target are macOS.
-+//  - We need to require that the host is macOS (checked by `#if os(macOS)`) because package resolve will download and unzip the referenced framework, which requires `unzip` to be installed. Only macOS guarantees that `unzip` is installed, the Swift Docker images don’t have unzip installed, so package resolve would fail.
-+//  - We need to require that the target is macOS (checked by `.when`) because binary dependencies are only supported by SwiftPM on macOS.
-+#if os(macOS)
-+let parserLibraryTarget: [Target] = [.binaryTarget(
-+  name: "_InternalSwiftSyntaxParser",
-+  url: "https://github.com/apple/swift-syntax/releases/download/<release tag>/_InternalSwiftSyntaxParser.xcframework.zip",
-+  checksum: "<checksum>"
-+)]
-+let parserLibraryDependency: [Target.Dependency] = [.target(name: "_InternalSwiftSyntaxParser", condition: .when(platforms: [.macOS]))]
-+#else
-+let parserLibraryTarget: [Target] = []
-+let parserLibraryDependency: [Target.Dependency] = []
-+#endif
-+
- let package = Package(
-   name: "SwiftSyntax",
-   products: [
-@@ -65,7 +80,7 @@ let package = Package(
-         "Tokens.swift.gyb",
-       ]
-     ),
--    .target(name: "SwiftSyntaxParser", dependencies: ["SwiftSyntax"], exclude: [
-+    .target(name: "SwiftSyntaxParser", dependencies: ["SwiftSyntax"] + parserLibraryDependency, exclude: [
-       "NodeDeclarationHash.swift.gyb"
-     ]),
-     .target(
-@@ -90,5 +105,5 @@ let package = Package(
-       dependencies: ["SwiftSyntax", "SwiftSyntaxParser"],
-       exclude: ["Inputs"]
-     ),
--  ]
-+  ] + parserLibraryTarget
- )
-```
-7. Commit the changes
-8. Create a tag and push it to your personal GitHub repository
-9. On your personal GitHub repo create new release, select the tag, name it and upload `_InternalSwiftSyntaxParser.xcframework.zip`
-
 ## Smoke test on macOS
 
 1. Change the binary target in `Package.swift` to point to your personal GitHub repo
-2. Open the SwiftSyntax package with an Xcode version that contains no or an incompatible parser library
-3. Update to Latest Package Versions in Xcode
-4. Run tests
+2. Update to Latest Package Versions in Xcode
+3. Run tests
 
 ## Smoke test on Linux
 
@@ -83,7 +20,7 @@ index 4c6db83a..7a953fc6 100644
 ## Publish Release
 
 1. Push tag to apple/swift-syntax
-2. On apple/swift-syntax create a new release using the just-pushed tag and upload the parser library as `_InternalSwiftSyntaxParser.xcframework.zip`
+2. On apple/swift-syntax create a new release using the just-pushed tag
 3. If this is a snapshot release, check “This is a pre-release”
 4. Publish 🎉
 5. Add the new release to README.md

Documentation/README.md

@@ -2,71 +2,20 @@
 
 ## Usage
 
-### Declare SwiftPM dependency with nightly build
-
-1. Download and install the latest Trunk Development [toolchain](https://swift.org/download/#snapshots).
-
-2. Define the `TOOLCHAINS` environment variable as below to have the `swift` command point inside the toolchain:
-    ```bash
-    $ export TOOLCHAINS=swift
-    ```
-
-3. To make sure everything is set up correctly, check the result of `xcrun --find swift`. It should point inside the OSS toolchain.
-
-4. Add this entry to the `Package.swift` manifest of your project:
-
-    ```swift
-    // swift-tools-version:5.3
-    import PackageDescription
-
-    let package = Package(
-      name: "MyTool",
-      dependencies: [
-        .package(url: "https://github.com/apple/swift-syntax.git", .revision("swift-DEVELOPMENT-SNAPSHOT-2019-02-26")),
-      ],
-      targets: [
-        .target(name: "MyTool", dependencies: ["SwiftSyntax"]),
-      ]
-    )
-    ```
-
-Tags will be created for every nightly build in the form of `swift-DEVELOPMENT-SNAPSHOT-<DATE>`. The revision field
-should be specified with the intended tag.
-
-Different from building SwiftSyntax from source, declaring SwiftSyntax as a SwiftPM dependency doesn't require
-the Swift compiler source because we always push gyb-generated files to a tag.
-
-### Embedding SwiftSyntax in an Application
-
-SwiftSyntax depends on the `lib_InternalSwiftSyntaxParser.dylib/.so` library which provides a C interface to the underlying Swift C++ parser. When you do `swift build` SwiftSyntax links and uses the library included in the Swift toolchain. If you are building an application make sure to embed `_InternalSwiftSyntaxParser` as part of your application's libraries.
-
-You can either copy `lib_InternalSwiftSyntaxParser.dylib/.so` directly from the toolchain or even build it yourself from the [Swift repository](https://github.com/apple/swift), as long as you are matching the same tags or branches in both the SwiftSyntax and Swift repositories. To build it for the host os (macOS/linux) use the following steps:
-
-```bash
-git clone https://github.com/apple/swift.git
-./swift/utils/update-checkout --clone
-./swift/utils/build-tooling-libs --release --no-assertions --build-dir /tmp/tooling-libs-build
-```
-
-If you see an error similar to the following:
-
-```
-Outdated Swift compiler: building with host tools requires Swift 5.8 or
-newer.  Please update your Swift toolchain or switch BOOTSTRAPPING_MODE to
-BOOTSTRAPPING(-WITH-HOSTLIBS)? or OFF.
+Add this entry to the `Package.swift` manifest of your project:
+
+```swift
+// swift-tools-version:5.3
+import PackageDescription
+
+let package = Package(
+  name: "MyTool",
+  dependencies: [
+    .package(url: "https://github.com/apple/swift-syntax.git", .branch("main")),
+  ],
+  targets: [
+    .target(name: "MyTool", dependencies: ["SwiftSyntax"]),
+  ]
+)
 ```
 
-then you will need to build a newer compiler from source or download a more recent development snapshot from https://swift.org and pass its path to the script using the `--swiftc` flag:
-
-```bash
-./swift/utils/build-tooling-libs --release --no-assertions --build-dir /tmp/tooling-libs-build --swiftc /path/to/newer/swiftc
-```
-
-### Embedding in an iOS Application
-
-You need to build `lib_InternalSwiftSyntaxParser.dylib` yourself, you cannot copy it from the toolchain. Follow the instructions above and change the invocation of `build-tooling-libs` accordingly:
-
-```bash
-./swift/utils/build-tooling-libs --release --no-assertions --build-dir /tmp/tooling-libs-build-iossim --host iphonesimulator --architectures x86_64
-./swift/utils/build-tooling-libs --release --no-assertions --build-dir /tmp/tooling-libs-build-ios --host iphoneos --architectures arm64
-```

Package.swift

@@ -22,19 +22,6 @@ if ProcessInfo.processInfo.environment["SWIFT_BUILD_SCRIPT_ENVIRONMENT"] != nil
   swiftSyntaxSwiftSettings = []
 }
 
-/// If the `lib_InternalSwiftSyntaxParser.dylib` is not in the standard search
-/// paths (which is the standard case on macOS),
-/// `SWIFT_SYNTAX_PARSER_LIB_SEARCH_PATH` can be used to add a rpath at which
-/// the parser lib should be searched.
-let swiftSyntaxParserLinkerSettings: [LinkerSetting]
-if let parserLibSearchPath = ProcessInfo.processInfo.environment["SWIFT_SYNTAX_PARSER_LIB_SEARCH_PATH"] {
-  swiftSyntaxParserLinkerSettings = [.unsafeFlags([
-    "-Xlinker", "-rpath", "-Xlinker", parserLibSearchPath
-  ])]
-} else {
-  swiftSyntaxParserLinkerSettings = []
-}
-
 let package = Package(
   name: "SwiftSyntax",
   platforms: [
@@ -105,12 +92,7 @@ let package = Package(
     ),
     .target(
       name: "SwiftSyntaxParser",
-      dependencies: ["SwiftSyntax"],
-      exclude: [
-        "NodeDeclarationHash.swift.gyb",
-        "Serialization.swift.gyb",
-      ],
-      linkerSettings: swiftSyntaxParserLinkerSettings
+      dependencies: ["SwiftSyntax", "SwiftParser"]
     ),
     .target(
       name: "_SwiftSyntaxTestSupport",