Manually fix swift-format lint rules

ahoppen · ahoppen · commit 6074529dac66 · 2025-08-11T09:31:09.000+02:00
- I think there are valid calls with mixing inline and trailing closures (notably `Debouncer`), so I’m considering whether we should disable that rule.
- The `forEach` rule is a little annoying because we have `forEach` on `SKDResponseArray`. But it caught two cases of using `forEach` on arrays, so I think it’s worth keeping.
diff --git a/Sources/BuildServerIntegration/BuildServerManager.swift b/Sources/BuildServerIntegration/BuildServerManager.swift
@@ -460,36 +460,38 @@ package actor BuildServerManager: QueueBasedMessageHandler {
     // The debounce duration of 500ms was chosen arbitrarily without any measurements.
     self.filesDependenciesUpdatedDebouncer = Debouncer(
       debounceDuration: .milliseconds(500),
-      combineResults: { $0.union($1) }
-    ) {
-      [weak self] (filesWithUpdatedDependencies) in
-      guard let self, let delegate = await self.delegate else {
-        logger.fault("Not calling filesDependenciesUpdated because no delegate exists in SwiftPMBuildServer")
-        return
-      }
-      let changedWatchedFiles = await self.watchedFilesReferencing(mainFiles: filesWithUpdatedDependencies)
-      if !changedWatchedFiles.isEmpty {
-        await delegate.filesDependenciesUpdated(changedWatchedFiles)
+      combineResults: { $0.union($1) },
+      makeCall: {
+        [weak self] (filesWithUpdatedDependencies) in
+        guard let self, let delegate = await self.delegate else {
+          logger.fault("Not calling filesDependenciesUpdated because no delegate exists in SwiftPMBuildServer")
+          return
+        }
+        let changedWatchedFiles = await self.watchedFilesReferencing(mainFiles: filesWithUpdatedDependencies)
+        if !changedWatchedFiles.isEmpty {
+          await delegate.filesDependenciesUpdated(changedWatchedFiles)
+        }
       }
-    }
+    )
 
     // We don't need a large debounce duration here. It just needs to be big enough to accumulate
     // `resultReceivedAfterTimeout` calls for the same document (see comment on `filesBuildSettingsChangedDebouncer`).
     // Since they should all come in at the same time, a couple of milliseconds should be sufficient here, an 20ms be
     // plenty while still not causing a noticeable delay to the user.
     self.filesBuildSettingsChangedDebouncer = Debouncer(
       debounceDuration: .milliseconds(20),
-      combineResults: { $0.union($1) }
-    ) {
-      [weak self] (filesWithChangedBuildSettings) in
-      guard let self, let delegate = await self.delegate else {
-        logger.fault("Not calling fileBuildSettingsChanged because no delegate exists in SwiftPMBuildServer")
-        return
-      }
-      if !filesWithChangedBuildSettings.isEmpty {
-        await delegate.fileBuildSettingsChanged(filesWithChangedBuildSettings)
+      combineResults: { $0.union($1) },
+      makeCall: {
+        [weak self] (filesWithChangedBuildSettings) in
+        guard let self, let delegate = await self.delegate else {
+          logger.fault("Not calling fileBuildSettingsChanged because no delegate exists in SwiftPMBuildServer")
+          return
+        }
+        if !filesWithChangedBuildSettings.isEmpty {
+          await delegate.fileBuildSettingsChanged(filesWithChangedBuildSettings)
+        }
       }
-    }
+    )
 
     // TODO: Forward file watch patterns from this initialize request to the client
     // (https://github.com/swiftlang/sourcekit-lsp/issues/1671)
diff --git a/Sources/BuildServerIntegration/CompilationDatabase.swift b/Sources/BuildServerIntegration/CompilationDatabase.swift
@@ -140,7 +140,9 @@ package struct JSONCompilationDatabase: Equatable, Codable {
 
   package func encode(to encoder: Encoder) throws {
     var container = encoder.unkeyedContainer()
-    try commands.forEach { try container.encode($0) }
+    for command in commands {
+      try container.encode(command)
+    }
   }
 
   package subscript(_ uri: DocumentURI) -> [CompilationDatabaseCompileCommand] {
diff --git a/Sources/BuildServerProtocol/Messages/TaskStartNotification.swift b/Sources/BuildServerProtocol/Messages/TaskStartNotification.swift
@@ -46,7 +46,7 @@ public struct TaskStartNotification: NotificationType {
   /// Message describing the task.
   public var message: String?
 
-  /** Kind of data to expect in the `data` field. If this field is not set, the kind of data is not specified. */
+  /// Kind of data to expect in the `data` field. If this field is not set, the kind of data is not specified.
   public var dataKind: TaskStartDataKind?
 
   /// Optional metadata about the task.
diff --git a/Sources/CompletionScoring/Text/MatchCollator.swift b/Sources/CompletionScoring/Text/MatchCollator.swift
@@ -415,15 +415,16 @@ package struct MatchCollator {
       influencingTokenizedIdentifiers: influencingTokenizedIdentifiers,
       patternUTF8Length: 0,
       orderingTiesBy: { _, _ in false },
-      maximumNumberOfItemsForExpensiveSelection: Self.defaultMaximumNumberOfItemsForExpensiveSelection
-    ) { collator in
-      return (0..<iterations).reduce(0) { accumulation, _ in
-        collator.applyInfluence()
-        return collator.rescoredMatches.reduce(accumulation) { accumulation, match in
-          accumulation + match.individualScore.value
+      maximumNumberOfItemsForExpensiveSelection: Self.defaultMaximumNumberOfItemsForExpensiveSelection,
+      body: { collator in
+        return (0..<iterations).reduce(0) { accumulation, _ in
+          collator.applyInfluence()
+          return collator.rescoredMatches.reduce(accumulation) { accumulation, match in
+            accumulation + match.individualScore.value
+          }
         }
       }
-    }
+    )
   }
 
   package static func tokenize(
diff --git a/Sources/SKUtilities/Debouncer.swift b/Sources/SKUtilities/Debouncer.swift
@@ -41,7 +41,7 @@ package actor Debouncer<Parameter: Sendable> {
   package init(
     debounceDuration: Duration,
     combineResults: @escaping (Parameter, Parameter) -> Parameter,
-    _ makeCall: @Sendable @escaping (Parameter) async -> Void
+    makeCall: @Sendable @escaping (Parameter) async -> Void
   ) {
     self.debounceDuration = debounceDuration
     self.combineParameters = combineResults
@@ -84,7 +84,7 @@ package actor Debouncer<Parameter: Sendable> {
 
 extension Debouncer<Void> {
   package init(debounceDuration: Duration, _ makeCall: @Sendable @escaping () async -> Void) {
-    self.init(debounceDuration: debounceDuration, combineResults: { _, _ in }, makeCall)
+    self.init(debounceDuration: debounceDuration, combineResults: { _, _ in }, makeCall: makeCall)
   }
 
   package func scheduleCall() {
diff --git a/Sources/SourceKitD/SKDResponseArray.swift b/Sources/SourceKitD/SKDResponseArray.swift
@@ -62,6 +62,8 @@ package final class SKDResponseArray: Sendable {
   package func map<T>(_ transform: (SKDResponseDictionary) throws -> T) rethrows -> [T] {
     var result: [T] = []
     result.reserveCapacity(self.count)
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     try self.forEach { _, element in
       result.append(try transform(element))
       return true
@@ -71,6 +73,8 @@ package final class SKDResponseArray: Sendable {
 
   package func compactMap<T>(_ transform: (SKDResponseDictionary) throws -> T?) rethrows -> [T] {
     var result: [T] = []
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     try self.forEach { _, element in
       if let transformed = try transform(element) {
         result.append(transformed)
diff --git a/Sources/SourceKitD/sourcekitd_uids.swift b/Sources/SourceKitD/sourcekitd_uids.swift
@@ -14,6 +14,8 @@
 
 package import Csourcekitd
 
+// swift-format-ignore: TypeNamesShouldBeCapitalized
+// Matching C style types
 package struct sourcekitd_api_keys {
   /// `key.version_major`
   package let versionMajor: sourcekitd_api_uid_t
@@ -776,6 +778,8 @@ package struct sourcekitd_api_keys {
   }
 }
 
+// swift-format-ignore: TypeNamesShouldBeCapitalized
+// Matching C style types
 package struct sourcekitd_api_requests {
   /// `source.request.protocol_version`
   package let protocolVersion: sourcekitd_api_uid_t
@@ -947,6 +951,8 @@ package struct sourcekitd_api_requests {
   }
 }
 
+// swift-format-ignore: TypeNamesShouldBeCapitalized
+// Matching C style types
 package struct sourcekitd_api_values {
   /// `source.lang.swift.decl.function.free`
   package let declFunctionFree: sourcekitd_api_uid_t
diff --git a/Sources/SourceKitLSP/Swift/CommentXML.swift b/Sources/SourceKitLSP/Swift/CommentXML.swift
@@ -65,8 +65,11 @@ private struct XMLToMarkdown {
 
   // [XMLNode]? is the type of XMLNode.children.
   mutating func toMarkdown(_ nodes: [XMLNode]?, separator: String = "") {
-    nodes?.forEach {
-      toMarkdown($0)
+    guard let nodes else {
+      return
+    }
+    for node in nodes {
+      toMarkdown(node)
       out += separator
     }
   }
diff --git a/Sources/SourceKitLSP/Swift/Diagnostic.swift b/Sources/SourceKitLSP/Swift/Diagnostic.swift
@@ -26,6 +26,8 @@ extension CodeAction {
   /// If this is from a note, the note's description should be passed as `fromNote`.
   init?(fixits: SKDResponseArray, in snapshot: DocumentSnapshot, fromNote: String?) {
     var edits: [TextEdit] = []
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     let editsMapped = fixits.forEach { (_, skfixit) -> Bool in
       if let edit = TextEdit(fixit: skfixit, in: snapshot) {
         edits.append(edit)
@@ -204,6 +206,8 @@ extension Diagnostic {
       range = Range(snapshot.positionOf(utf8Offset: utf8Offset))
     }
 
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     // If the diagnostic has a range associated with it that starts at the same location as the diagnostics position, use it to retrieve a proper range for the diagnostic, instead of just reporting a zero-length range.
     (diag[keys.ranges] as SKDResponseArray?)?.forEach { index, skRange in
       guard let utf8Offset: Int = skRange[keys.offset],
@@ -273,6 +277,8 @@ extension Diagnostic {
     var notes: [DiagnosticRelatedInformation]? = nil
     if let sknotes: SKDResponseArray = diag[keys.diagnostics] {
       notes = []
+      // swift-format-ignore: ReplaceForEachWithForLoop
+      // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
       sknotes.forEach { (_, sknote) -> Bool in
         guard
           let note = DiagnosticRelatedInformation(
diff --git a/Sources/SourceKitLSP/Swift/RefactoringResponse.swift b/Sources/SourceKitLSP/Swift/RefactoringResponse.swift
@@ -29,11 +29,15 @@ extension [RefactoringEdit] {
 
     self = []
 
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     categorizedEdits.forEach { _, categorizedEdit in
       guard let edits: SKDResponseArray = categorizedEdit[keys.edits] else {
         logger.fault("edits doesn't exist in categorizedEdit dictionary")
         return true
       }
+      // swift-format-ignore: ReplaceForEachWithForLoop
+      // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
       edits.forEach { _, edit in
         guard let startLine: Int = edit[keys.line],
           let startColumn: Int = edit[keys.column],
diff --git a/Sources/SourceKitLSP/Swift/RelatedIdentifiers.swift b/Sources/SourceKitLSP/Swift/RelatedIdentifiers.swift
@@ -87,6 +87,8 @@ extension SwiftLanguageService {
 
     var relatedIdentifiers: [RelatedIdentifier] = []
 
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     results.forEach { _, value in
       guard let offset: Int = value[keys.offset], let length: Int = value[keys.length] else {
         return true  // continue
diff --git a/Sources/SourceKitLSP/Swift/SemanticRefactorCommand.swift b/Sources/SourceKitLSP/Swift/SemanticRefactorCommand.swift
@@ -86,6 +86,8 @@ extension Array where Element == SemanticRefactorCommand {
       return nil
     }
     var commands: [SemanticRefactorCommand] = []
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     results.forEach { _, value in
       if let name: String = value[keys.actionName],
         let actionuid: sourcekitd_api_uid_t = value[keys.actionUID],
diff --git a/Sources/SourceKitLSP/Swift/SyntaxHighlightingTokenParser.swift b/Sources/SourceKitLSP/Swift/SyntaxHighlightingTokenParser.swift
@@ -70,6 +70,8 @@ struct SyntaxHighlightingTokenParser {
     in snapshot: DocumentSnapshot,
     into tokens: inout SyntaxHighlightingTokens
   ) {
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     response.forEach { (_, value) in
       parseTokens(value, in: snapshot, into: &tokens)
       return true
diff --git a/Sources/SourceKitLSP/Swift/VariableTypeInfo.swift b/Sources/SourceKitLSP/Swift/VariableTypeInfo.swift
@@ -109,6 +109,8 @@ extension SwiftLanguageService {
     variableTypeInfos.reserveCapacity(skVariableTypeInfos.count)
 
     let syntaxTree = await syntaxTreeManager.syntaxTree(for: snapshot)
+    // swift-format-ignore: ReplaceForEachWithForLoop
+    // Reference is to `SKDResponseArray.forEach`, not `Array.forEach`.
     skVariableTypeInfos.forEach { (_, skVariableTypeInfo) -> Bool in
       guard let info = VariableTypeInfo(skVariableTypeInfo, in: snapshot, syntaxTree: syntaxTree) else {
         assertionFailure("VariableTypeInfo failed to deserialize")
diff --git a/Sources/SwiftSourceKitPlugin/CompletionProvider.swift b/Sources/SwiftSourceKitPlugin/CompletionProvider.swift
@@ -31,6 +31,8 @@ import SwiftSourceKitPluginCommon
 /// Returns `nil` if parsing failed because one of he entries didn't contain a key or value.
 private func parsePopularityDict(_ data: SKDRequestArrayReader) -> [String: Popularity]? {
   var result: [String: Popularity] = [:]
+  // swift-format-ignore: ReplaceForEachWithForLoop
+  // Reference is to `SKDRequestArrayReader.forEach`, not `Array.forEach`.
   let iteratedAllEntries = data.forEach { (_, entry) -> Bool in
     // We can't deserialize double values in SourceKit requests at the moment.
     // We transfer the double value as an integer with 9 significant digits by multiplying it by 1 billion first.
diff --git a/Tests/SKUtilitiesTests/DebouncerTests.swift b/Tests/SKUtilitiesTests/DebouncerTests.swift
@@ -31,10 +31,14 @@ final class DebouncerTests: XCTestCase {
   func testDebouncerCombinesParameters() async throws {
     let expectation = self.expectation(description: "makeCallCalled")
     expectation.assertForOverFulfill = true
-    let debouncer = Debouncer<Int>(debounceDuration: .seconds(0.1), combineResults: { $0 + $1 }) { param in
-      XCTAssertEqual(param, 3)
-      expectation.fulfill()
-    }
+    let debouncer = Debouncer<Int>(
+      debounceDuration: .seconds(0.1),
+      combineResults: { $0 + $1 },
+      makeCall: { param in
+        XCTAssertEqual(param, 3)
+        expectation.fulfill()
+      }
+    )
     await debouncer.scheduleCall(1)
     await debouncer.scheduleCall(2)
     try await fulfillmentOfOrThrow(expectation)

Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,9 @@ package struct JSONCompilationDatabase: Equatable, Codable {`
`140`	`140`
`141`	`141`	`package func encode(to encoder: Encoder) throws {`
`142`	`142`	`var container = encoder.unkeyedContainer()`
`143`		`- try commands.forEach { try container.encode($0) }`
	`143`	`+ for command in commands {`
	`144`	`+ try container.encode(command)`
	`145`	`+ }`
`144`	`146`	`}`
`145`	`147`
`146`	`148`	`package subscript(_ uri: DocumentURI) -> [CompilationDatabaseCompileCommand] {`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`
`15`	`15`	`package import Csourcekitd`
`16`	`16`
	`17`	`+// swift-format-ignore: TypeNamesShouldBeCapitalized`
	`18`	`+// Matching C style types`
`17`	`19`	`package struct sourcekitd_api_keys {`
`18`	`20`	/// `key.version_major`
`19`	`21`	`package let versionMajor: sourcekitd_api_uid_t`
`@@ -776,6 +778,8 @@ package struct sourcekitd_api_keys {`
`776`	`778`	`}`
`777`	`779`	`}`
`778`	`780`
	`781`	`+// swift-format-ignore: TypeNamesShouldBeCapitalized`
	`782`	`+// Matching C style types`
`779`	`783`	`package struct sourcekitd_api_requests {`
`780`	`784`	/// `source.request.protocol_version`
`781`	`785`	`package let protocolVersion: sourcekitd_api_uid_t`
`@@ -947,6 +951,8 @@ package struct sourcekitd_api_requests {`
`947`	`951`	`}`
`948`	`952`	`}`
`949`	`953`
	`954`	`+// swift-format-ignore: TypeNamesShouldBeCapitalized`
	`955`	`+// Matching C style types`
`950`	`956`	`package struct sourcekitd_api_values {`
`951`	`957`	/// `source.lang.swift.decl.function.free`
`952`	`958`	`package let declFunctionFree: sourcekitd_api_uid_t`
Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,11 @@ private struct XMLToMarkdown {`
`65`	`65`
`66`	`66`	`// [XMLNode]? is the type of XMLNode.children.`
`67`	`67`	`mutating func toMarkdown(_ nodes: [XMLNode]?, separator: String = "") {`
`68`		`- nodes?.forEach {`
`69`		`- toMarkdown($0)`
	`68`	`+ guard let nodes else {`
	`69`	`+ return`
	`70`	`+ }`
	`71`	`+ for node in nodes {`
	`72`	`+ toMarkdown(node)`
`70`	`73`	`out += separator`
`71`	`74`	`}`
`72`	`75`	`}`