- Notifications
You must be signed in to change notification settings - Fork48
Useswift-format for Swift file formatting#261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Merged
Uh oh!
There was an error while loading.Please reload this page.
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
0fc8938 to597eb27CompareIanVS approved these changesFeb 20, 2025
4d34083 intomain 4 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
Try 3 of#254,#256
This adds a script called
swift-format.shthat ignores the files listed in.swiftformatignorewhile that feature is being added intoswiftlang/swift-format.swift-formatis shipped with XCode 16 and is included in the Github macos runners. There's a menuitem in XCode that allows formatting the file you're viewing. A good blog post is at:https://calebhearth.com/swift-format-github-actionUnder Editor -> Structure -> Format with swift-format:
This script has been vendored from
swiftlang/github-workflowsand adds a comment mentioning where it was vendored from and which edits have been made to it differing from the original source.A quirk is that this script relies on the ignore file being at the top level, so it's a bit brittle. We could honestly just hardcode the ignore value in the script, but 🤷
#263 will enable the format check and format all swift code, then a PR after that will git blame ignore the formatting PR.
Testing
To test, you can run
./swift-format.shfrom the root of the repo and see that swift code is formatted. To test the "check" run./swift-format.sh checkand see that there is a git diff outputted and that the exit code was unsuccessful.You may also see a failed run athttps://github.com/DefinedNet/mobile_nebula/actions/runs/13444683597/job/37567211304?pr=261 while it still exists.
Refs: