Migrate from SwiftFormat to swift-format #248
Merged
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
|
Tagging @ZachNagengast as he gave us good guidance on formatting last time. 100% agree these things are usually banal yet contentious. Any solution that works and causes minimal friction is fine with me. |
pcuenca
reviewed
Sep 19, 2025
| /// - Parameters: | ||
| /// - localDir: The local directory where metadata files are downloaded. | ||
| /// - filePath: The path of the file for which metadata is being read. | ||
| /// - Parameter metadataPath: The path of the metadata file to read. |
pcuenca
reviewed
Sep 19, 2025
There was a problem hiding this comment.
I dislike the unnecessary burden formatters impose, creating friction that in my opinion is artificial.
I'm happy to go with any solution that:
- Works for the team.
- Is acceptable / consistent with the community, especially projects in the neighborhood such as argmax's and mlx-swift.
mattt
force-pushed
the
mattt/swift-format
branch
from
ea8e0c5 to
66c4a66
Compare
This was referenced Sep 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
SwiftFormat is a fantastic tool. But because it's not built-in to the Swift toolchain, adopting it for the project introduces friction. I've seen formatting issues creep up in several PR review threads (and not just from external contributors). To put some numbers behind that: GitHub says that the
formatworkflow fails 23% of the time (compared to 35% for unit tests)Me, I'll never remember to run this myself before committing changes, which is why I opened #216 to configure my editor to do this for me automatically. However, the suggested extension for SwiftFormat requires the user to have
swiftformatavailable inPATH.Even when
swiftformatis available, it's difficult to manage versions — as we saw in #212. I attempted to solve that by managing and running SwiftFormat via Swift Package Manager, but I don't like the ergonomics (swift package plugin --allow-writing-to-package-directory swiftformat --config .swiftformat .😵💫) and I especially don't like how it introduces a transitive dependency to all downstream consumers.So faced with these challenges, I propose that we go with the flow and standardize on
swift format, which is built into the Swift toolchain.I did my best to make
.swift-formatmatch the existing project settings as closely as possible. The resulting diff (97ad29f) is admittedly large, but I don't think it's too onerous (especially since we can ignore with.git-blame-ignore-revs). To my eyes, the formatting diff seems limited to:{ }->{})On the plus side,
swift formathas alintsubcommand that greatly simplifies our existing format checking workflow, and provides some helpful checks. For example, it flagged a few instances where documentation comments for a method were out of sync with the signature (e4f76dd).I understand and acknowledge that issues of project standards can be simultaneously contentious and banal. So I appreciate your taking the time to hear me out 🫶