Merge branch 'develop'

mobrien-ghost · mobrien-ghost · commit fc769daaff92 · 2024-10-23T21:06:25.000+10:00
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
@@ -1,4 +1,3 @@
-
 # This workflow uses actions that are not certified by GitHub.
 # They are provided by a third-party and are governed by
 # separate terms of service, privacy policy, and support
@@ -23,49 +22,64 @@ on:
         - '*' # Push events to every tag
 
 jobs:
-  swift_tests:
-    name: Swift Version ${{ matrix.swift }}
-    strategy:
-      matrix:
-        os: [macos-13]
-        swift: ["5.9", "5.8", "5.7"]
-    runs-on: ${{ matrix.os }}
+  swift_tests_latest:
+    name: Latest Swift
+    runs-on: macos-15
     steps:
-      - uses: swift-actions/setup-swift@v1
+      - uses: maxim-lobanov/setup-xcode@v1
         with:
-          swift-version: ${{ matrix.swift }}
+          xcode-version: "16.0"
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: .build
+          key: macos-latest-spm-${{ hashFiles('**/Package.resolved') }}
+          restore-keys: |
+            macos-latest-spm-
+      - name: Build
+        run: swift build
+      - name: Run tests
+        run: swift test
+  swift_tests_previous:
+    name: Swift 5.10
+    runs-on: macos-14
+    steps:
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: "14.3.1"
+          xcode-version: "15.0"
       - uses: actions/checkout@v3
       - uses: actions/cache@v3
         with:
           path: .build
-          key: ${{ matrix.os }}-spm-${{ hashFiles('**/Package.resolved') }}
+          key: macos-14-swift-510-spm-${{ hashFiles('**/Package.resolved') }}
           restore-keys: |
-            ${{ matrix.os }}-spm-
+            macos-14-swift-510-spm-
       - name: Build
         run: swift build
       - name: Run tests
         run: swift test
-
-  ios_tests:
-    name: iOS Unit Tests
-    runs-on: macos-13
+  swift_tests_legacy:
+    name: Swift ${{ matrix.swift }}
+    strategy:
+      matrix:
+        os: [macos-13]
+        swift: ["5.9", "5.8"]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: swift-actions/setup-swift@v1
         with:
-          swift-version: 5.9
+          swift-version: ${{ matrix.swift }}
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: "14.3.1"
       - uses: actions/checkout@v3
       - uses: actions/cache@v3
         with:
           path: .build
-          key: ${{ matrix.os }}-spm-${{ hashFiles('**/Package.resolved') }}
+          key: ${{ matrix.os }}-${{ matrix.swift }}-spm-${{ hashFiles('**/Package.resolved') }}
           restore-keys: |
             ${{ matrix.os }}-spm-
-
       - name: Build
-        run: xcodebuild build -scheme SyntaxSparrow -destination "OS=17.2,name=iPhone 13"
-
-      - name: Test
-        run: xcodebuild test-without-building -scheme SyntaxSparrow -destination "name=iPhone 13" -enableCodeCoverage YES
+        run: swift build
+      - name: Run tests
+        run: swift test
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -1,4 +1,4 @@
-// swift-tools-version: 5.9
+// swift-tools-version: 6.0
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -20,7 +20,7 @@ let package = Package(
         ),
     ],
     dependencies: [
-        .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "510.0.1"),
+        .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "600.0.1"),
     ],
     targets: [
         .target(
@@ -31,6 +31,9 @@ let package = Package(
             ],
             resources: [
                 .copy("Resources/PrivacyInfo.xcprivacy")
+            ],
+            swiftSettings: [
+                .swiftLanguageMode(.v6)
             ]
         ),
         .testTarget(
diff --git a/Package@swift-5.10.swift b/Package@swift-5.10.swift
@@ -0,0 +1,48 @@
+// swift-tools-version: 5.10
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "SyntaxSparrow",
+    platforms: [
+        .macOS(.v10_15),
+        .iOS(.v13),
+        .tvOS(.v13),
+        .watchOS(.v6),
+        .macCatalyst(.v13)
+    ],
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "SyntaxSparrow",
+            targets: ["SyntaxSparrow"]
+        ),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "600.0.1"),
+    ],
+    targets: [
+        .target(
+            name: "SyntaxSparrow",
+            dependencies: [
+                .product(name: "SwiftSyntax", package: "swift-syntax"),
+                .product(name: "SwiftParser", package: "swift-syntax"),
+            ],
+            resources: [
+                .copy("Resources/PrivacyInfo.xcprivacy")
+            ]
+        ),
+        .testTarget(
+            name: "SyntaxSparrowTests",
+            dependencies: [
+                "SyntaxSparrow",
+            ]
+        ),
+    ]
+)
+
+// Supplementary
+package.dependencies.append(contentsOf: [
+    .package(url: "https://github.com/SwiftPackageIndex/SPIManifest.git", from: "0.12.0"),
+])
diff --git a/Package@swift-5.8.swift b/Package@swift-5.8.swift
@@ -20,7 +20,7 @@ let package = Package(
         ),
     ],
     dependencies: [
-        .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "510.0.1"),
+        .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "600.0.1"),
     ],
     targets: [
         .target(
diff --git a/Package@swift-5.9.swift b/Package@swift-5.9.swift
@@ -1,4 +1,4 @@
-// swift-tools-version: 5.7
+// swift-tools-version: 5.9
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -20,7 +20,7 @@ let package = Package(
         ),
     ],
     dependencies: [
-        .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "510.0.1"),
+        .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "600.0.1"),
     ],
     targets: [
         .target(
diff --git a/README.md b/README.md
@@ -26,6 +26,15 @@ SyntaxSparrow is a Swift library designed to facilitate the analysis and interac
 - [License](#license)
 - [Contributing](#contributing)
 
+## Swift 6 Support
+SyntaxSparrow added explicit support for Swift 6 (and the Swift 6 language mode) as of version `5.0.0`. It is still compatible back to Swift 5.8, however, the package manifests for version 5.8, 5.9, and 5.10 do not include the explicit swift 6 language mode setting.
+
+## Note on Swift 5.7 Support
+
+The latest version of the underlying [swift-syntax](https://github.com/swiftlang/swift-syntax) library no longer supports swift 5.7, as such, Syntax Sparrow will stop active support for Swift 5.7 from version 5.0.0
+
+If you need support for 5.7, and specifically want features added after the 5.0.0 bump, you may need to fork the repo and add support yourself. If there is a backwards compatible change that can be captured as a minor update we will gladly release it via the PR process. However, if there are changes resulting in a major bump with 5.7 support, we would like to look at an alternate release process for that version (or let you maintain it on your own fork).
+
 ## About the Project
 SyntaxSparrow was built on heavy inspiration from the now archived [SwiftSemantics](https://github.com/SwiftDocOrg/SwiftSemantics) project. `SwiftSemantics` was awesome, but being archived the only option is to fork and add features yourself, or hope someone has added your feature to their fork. `SyntaxSparrow` aims to pick up where this left off and add more support for conveniences, features, and harden parsing where needed.
 
@@ -336,7 +345,7 @@ Currently, SyntaxSparrow supports Swift Package Manager (SPM).
 To add SyntaxSparrow to your project, add the following line to your dependencies in your Package.swift file:
 
 ```swift
-.package(url: "https://github.com/CheekyGhost-Labs/SyntaxSparrow", from: "4.3.0")
+.package(url: "https://github.com/CheekyGhost-Labs/SyntaxSparrow", from: "5.0.0")
 ```
 
 Then, add SyntaxSparrow as a dependency for your target:
diff --git a/Sources/SyntaxSparrow/Internal/Extensions/SyntaxChildren+InOut.swift b/Sources/SyntaxSparrow/Internal/Extensions/SyntaxChildren+InOut.swift
@@ -0,0 +1,29 @@
+//
+//  SyntaxChildren+InOut.swift
+//  
+//
+//  Created by Michael O'Brien on 20/10/2024.
+//
+
+import SwiftSyntax
+
+extension SyntaxChildren {
+    
+    /// Will assess the children in the current collection and search for inout token kinds with a shallow strategy.
+    /// Shallow referring to the child being a direct `TokenSyntax` type or a `TypeSpecifierListSyntax` containing a
+    /// child that is a `SimpleTypeSpecifierSyntax` whose token kind is an `inout`
+    /// - Returns: `Bool`
+    func resolveIsInOut() -> Bool {
+        contains(where: {
+            // Ignoring experimental `LifetimeTypeSpecifierSyntax` type for now.
+            if let specifierListType = $0.as(TypeSpecifierListSyntax.self) {
+                let nodes = specifierListType.compactMap { $0.as(SimpleTypeSpecifierSyntax.self) }
+                let tokens = nodes.flatMap { $0.tokens(viewMode: .fixedUp) }
+                return tokens.contains(where: { $0.tokenKind == TokenKind.keyword(.inout) })
+            }
+            // returning expected syntax type (if valid)
+            return $0.as(TokenSyntax.self)?.tokenKind == TokenKind.keyword(.inout)
+        })
+    }
+}
+
diff --git a/Sources/SyntaxSparrow/Internal/Resolvers/Declaration/FunctionSemanticsResolver.swift b/Sources/SyntaxSparrow/Internal/Resolvers/Declaration/FunctionSemanticsResolver.swift
@@ -39,6 +39,10 @@ struct FunctionSemanticsResolver: SemanticsResolving {
         node.funcKeyword.text.trimmed
     }
 
+    func resolveKeywordIsPresent() -> Bool {
+        node.funcKeyword.presence == .present
+    }
+
     func resolveModifiers() -> [Modifier] {
         node.modifiers.map { Modifier(node: $0) }
     }
diff --git a/Sources/SyntaxSparrow/Internal/Resolvers/Declaration/InitializerSemanticsResolver.swift b/Sources/SyntaxSparrow/Internal/Resolvers/Declaration/InitializerSemanticsResolver.swift
@@ -56,7 +56,7 @@ struct InitializerSemanticsResolver: SemanticsResolving {
     }
 
     func resolveThrowsOrRethrowsKeyword() -> String? {
-        node.signature.effectSpecifiers?.throwsSpecifier?.text.trimmed
+        node.signature.effectSpecifiers?.throwsClause?.throwsSpecifier.text.trimmed
     }
 
     func resolveEffectSpecifiers() -> EffectSpecifiers? {
diff --git a/Sources/SyntaxSparrow/Internal/Resolvers/Syntax/EnumCaseParameterSemanticsResolver.swift b/Sources/SyntaxSparrow/Internal/Resolvers/Syntax/EnumCaseParameterSemanticsResolver.swift
@@ -74,8 +74,7 @@ struct EnumCaseParameterSemanticsResolver: ParameterNodeSemanticsResolving {
     }
 
     func resolveIsInOut() -> Bool {
-        let tokens = node.type.children(viewMode: .fixedUp).compactMap { $0.as(TokenSyntax.self) }
-        return tokens.contains(where: { $0.tokenKind == TokenKind.keyword(.inout) })
+        node.type.children(viewMode: .fixedUp).resolveIsInOut()
     }
 
     func resolveDescription() -> String {
diff --git a/Sources/SyntaxSparrow/Internal/Resolvers/Syntax/FunctionParameterSemanticsResolver.swift b/Sources/SyntaxSparrow/Internal/Resolvers/Syntax/FunctionParameterSemanticsResolver.swift
@@ -67,7 +67,6 @@ struct FunctionParameterSemanticsResolver: ParameterNodeSemanticsResolving {
     }
 
     func resolveIsInOut() -> Bool {
-        let tokens = node.type.children(viewMode: .fixedUp).compactMap { $0.as(TokenSyntax.self) }
-        return tokens.contains(where: { $0.tokenKind == TokenKind.keyword(.inout) })
+        node.type.children(viewMode: .fixedUp).resolveIsInOut()
     }
 }
diff --git a/Sources/SyntaxSparrow/Internal/Resolvers/Syntax/TupleParameterSemanticsResolver.swift b/Sources/SyntaxSparrow/Internal/Resolvers/Syntax/TupleParameterSemanticsResolver.swift
@@ -74,7 +74,6 @@ struct TupleParameterSemanticsResolver: ParameterNodeSemanticsResolving {
         guard let attributedType = node.children(viewMode: .fixedUp).first?.as(AttributedTypeSyntax.self) else {
             return false
         }
-        let tokens = attributedType.children(viewMode: .fixedUp).compactMap { $0.as(TokenSyntax.self) }
-        return tokens.contains(where: { $0.tokenKind == TokenKind.keyword(.inout) })
+        return attributedType.children(viewMode: .fixedUp).resolveIsInOut()
     }
 }
diff --git a/Sources/SyntaxSparrow/Public/Semantics/Components/EffectsSpecifiers.swift b/Sources/SyntaxSparrow/Public/Semantics/Components/EffectsSpecifiers.swift
@@ -40,21 +40,21 @@ public struct EffectSpecifiers: Hashable, Equatable, CustomStringConvertible {
     /// Creates a new ``SyntaxSparrow/EffectSpecifiers`` instance from an `AccessorEffectSpecifiersSyntax` node.
     public init(node: AccessorEffectSpecifiersSyntax) {
         self.node = node
-        throwsSpecifier = node.throwsSpecifier?.text.trimmed
+        throwsSpecifier = node.throwsClause?.throwsSpecifier.text.trimmed
         asyncSpecifier = node.asyncSpecifier?.text.trimmed
     }
 
     /// Creates a new ``SyntaxSparrow/EffectSpecifiers`` instance from an `TypeEffectSpecifiersSyntax` node.
     public init(node: TypeEffectSpecifiersSyntax) {
         self.node = node
-        throwsSpecifier = node.throwsSpecifier?.text.trimmed
+        throwsSpecifier = node.throwsClause?.throwsSpecifier.text.trimmed
         asyncSpecifier = node.asyncSpecifier?.text.trimmed
     }
 
     /// Creates a new ``SyntaxSparrow/EffectSpecifiers`` instance from an `FunctionEffectSpecifiersSyntax` node.
     public init(node: FunctionEffectSpecifiersSyntax) {
         self.node = node
-        throwsSpecifier = node.throwsSpecifier?.text.trimmed
+        throwsSpecifier = node.throwsClause?.throwsSpecifier.text.trimmed
         asyncSpecifier = node.asyncSpecifier?.text.trimmed
     }
 
diff --git a/Sources/SyntaxSparrow/Public/Semantics/Declarations/Function.swift b/Sources/SyntaxSparrow/Public/Semantics/Declarations/Function.swift
@@ -130,6 +130,10 @@ public struct Function: Declaration, SyntaxChildCollecting {
     /// i.e: `"func"` for function declarations.
     public var keyword: String { resolver.resolveKeyword() }
 
+    /// Will return `false` when the `SourcePresence` type for the underlying node's function keyword is `missing`.
+    /// This is for scenarios where a function type is recognized, but is not an inherent declaration
+    public var isKeywordPresent: Bool { resolver.resolveKeywordIsPresent() }
+
     /// The function identifier (similar to name).
     ///
     /// For example, in the following declaration:
diff --git a/Sources/SyntaxSparrow/Public/Utilities/SparrowSourceLocationConverter.swift b/Sources/SyntaxSparrow/Public/Utilities/SparrowSourceLocationConverter.swift
@@ -8,7 +8,7 @@
 import Foundation
 import SwiftSyntax
 
-public class SparrowSourceLocationConverter {
+public class SparrowSourceLocationConverter: @unchecked Sendable {
     // MARK: - Properties
 
     var converter: SourceLocationConverter
diff --git a/Sources/SyntaxSparrow/Public/Utilities/SyntaxSourceLocation.swift b/Sources/SyntaxSparrow/Public/Utilities/SyntaxSourceLocation.swift
@@ -7,8 +7,8 @@
 
 import Foundation
 
-public struct SyntaxSourceLocation: Equatable, Codable, Hashable {
-    public struct Position: Equatable, Codable, Hashable {
+public struct SyntaxSourceLocation: Equatable, Codable, Hashable, Sendable {
+    public struct Position: Equatable, Codable, Hashable, Sendable {
         /// The line number the declaration was made on.
         ///
         /// Will be `nil` if unresolvable.
diff --git a/Tests/SyntaxSparrowTests/SyntaxChildCollecting+ConvenienceTests.swift b/Tests/SyntaxSparrowTests/SyntaxChildCollecting+ConvenienceTests.swift
@@ -110,12 +110,18 @@ final class SyntaxChildCollectingConvenienceTests: XCTestCase {
         XCTAssertEqual(aliases.map(\.name), [
             "NestedTypeAliasOne", "NestedTypeAliasTwo", "NestedTypeAliasThree", "NestedTypeAliasFour", "NestedTypeAliasFive", "NestedTypeAliasSix"
         ])
-        // Functions
-        let functions = instanceUnderTest.recursivelyCollectDeclarations(of: Function.self)
-        XCTAssertEqual(functions.count, 6)
+        // Functions (explicitly ignoring print as they are function closure types
+        let functions = instanceUnderTest.recursivelyCollectDeclarations(of: Function.self).filter { $0.keyword == "func" }
+        XCTAssertEqual(functions.count, 8)
         XCTAssertEqual(functions.map(\.identifier), [
-            "executeOrder66", "executeOrder66Two", "nestedFunctionOne", "executeOrder66Three", "nestedFunctionTwo", "nestedFunctionThree"
+            "executeOrder66", "executeOrder66Two", "nestedFunctionOne", "executeOrder66Three", "nestedFunctionTwo", "nestedFunctionThree", "print", "print"
         ])
+        for i in 0..<5 {
+            XCTAssertTrue(functions[i].isKeywordPresent)
+        }
+        XCTAssertFalse(functions[6].isKeywordPresent)
+        XCTAssertFalse(functions[7].isKeywordPresent)
+
         // Structs
         let structures = instanceUnderTest.recursivelyCollectDeclarations(of: Structure.self)
         XCTAssertEqual(structures.count, 3)

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,10 @@ struct FunctionSemanticsResolver: SemanticsResolving {`
`39`	`39`	`node.funcKeyword.text.trimmed`
`40`	`40`	`}`
`41`	`41`
	`42`	`+ func resolveKeywordIsPresent() -> Bool {`
	`43`	`+ node.funcKeyword.presence == .present`
	`44`	`+ }`
	`45`	`+`
`42`	`46`	`func resolveModifiers() -> [Modifier] {`
`43`	`47`	`node.modifiers.map { Modifier(node: $0) }`
`44`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ struct InitializerSemanticsResolver: SemanticsResolving {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`func resolveThrowsOrRethrowsKeyword() -> String? {`
`59`		`- node.signature.effectSpecifiers?.throwsSpecifier?.text.trimmed`
	`59`	`+ node.signature.effectSpecifiers?.throwsClause?.throwsSpecifier.text.trimmed`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`func resolveEffectSpecifiers() -> EffectSpecifiers? {`