Adopt swift-format #2794
Merged
Adopt swift-format #2794
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
# Conflicts: # IntegrationTests/tests_04_performance/test_01_resources/shared.swift # IntegrationTests/tests_04_performance/test_01_resources/test_ping_pong_1000_reqs_1_conn.swift # Sources/NIOCore/AsyncSequences/NIOAsyncWriter.swift # Sources/NIOCore/AsyncSequences/NIOThrowingAsyncSequenceProducer.swift # Sources/NIOCore/Codec.swift # Sources/NIOCrashTester/OutputGrepper.swift # Sources/NIOHTTP1/HTTPEncoder.swift # Sources/NIOHTTP1/HTTPServerPipelineHandler.swift # Sources/NIOHTTP1/NIOHTTPClientUpgradeHandler.swift # Sources/NIOHTTP1Client/main.swift # Sources/NIOHTTP1Server/main.swift # Sources/NIOMulticastChat/main.swift # Sources/NIOPerformanceTester/UDPBenchmark.swift # Sources/NIOUDPEchoClient/main.swift # Sources/NIOWebSocket/NIOWebSocketFrameAggregator.swift # Sources/NIOWebSocket/WebSocketProtocolErrorHandler.swift # Tests/NIOCoreTests/AsyncSequences/NIOThrowingAsyncSequenceTests.swift # Tests/NIOHTTP1Tests/HTTPClientUpgradeTests.swift # Tests/NIOHTTP1Tests/HTTPServerClientTest.swift # Tests/NIOHTTP1Tests/HTTPServerPipelineHandlerTest.swift # Tests/NIOHTTP1Tests/HTTPServerProtocolErrorHandlerTest.swift # Tests/NIOPosixTests/AsyncChannelBootstrapTests.swift # Tests/NIOPosixTests/ChannelTests.swift # Tests/NIOPosixTests/CodecTest.swift # Tests/NIOPosixTests/DatagramChannelTests.swift # Tests/NIOPosixTests/SALChannelTests.swift # Tests/NIOPosixTests/SocketChannelTest.swift # Tests/NIOPosixTests/StreamChannelsTest.swift # Tests/NIOWebSocketTests/WebSocketClientEndToEndTests.swift
This reverts commit d1ac5bb.
FranzBusch
added
the
needs-no-version-bump
Lukasa
approved these changes
Jul 19, 2024
czechboy0
approved these changes
Jul 19, 2024
FranzBusch
added a commit
that referenced
this pull request
Jul 19, 2024
# Motivation We just adopted `swift-format` in #2794. To avoid blame showing this format commit we can use a `.git-blame-ignore-revs` file. # Modification This PR adds a `.git-blame-ignore-revs` and puts the formatting commit into it. # Result Helps in blaming the right person ;)
FranzBusch
added a commit
that referenced
this pull request
Jul 19, 2024
# Motivation We just adopted `swift-format` in #2794. To avoid blame showing this format commit we can use a `.git-blame-ignore-revs` file. # Modification This PR adds a `.git-blame-ignore-revs` and puts the formatting commit into it. # Result Helps in blaming the right person ;)
FranzBusch
added a commit
that referenced
this pull request
Jul 19, 2024
# Motivation We just adopted `swift-format` in #2794. To avoid blame showing this format commit we can use a `.git-blame-ignore-revs` file. # Modification This PR adds a `.git-blame-ignore-revs` and puts the formatting commit into it. # Result Helps in blaming the right person ;)
weissi
reviewed
Jul 19, 2024
| @@ -36,7 +36,7 @@ extension ByteBuffer { | |||
| // this is not technically correct because we shouldn't just bind | |||
| // the memory to `UInt8` but it's not a real issue either and we | |||
| // need to work around https://bugs.swift.org/browse/SR-9604 | |||
| Array<UInt8>(UnsafeRawBufferPointer(fastRebase: ptr[range]).bindMemory(to: UInt8.self)) | |||
| [UInt8](UnsafeRawBufferPointer(fastRebase: ptr[range]).bindMemory(to: UInt8.self)) | |||
There was a problem hiding this comment.
@FranzBusch this is against the Swift style guides
weissi
reviewed
Jul 19, 2024
| @@ -21,8 +21,8 @@ public struct ByteBufferView: RandomAccessCollection, Sendable { | |||
| public typealias Index = Int | |||
| public typealias SubSequence = ByteBufferView | |||
|
|
|||
| /* private but usableFromInline */ @usableFromInline var _buffer: ByteBuffer | |||
There was a problem hiding this comment.
@FranzBusch why are we losing all these comments
There was a problem hiding this comment.
That was on me and I can bring those back. We have a formatting rule that disallows block comments. I removed some of those private but... comments since we are super inconsistent with them throughout the project and all the properties are _. We have been consistent with the _ but not so much with the private but... comment.
weissi
reviewed
Jul 19, 2024
| } | ||
|
|
||
| @inlinable | ||
| public func index(after i: Index) -> Index { | ||
| return i + 1 |
There was a problem hiding this comment.
why are we losing the returns? That makes debugging so much harder because now you can't just add a print above :(
FranzBusch
added a commit
that referenced
this pull request
Jul 19, 2024
# Motivation We just adopted `swift-format` in #2794. To avoid blame showing this format commit we can use a `.git-blame-ignore-revs` file. # Modification This PR adds a `.git-blame-ignore-revs` and puts the formatting commit into it. # Result Helps in blaming the right person ;)
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:
We have been discussing the adoption of a formatting tool in our repositories for a long time and it turns out the time has come now with the addition of our new GH action pipelines we also want to setup formatting for our repos.
Modifications:
This PR configures
swift-formatvery similar to howswift-certificatesandswift-openapi-generatorconfigured there's with only minimal differences. The goal is to land on oneswift-formatconfig that we can then use in all repos. The differences to the existing configurations are as follows:NoLabelsInCasePatterns=trueOpenAPI: false; Certs: falseOmitExplicitReturns=trueOpenAPI: true, Certs: falseOrderedImports=trueOpenAPI: false, Certs: falseReplaceForEachWithForLoop=trueOpenAPI: true, Certs: falseUseEarlyExits=falseOpenAPI: false, Certs: trueThese options are also different but only for the reason that they would cause a lot of time to adopt. New projects should start with them and we should enable them in the fullness of time.
ValidateDocumentationCommentsAllPublicDeclarationsHaveDocumentationResult:
We have a formatter configured and check for it in our CI.