Skip to content
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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adopt swift-format #2794

Merged
merged 21 commits into from
Jul 19, 2024
Merged

Adopt swift-format #2794

merged 21 commits into from
Jul 19, 2024

Conversation

FranzBusch
Copy link
Member

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-format very similar to how swift-certificates and swift-openapi-generator configured there's with only minimal differences. The goal is to land on one swift-format config that we can then use in all repos. The differences to the existing configurations are as follows:

NoLabelsInCasePatterns=true OpenAPI: false; Certs: false
OmitExplicitReturns=true OpenAPI: true, Certs: false
OrderedImports=true OpenAPI: false, Certs: false
ReplaceForEachWithForLoop=true OpenAPI: true, Certs: false
UseEarlyExits=false OpenAPI: false, Certs: true

These 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.
ValidateDocumentationComments
AllPublicDeclarationsHaveDocumentation

Result:

We have a formatter configured and check for it in our CI.

FranzBusch added 21 commits July 17, 2024 10:20
@FranzBusch
Apply formatting
0dc1a5c
@FranzBusch
Apply no block comments rule
6ff8c84
@FranzBusch
Apply OmitExplicitReturns
e59c184
@FranzBusch
Apple OnlyOneTrailingClosureArgument
63f5521
@FranzBusch
Apply NoAssignmentInExpressions
a0c7404
@FranzBusch
Fix up DontRepeatTypeInStaticProperties lint errors
8ef2042
@FranzBusch
Apply OrderedImports
ed895f7
@FranzBusch
Apply ReplaceForEachWithForLoop
00cc30e
@FranzBusch
format file
623e815
@FranzBusch
Enable the formatting pipeline
972ea60
@FranzBusch
Merge branch 'main' into fb-formatting
bed069f 
# 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
@FranzBusch
Adopt AmbiguousTrailingClosureOverload
18750f3
@FranzBusch
Fix license header
4b1a1b3
@FranzBusch
Fix format check
962b76d
@FranzBusch
Fix EndOfLineComment
e08c027
@FranzBusch
Fix CI
c4ce70f
@FranzBusch
Adapt CI script to check if changes when running formatting
795bf5b
@FranzBusch
Separate lint and format into to steps
77c7115
@FranzBusch
Fix format
ad7c3b6
@FranzBusch
Adopt UseEarlyExits
d1ac5bb
@FranzBusch
Revert "Adopt UseEarlyExits"
1aa8ba5 
This reverts commit d1ac5bb.
@FranzBusch FranzBusch added the semver/none No version bump required. label Jul 19, 2024
@FranzBusch FranzBusch merged commit c9756e1 into main Jul 19, 2024
26 checks passed
@FranzBusch FranzBusch deleted the fb-formatting branch July 19, 2024 09:48
FranzBusch added a commit that referenced this pull request Jul 19, 2024
@FranzBusch
Ignore format commit from git blame
31edd6d 
# 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 FranzBusch mentioned this pull request Jul 19, 2024
Merged
FranzBusch added a commit that referenced this pull request Jul 19, 2024
@FranzBusch
Ignore format commit from git blame
0e4c997 
# 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
@FranzBusch
Ignore format commit from git blame
097830d 
# 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
weissi reviewed Jul 19, 2024
View reviewed changes
Sources/NIOCore/ByteBuffer-aux.swift
@@ -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))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FranzBusch this is against the Swift style guides

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which style guide?

weissi
weissi reviewed Jul 19, 2024
View reviewed changes
Sources/NIOCore/ByteBuffer-views.swift
@@ -21,8 +21,8 @@ public struct ByteBufferView: RandomAccessCollection, Sendable {
public typealias Index = Int
public typealias SubSequence = ByteBufferView

/* private but usableFromInline */ @usableFromInline var _buffer: ByteBuffer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FranzBusch why are we losing all these comments

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
weissi reviewed Jul 19, 2024
View reviewed changes
Sources/NIOCore/ByteBuffer-views.swift
}

@inlinable
public func index(after i: Index) -> Index {
return i + 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@FranzBusch
Ignore format commit from git blame (#2796)
bf69999 
# 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 ;)
chkp-aviads added a commit to chkp-aviads/swift-nio that referenced this pull request Jul 21, 2024
@chkp-aviads
Merge remote-tracking branch 'apple/main'
741b6e8 
* apple/main: (26 commits)
  [GHA] Only format Swift files that are in Git index (apple#2797)
  Ignore format commit from git blame (apple#2796)
  Adopt swift-format (apple#2794)
  Disable warnings as errors on Swift 6 and main (apple#2793)
  ChannelHandler: provide static (un)wrap(In|Out)bound(In|Out) (apple#2791)
  Add manual control to NIOLockedValueBox (apple#2786)
  [GHA] Cxx interoperability compatibility and integration tests check (apple#2790)
  [GHA] Introduce reusable matrix workflow (apple#2789)
  Fix benchmark thresholds update script (apple#2783)
  [GHA] Broken symlink and format check (apple#2787)
  [GHA] Add license header check (apple#2781)
  Improved documentation for HTTP Parts to clarify how often each part is received (apple#2775)
  [GHA] Download the scripts to make workflow reusable (apple#2785)
  Combine the two NIOAsyncChannel channel handlers (apple#2779)
  [GHA] Benchmark job (apple#2780)
  [GHA] Move docs check to script (apple#2776)
  Add benchmark for creating NIOAsyncChannel (apple#2774)
  Avoid creating a yield ID counter per async writer (apple#2768)
  [GHA] Unacceptable language check (apple#2766)
  Allow in-place mutation of `NIOLoopBoundBox.value` (apple#2771)
  ...

# Conflicts:
#	Sources/NIOPosix/BSDSocketAPICommon.swift
#	Sources/NIOPosix/GetaddrinfoResolver.swift
#	Sources/NIOPosix/HappyEyeballs.swift
@glbrntt glbrntt added 🔨 semver/patch No public API change. and removed semver/none No version bump required. labels Jul 24, 2024
cgrindel-self-hosted-renovate bot referenced this pull request in cgrindel/rules_swift_package_manager Aug 19, 2024
@cgrindel-self-hosted-renovate
chore(deps): update dependency apple/swift-nio to v2.70.0 (#1191)
873eada 
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [apple/swift-nio](https://togithub.com/apple/swift-nio) | minor |
`2.68.0` -> `2.70.0` |

---

### Release Notes

<details>
<summary>apple/swift-nio (apple/swift-nio)</summary>

###
[`v2.70.0`](https://togithub.com/apple/swift-nio/releases/tag/2.70.0):
SwiftNIO 2.70.0

[Compare
Source](https://togithub.com/apple/swift-nio/compare/2.69.0...2.70.0)

<!-- Release notes generated using configuration in .github/release.yml
at main -->

#### What's Changed

##### SemVer Minor

- `FileSystem.copyItem` can parallelise directory copy by
[@&#8203;UncleMattHope](https://togithub.com/UncleMattHope) in
[https://github.com/apple/swift-nio/pull/2806](https://togithub.com/apple/swift-nio/pull/2806)
- `ChannelOption`: Allow types to be accessed with leading dot syntax by
[@&#8203;ayush1794](https://togithub.com/ayush1794) in
[https://github.com/apple/swift-nio/pull/2816](https://togithub.com/apple/swift-nio/pull/2816)
- Make `EventLoopPromise` conform to Equatable by
[@&#8203;gjcairo](https://togithub.com/gjcairo) in
[https://github.com/apple/swift-nio/pull/2714](https://togithub.com/apple/swift-nio/pull/2714)
- Provide a default `CopyStrategy` overload for copyItem. by
[@&#8203;UncleMattHope](https://togithub.com/UncleMattHope) in
[https://github.com/apple/swift-nio/pull/2818](https://togithub.com/apple/swift-nio/pull/2818)

##### SemVer Patch

- Better align shutdown semantics of testing event loops by
[@&#8203;simonjbeaumont](https://togithub.com/simonjbeaumont) in
[https://github.com/apple/swift-nio/pull/2800](https://togithub.com/apple/swift-nio/pull/2800)
- Clone files on Darwin rather than copying them by
[@&#8203;rnro](https://togithub.com/rnro) in
[https://github.com/apple/swift-nio/pull/2823](https://togithub.com/apple/swift-nio/pull/2823)

##### Other Changes

- Fix compose file used in update-benchmark-thresholds script by
[@&#8203;simonjbeaumont](https://togithub.com/simonjbeaumont) in
[https://github.com/apple/swift-nio/pull/2808](https://togithub.com/apple/swift-nio/pull/2808)
- Remove advice to generate linux tests. by
[@&#8203;PeterAdams-A](https://togithub.com/PeterAdams-A) in
[https://github.com/apple/swift-nio/pull/2807](https://togithub.com/apple/swift-nio/pull/2807)
- Make `testInstantTCPConnectionResetThrowsError` more reliable by
[@&#8203;hamzahrmalik](https://togithub.com/hamzahrmalik) in
[https://github.com/apple/swift-nio/pull/2810](https://togithub.com/apple/swift-nio/pull/2810)
- \[CI] Add `shellcheck` and fix up warnings by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2809](https://togithub.com/apple/swift-nio/pull/2809)
- \[CI] Fix docs check by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2811](https://togithub.com/apple/swift-nio/pull/2811)
- \[CI] Add Swift 6 language mode workflow by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2812](https://togithub.com/apple/swift-nio/pull/2812)
- Fix test compilation on non-macOS Darwin platforms by
[@&#8203;simonjbeaumont](https://togithub.com/simonjbeaumont) in
[https://github.com/apple/swift-nio/pull/2817](https://togithub.com/apple/swift-nio/pull/2817)
- Add `.index-build` to `.gitignore` by
[@&#8203;MaxDesiatov](https://togithub.com/MaxDesiatov) in
[https://github.com/apple/swift-nio/pull/2819](https://togithub.com/apple/swift-nio/pull/2819)
- \[CI] Add action and workflow to check for semver label by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2814](https://togithub.com/apple/swift-nio/pull/2814)
- Update repository docs for swift-version support and recent CI check
changes by [@&#8203;UncleMattHope](https://togithub.com/UncleMattHope)
in
[https://github.com/apple/swift-nio/pull/2815](https://togithub.com/apple/swift-nio/pull/2815)
- Fix failing build for test by
[@&#8203;ayush1794](https://togithub.com/ayush1794) in
[https://github.com/apple/swift-nio/pull/2824](https://togithub.com/apple/swift-nio/pull/2824)
- Fix typo in comment in `WebSocketErrorCodes.swift` by
[@&#8203;valeriyvan](https://togithub.com/valeriyvan) in
[https://github.com/apple/swift-nio/pull/2604](https://togithub.com/apple/swift-nio/pull/2604)
- \[CI] Add a scheduled workflow for tests and benchmarks by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2822](https://togithub.com/apple/swift-nio/pull/2822)
- \[CI] Fix label check by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2827](https://togithub.com/apple/swift-nio/pull/2827)

#### New Contributors

- [@&#8203;UncleMattHope](https://togithub.com/UncleMattHope) made their
first contribution in
[https://github.com/apple/swift-nio/pull/2806](https://togithub.com/apple/swift-nio/pull/2806)
- [@&#8203;ayush1794](https://togithub.com/ayush1794) made their first
contribution in
[https://github.com/apple/swift-nio/pull/2816](https://togithub.com/apple/swift-nio/pull/2816)
- [@&#8203;valeriyvan](https://togithub.com/valeriyvan) made their first
contribution in
[https://github.com/apple/swift-nio/pull/2604](https://togithub.com/apple/swift-nio/pull/2604)

**Full Changelog**:
apple/swift-nio@2.69.0...2.70.0

###
[`v2.69.0`](https://togithub.com/apple/swift-nio/releases/tag/2.69.0):
SwiftNIO 2.69.0

[Compare
Source](https://togithub.com/apple/swift-nio/compare/2.68.0...2.69.0)

<!-- Release notes generated using configuration in .github/release.yml
at main -->

#### What's Changed

##### SemVer Minor

- Add manual control to `NIOLockedValueBox` by
[@&#8203;glbrntt](https://togithub.com/glbrntt) in
[https://github.com/apple/swift-nio/pull/2786](https://togithub.com/apple/swift-nio/pull/2786)
- ChannelHandler: provide static `(un)wrap(In|Out)bound(In|Out)` by
[@&#8203;weissi](https://togithub.com/weissi) in
[https://github.com/apple/swift-nio/pull/2791](https://togithub.com/apple/swift-nio/pull/2791)

##### SemVer Patch

- Pre-box some errors to reduce allocations by
[@&#8203;glbrntt](https://togithub.com/glbrntt) in
[https://github.com/apple/swift-nio/pull/2765](https://togithub.com/apple/swift-nio/pull/2765)
- Allow in-place mutation of `NIOLoopBoundBox.value` by
[@&#8203;dnadoba](https://togithub.com/dnadoba) in
[https://github.com/apple/swift-nio/pull/2771](https://togithub.com/apple/swift-nio/pull/2771)
- Avoid creating a yield ID counter per async writer by
[@&#8203;glbrntt](https://togithub.com/glbrntt) in
[https://github.com/apple/swift-nio/pull/2768](https://togithub.com/apple/swift-nio/pull/2768)
- Combine the two `NIOAsyncChannel` channel handlers by
[@&#8203;glbrntt](https://togithub.com/glbrntt) in
[https://github.com/apple/swift-nio/pull/2779](https://togithub.com/apple/swift-nio/pull/2779)
- Use the new Android overlay and Bionic module from Swift 6 by
[@&#8203;finagolfin](https://togithub.com/finagolfin) in
[https://github.com/apple/swift-nio/pull/2784](https://togithub.com/apple/swift-nio/pull/2784)
- Change `unsafeDownCast` to `as!` by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2802](https://togithub.com/apple/swift-nio/pull/2802)

##### Other Changes

- CI migration to GitHub Action by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
([https://github.com/apple/swift-nio/pull/2760](https://togithub.com/apple/swift-nio/pull/2760)
[https://github.com/apple/swift-nio/pull/2762](https://togithub.com/apple/swift-nio/pull/2762)
[https://github.com/apple/swift-nio/pull/2763](https://togithub.com/apple/swift-nio/pull/2763)
[https://github.com/apple/swift-nio/pull/2764](https://togithub.com/apple/swift-nio/pull/2764)
[https://github.com/apple/swift-nio/pull/2767](https://togithub.com/apple/swift-nio/pull/2767)
[https://github.com/apple/swift-nio/pull/2766](https://togithub.com/apple/swift-nio/pull/2766)
[https://github.com/apple/swift-nio/pull/2776](https://togithub.com/apple/swift-nio/pull/2776)
[https://github.com/apple/swift-nio/pull/2780](https://togithub.com/apple/swift-nio/pull/2780)
[https://github.com/apple/swift-nio/pull/2785](https://togithub.com/apple/swift-nio/pull/2785)
[https://github.com/apple/swift-nio/pull/2781](https://togithub.com/apple/swift-nio/pull/2781)
[https://github.com/apple/swift-nio/pull/2787](https://togithub.com/apple/swift-nio/pull/2787)
[https://github.com/apple/swift-nio/pull/2783](https://togithub.com/apple/swift-nio/pull/2783)
[https://github.com/apple/swift-nio/pull/2789](https://togithub.com/apple/swift-nio/pull/2789)
[https://github.com/apple/swift-nio/pull/2790](https://togithub.com/apple/swift-nio/pull/2790))
- Ignore format commit from git blame by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2796](https://togithub.com/apple/swift-nio/pull/2796)
[https://github.com/apple/swift-nio/pull/2797](https://togithub.com/apple/swift-nio/pull/2797)
[https://github.com/apple/swift-nio/pull/2801](https://togithub.com/apple/swift-nio/pull/2801)
[https://github.com/apple/swift-nio/pull/2803](https://togithub.com/apple/swift-nio/pull/2803)
- Adopt swift-format by
[@&#8203;FranzBusch](https://togithub.com/FranzBusch) in
[https://github.com/apple/swift-nio/pull/2794](https://togithub.com/apple/swift-nio/pull/2794)
- `HTTPPart` Documentation Clarification by
[@&#8203;dimitribouniol](https://togithub.com/dimitribouniol) in
[https://github.com/apple/swift-nio/pull/2775](https://togithub.com/apple/swift-nio/pull/2775)
- Add benchmark for creating `NIOAsyncChannel` by
[@&#8203;glbrntt](https://togithub.com/glbrntt) in
[https://github.com/apple/swift-nio/pull/2774](https://togithub.com/apple/swift-nio/pull/2774)
- Disable warnings as errors on Swift 6 and main by
[@&#8203;glbrntt](https://togithub.com/glbrntt) in
[https://github.com/apple/swift-nio/pull/2793](https://togithub.com/apple/swift-nio/pull/2793)

**Full Changelog**:
apple/swift-nio@2.68.0...2.69.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4xOC4xIiwidXBkYXRlZEluVmVyIjoiMzguMzkuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: cgrindel-self-hosted-renovate[bot] <139595543+cgrindel-self-hosted-renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weissi weissi weissi left review comments

@czechboy0 czechboy0 czechboy0 approved these changes

@Lukasa Lukasa Lukasa approved these changes

Assignees
No one assigned
Labels
🔨 semver/patch No public API change.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@FranzBusch @weissi @Lukasa @czechboy0 @glbrntt