Docs #4
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,112 @@ | ||
| name: Pull request | ||
| on: pull_request | ||
|
|
||
| env: | ||
| XCODE_VERSION: "16.3" | ||
|
|
||
| jobs: | ||
| prepare: | ||
| runs-on: macos-15 | ||
| outputs: | ||
| platforms: ${{ steps.platforms.outputs.platforms }} | ||
| scheme: ${{ steps.scheme.outputs.scheme }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Setup Xcode | ||
| run: sudo xcode-select -s /Applications/Xcode_$XCODE_VERSION.app | ||
|
|
||
| - name: Setup mise | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| run: | | ||
| curl https://mise.run | sh | ||
| mise install | ||
| - name: Run linters | ||
| run: mise lint | ||
|
|
||
| - name: Extract platforms | ||
| id: platforms | ||
| run: | | ||
| platforms=$(swift package dump-package | jq -r '[.platforms[].platformName] | unique | @json') | ||
| echo "Platforms: $platforms" | ||
| echo "platforms=$platforms" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Extract scheme | ||
| id: scheme | ||
| run: | | ||
| repo=$(basename $GITHUB_REPOSITORY) | ||
| schemes=$(xcodebuild -list) | ||
| echo "$schemes" | ||
|
|
||
| if echo "$schemes" | grep -q "$repo-Package"; then | ||
| scheme="$repo-Package" | ||
| elif echo "$schemes" | grep -q "$repo"; then | ||
| scheme="$repo" | ||
| else | ||
| echo "Unable to select a scheme" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Selected scheme: $scheme" | ||
| echo "scheme=$scheme" >> $GITHUB_OUTPUT | ||
|
|
||
| build-and-test: | ||
| needs: prepare | ||
| runs-on: macos-15 | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| platform: ${{ fromJSON(needs.prepare.outputs.platforms) }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Setup Xcode | ||
| run: sudo xcode-select -s /Applications/Xcode_$XCODE_VERSION.app | ||
|
|
||
| - name: Map destinations | ||
| if: ${{ matrix.platform != 'macos' }} | ||
| id: destination | ||
| run: | | ||
| case "${{ matrix.platform }}" in | ||
| ios) | ||
| destination="platform=iOS Simulator,name=iPhone 16 Pro Max,OS=latest" | ||
| ;; | ||
| maccatalyst) | ||
| destination="platform=macOS,variant=Mac Catalyst" | ||
| ;; | ||
| tvos) | ||
| destination="platform=tvOS Simulator,name=Apple TV 4K (3rd generation),OS=latest" | ||
| ;; | ||
| visionos) | ||
| destination="platform=visionOS Simulator,name=Apple Vision Pro,OS=latest" | ||
| ;; | ||
| watchos) | ||
| destination="platform=watchOS Simulator,name=Apple Watch Series 10 (46mm),OS=latest" | ||
| ;; | ||
| *) | ||
| echo "Unknown platform: ${{ matrix.platform }}" | ||
| exit 1 | ||
| ;; | ||
| esac | ||
| echo "destination=$destination" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Build (SPM) | ||
| if: ${{ matrix.platform == 'macos' }} | ||
| run: swift build | xcbeautify --renderer github-actions | ||
| - name: Build (Xcode) | ||
| if: ${{ matrix.platform != 'macos' }} | ||
| run: | | ||
| xcodebuild build \ | ||
| -scheme ${{ needs.prepare.outputs.scheme }} \ | ||
| -destination "${{ steps.destination.outputs.destination }}" | \ | ||
| xcbeautify --renderer github-actions | ||
|
|
||
| - name: Test (SPM) | ||
| if: ${{ matrix.platform == 'macos' }} | ||
| run: swift test | xcbeautify --renderer github-actions | ||
| - name: Test (Xcode) | ||
| if: ${{ matrix.platform != 'macos' }} | ||
| run: | | ||
| xcodebuild test \ | ||
| -scheme ${{ needs.prepare.outputs.scheme }} \ | ||
| -destination "${{ steps.destination.outputs.destination }}" | \ | ||
| xcbeautify --renderer github-actions |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,19 @@ | ||
| # PrincipleMacros | ||
|
|
||
|  | ||
|
|
||
| Essential tools that extend the capabilities of `SwiftSyntax`, simplifying the implementation of custom macros. | ||
|
|
||
| > [!WARNING] | ||
| > This package is considered an implementation detail of some of my other open-source projects. | ||
| > While it follows semantic versioning rules and has decent test coverage, it is currently undocumented, | ||
| > and future releases may introduce multiple breaking changes. Use it at your own discretion. | ||
| ## Installation | ||
|
|
||
| ```swift | ||
| .package( | ||
| url: "https://github.com/NSFatalError/PrincipleMacros", | ||
| from: "1.0.0" | ||
| ) | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| // | ||
| // EnumCaseCallExprBuilderTests.swift | ||
| // PrincipleMacros | ||
| // | ||
| // Created by Kamil Strzelecki on 05/04/2025. | ||
| // Copyright © 2025 Kamil Strzelecki. All rights reserved. | ||
| // | ||
|
|
||
| @testable import PrincipleMacros | ||
| import Testing | ||
|
|
||
| internal struct EnumCaseCallExprBuilderTests { | ||
|
|
||
| func makeEnumCase(from decl: DeclSyntax) throws -> EnumCase { | ||
| let enumCaseDecl = try #require(EnumCaseDeclSyntax(decl)) | ||
| let enumElement = try #require(enumCaseDecl.elements.first) | ||
| return EnumCase(declaration: enumCaseDecl, element: enumElement) | ||
| } | ||
|
|
||
| @Test | ||
| func testCallWithoutAssociatedValues() throws { | ||
| let enumCase = try makeEnumCase(from: "case first") | ||
| let builder = EnumCaseCallExprBuilder(for: enumCase) { _ in | ||
| Issue.record() | ||
| return "" as ExprSyntax | ||
| } | ||
| #expect(builder.build().description == ".first") | ||
| } | ||
|
|
||
| @Test | ||
| func testCallWithUnnamedAssociatedValue() throws { | ||
| let enumCase = try makeEnumCase(from: "case second(Int)") | ||
| let builder = EnumCaseCallExprBuilder(for: enumCase) { _ in | ||
| "123" as ExprSyntax | ||
| } | ||
| #expect(builder.build().description == ".second(123)") | ||
| } | ||
|
|
||
| @Test | ||
| func testCallWithMultipleAssociatedValues() throws { | ||
| let enumCase = try makeEnumCase(from: "case third(arg: String, Int)") | ||
| let builder = EnumCaseCallExprBuilder(for: enumCase) { associatedValue in | ||
| if associatedValue.standardizedName.description == "arg" { | ||
| "argument" as ExprSyntax | ||
| } else { | ||
| "123" as ExprSyntax | ||
| } | ||
| } | ||
| #expect(builder.build().description == ".third(arg: argument, 123)") | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // | ||
| // SwitchExprBuilderTests.swift | ||
| // PrincipleMacros | ||
| // | ||
| // Created by Kamil Strzelecki on 05/04/2025. | ||
| // Copyright © 2025 Kamil Strzelecki. All rights reserved. | ||
| // | ||
|
|
||
| @testable import PrincipleMacros | ||
| import Testing | ||
|
|
||
| internal struct SwitchExprBuilderTests { | ||
|
|
||
| func makeEnumCase(from decl: DeclSyntax) throws -> EnumCase { | ||
| let enumCaseDecl = try #require(EnumCaseDeclSyntax(decl)) | ||
| let enumElement = try #require(enumCaseDecl.elements.first) | ||
| return EnumCase(declaration: enumCaseDecl, element: enumElement) | ||
| } | ||
|
|
||
| @Test | ||
| func testSwitchExpression() throws { | ||
| let enumCases = try EnumCasesList([ | ||
| makeEnumCase(from: "case first"), | ||
| makeEnumCase(from: "case second(Int)"), | ||
| makeEnumCase(from: "case third(arg: String, Int)") | ||
| ]) | ||
|
|
||
| let builder = SwitchExprBuilder(for: enumCases, over: "subject") { enumCase in | ||
| "return \(raw: enumCase.associatedValues.count)" | ||
| } | ||
|
|
||
| let expectation = """ | ||
| switch subject { | ||
| case .first: | ||
| return 0 | ||
| case let .second(_0): | ||
| return 1 | ||
| case let .third(arg, _1): | ||
| return 2 | ||
| } | ||
| """ | ||
|
|
||
| #expect(builder.build().description == expectation) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Swift Tools Version Upgrade Impact
Upgrading from Swift 6.0 to 6.1 will require contributors and users to update their Swift toolchain. Ensure this aligns with your adoption timeline and that any new Swift 6.1 features you're using are documented.
🧰 Tools
🪛 SwiftLint (0.57.0)
[Warning] 1-1: Header comments should be consistent with project patterns
(file_header)