Merge pull request #1164 from ahoppen/rename-from-end-of-identifier

Support rename initiated from the end of an identifier

Author: ahoppen

Sources/SourceKitLSP/Rename.swift

@@ -1037,12 +1037,13 @@ extension SwiftLanguageService {
     at position: Position,
     in snapshot: DocumentSnapshot
   ) async -> (position: Position?, usr: String?, functionLikeRange: Range<Position>?) {
+    let startOfIdentifierPosition = await adjustPositionToStartOfIdentifier(position, in: snapshot)
     let symbolInfo = try? await self.symbolInfo(
-      SymbolInfoRequest(textDocument: TextDocumentIdentifier(snapshot.uri), position: position)
+      SymbolInfoRequest(textDocument: TextDocumentIdentifier(snapshot.uri), position: startOfIdentifierPosition)
     )
 
-    guard let functionLikeRange = await findFunctionLikeRange(of: position, in: snapshot) else {
-      return (position, symbolInfo?.only?.usr, nil)
+    guard let functionLikeRange = await findFunctionLikeRange(of: startOfIdentifierPosition, in: snapshot) else {
+      return (startOfIdentifierPosition, symbolInfo?.only?.usr, nil)
     }
     if let onlySymbol = symbolInfo?.only, onlySymbol.kind == .constructor {
       // We have a rename like `MyStruct(x: 1)`, invoked from `x`.

Tests/SourceKitLSPTests/RenameAssertions.swift

@@ -51,8 +51,9 @@ func assertSingleFileRename(
     return
   }
   for marker in positions.allMarkers {
+    let position = positions[marker]
     let prepareRenameResponse = try await testClient.send(
-      PrepareRenameRequest(textDocument: TextDocumentIdentifier(uri), position: positions[marker])
+      PrepareRenameRequest(textDocument: TextDocumentIdentifier(uri), position: position)
     )
     if let prepareRenameResponse {
       XCTAssertEqual(
@@ -62,9 +63,11 @@ func assertSingleFileRename(
         file: file,
         line: line
       )
+      // VS Code considers the upper bound of a range as part of the identifier so both `contains` and equality in
+      // `upperBound` are fine.
       XCTAssert(
-        prepareRenameResponse.range.contains(positions[marker]),
-        "Prepare rename range \(prepareRenameResponse.range) does not contain rename position \(positions[marker])",
+        prepareRenameResponse.range.contains(position) || prepareRenameResponse.range.upperBound == position,
+        "Prepare rename range \(prepareRenameResponse.range) does not contain rename position \(position)",
         file: file,
         line: line
       )

Tests/SourceKitLSPTests/RenameTests.swift

@@ -18,8 +18,8 @@ final class RenameTests: XCTestCase {
   func testRenameVariableBaseName() async throws {
     try await assertSingleFileRename(
       """
-      let 1️⃣foo = 1
-      print(2️⃣foo)
+      let 1️⃣foo2️⃣ = 1
+      print(3️⃣foo4️⃣)
       """,
       newName: "bar",
       expectedPrepareRenamePlaceholder: "foo",