Implement an initializer of CodeAction with the FixIt from swift-syntax

Finetune the code

Finetune the code

Author: joehsieh

Package.swift

@@ -337,7 +337,8 @@ if useLocalDependencies {
     .package(url: "https://github.com/apple/swift-package-manager.git", branch: relatedDependenciesBranch),
     .package(url: "https://github.com/apple/swift-tools-support-core.git", branch: relatedDependenciesBranch),
     .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.2"),
-    .package(url: "https://github.com/apple/swift-syntax.git", branch: relatedDependenciesBranch),
+    // .package(url: "https://github.com/apple/swift-syntax.git", branch: relatedDependenciesBranch),
+    .package(url: "https://github.com/joehsieh/swift-syntax", branch: "add-fix-it-extesion"),
     .package(url: "https://github.com/apple/swift-crypto.git", from: "3.0.0"),
   ]
 }

Sources/SourceKitLSP/Swift/Diagnostic.swift

@@ -44,22 +44,10 @@ extension CodeAction {
     if let fromNote = fromNote {
       title = fromNote
     } else {
-      guard let startIndex = snapshot.index(of: edits[0].range.lowerBound),
-        let endIndex = snapshot.index(of: edits[0].range.upperBound),
-        startIndex <= endIndex,
-        snapshot.text.indices.contains(startIndex),
-        endIndex <= snapshot.text.endIndex
-      else {
-        logger.fault("position mapped, but indices failed for edit range \(String(reflecting: edits[0]))")
+      guard let generatedTitle = Self.generateTitle(with: edits, snapshot: snapshot) else {
         return nil
       }
-      let oldText = String(snapshot.text[startIndex..<endIndex])
-      let description = Self.fixitTitle(replace: oldText, with: edits[0].newText)
-      if edits.count == 1 {
-        title = description
-      } else {
-        title = description + "..."
-      }
+      title = generatedTitle
     }
 
     self.init(
@@ -71,10 +59,46 @@ extension CodeAction {
   }
 
   init?(_ fixIt: FixIt, in snapshot: DocumentSnapshot) {
-    // FIXME: Once https://github.com/apple/swift-syntax/pull/2226 is merged and
-    // FixItApplier is public, use it to compute the edits that should be
-    // applied to the source.
-    return nil
+    var textEdits = [TextEdit]()
+    for edit in fixIt.edits {
+      guard let startPosition = snapshot.position(of:edit.range.lowerBound),
+        let endPosition = snapshot.position(of:edit.range.upperBound) else {
+        continue
+      }
+      textEdits.append(TextEdit(range: startPosition ..< endPosition, newText: edit.replacement))
+    }
+
+    guard let generatedTitle = Self.generateTitle(with: textEdits, snapshot: snapshot) else {
+      return nil
+    }
+
+    self.init(
+      title: generatedTitle,
+      kind: .quickFix,
+      diagnostics: nil,
+      edit: WorkspaceEdit(changes: [snapshot.uri: textEdits])
+    )
+  }
+
+  private static func generateTitle(with edits: [TextEdit], snapshot: DocumentSnapshot) -> String? {
+    if edits.isEmpty {
+      return nil
+    }
+    guard let startIndex = snapshot.index(of: edits[0].range.lowerBound),
+      let endIndex = snapshot.index(of: edits[0].range.upperBound),
+      startIndex <= endIndex,
+      snapshot.text.indices.contains(startIndex),
+      endIndex <= snapshot.text.endIndex
+    else {
+      logger.fault("position mapped, but indices failed for edit range \(String(reflecting: edits[0]))")
+      return nil
+    }
+    let oldText = String(snapshot.text[startIndex..<endIndex])
+    let description = Self.fixitTitle(replace: oldText, with: edits[0].newText)
+    if edits.count == 1 {
+      return description
+    }
+    return description + "..."
   }
 
   /// Describe a fixit's edit briefly.

Tests/SourceKitLSPTests/CodeActionTests.swift

@@ -425,4 +425,54 @@ final class CodeActionTests: XCTestCase {
 
     try await fulfillmentOfOrThrow([editReceived])
   }
+
+  func testCodeActionForFixItsProducedBySwiftSyntax() async throws {
+    let ws = try await MultiFileTestWorkspace(files: [
+      "test.swift": "protocol Multi ident {}",
+      "compile_commands.json": "[]"
+    ])
+
+    let (uri, _) = try ws.openDocument("test.swift")
+
+    let report = try await ws.testClient.send(DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri)))
+    guard case .full(let fullReport) = report else {
+      XCTFail("Expected full diagnostics report")
+      return
+    }
+
+    XCTAssertEqual(fullReport.items.count, 1)
+    let diagnostic = try XCTUnwrap(fullReport.items.first)
+    guard let codeActions = diagnostic.codeActions else {
+      XCTFail("Expected non-empty codeActions")
+      return
+    }
+
+    let expectedCodeActions = [
+      CodeAction(
+        title: "Replace \'Multi \' with \'Multiident \'...", 
+        kind: .quickFix, 
+        edit: WorkspaceEdit(
+          changes: [
+            uri : [
+              TextEdit(range: Position(line: 0, utf16index: 9)..<Position(line: 0, utf16index: 15), newText: "Multiident "),
+              TextEdit(range: Position(line: 0, utf16index: 15)..<Position(line: 0, utf16index: 21), newText: ""),
+            ]
+          ]
+        )
+        ),
+      CodeAction(
+        title: "Replace \'Multi \' with \'MultiIdent \'...",
+        kind: .quickFix, 
+                edit: WorkspaceEdit(
+          changes: [
+            uri : [
+              TextEdit(range: Position(line: 0, utf16index: 9)..<Position(line: 0, utf16index: 15), newText: "MultiIdent "),
+              TextEdit(range: Position(line: 0, utf16index: 15)..<Position(line: 0, utf16index: 21), newText: ""),
+            ]
+          ]
+        )
+      )
+    ]
+    XCTAssertEqual(expectedCodeActions, codeActions)
+  }
 }