Add .swiftformat and apply a lint check in CI #929
Merged
Conversation
This file contains 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
|
The first commit in this PR is the configuration and enabling a link check in CI. The second commit is the result of baselining the formatting. |
Motivation: The code style used by gRPC Swift is quite different from what most contributors are used to, indenting with two spaces instead of Xcode's default of four, for example. This is often irritating for contributors since they need to adjust their Xcode settings and reformat their code to match our style, and also for reviewers since they need to highlight these differences. Modifications: - Add a .swiftformat configuration file and ensure it's validated as part of the CI preflight checks - Apply swiftformat to baseline the formatting Result: - CI will check fail before running test if there are formatting violations - Users can run fix their formatting by running 'swiftformat .' in the root of the repository
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.
Motivation:
The code style used by gRPC Swift is quite different from what most
contributors are used to, indenting with two spaces instead of Xcode's default
of four, for example. This is often irritating for contributors since
they need to adjust their Xcode settings and reformat their code to
match our style, and also for reviewers since they need to highlight
these differences.
Modifications:
part of the CI preflight checks
Result:
violations
root of the repository