Invoke swiftformat via Swift Package Manager plugin
#224
Conversation
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
pcuenca
reviewed
Sep 2, 2025
| dependencies: [ | ||
| .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "1.4.0")), | ||
| .package(url: "https://github.com/johnmai-dev/Jinja", .upToNextMinor(from: "1.2.1")), | ||
| .package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.57.0"), |
Member
There was a problem hiding this comment.
So this would unconditionally download the dependency and compile it on the fly when swift package plugin is invoked?
Could download be potentially avoided hiding it behind an opt-in traits wall? (Just to understand it better, still testing that approach in its PR)
Collaborator
Author
There was a problem hiding this comment.
Swift Package Manager automatically downloads all declared dependencies whenever it resolves the dependency graph — so, anytime you run swift build and swift package plugin. My understanding is that it's built on-demand only when you invoke swift package plugin. Unfortunately, I don't believe traits would help us here.
Collaborator
Author
|
Closing in favor of #248 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
formatworkflow currently defines the current SwiftFormat version as an environment variable:swift-transformers/.github/workflows/format.yml
Lines 8 to 9 in ed54f3c
As we see in #223, defining a constant here creates drift over time.
This PR proposes to declare SwiftFormat as a package dependency and call it as a Swift Package Manager plugin. This approach defines a single source of truth for managing the development dependency, and provide developers and CI a unified way to apply and lint project standards.
Before
After
swift package plugin --allow-writing-to-package-directory swiftformat --config .swiftformat .