VS Code: QuickPick disambiguation for ambiguous F16 rename targets - #27
Merged
Conversation
VS Code's prepareRename previously returned null for a step whose text matches multiple binding attributes, silently suppressing rename with no explanation -- unlike the Visual Studio client, which already shows a disambiguation dialog for the same case via the reqnroll/renameTargets and reqnroll/selectRenameTarget custom requests. That server-side plumbing is already generic (not VS-specific), so this adds a VS Code-idiomatic equivalent purely on the client: a RenameMiddleware override intercepts textDocument/prepareRename, queries reqnroll/renameTargets, and when more than one binding matches, shows a QuickPick and sends reqnroll/selectRenameTarget with the user's choice before delegating to the standard rename flow. Zero/one-target cases pass straight through to VS Code's native prepareRename, so normal rename UX is unchanged. Closes #10
2 tasks
CI's format:check step failed on this new test file.
Reqnroll.IdeSupport.LSP.Server's BuildConnector target already builds Connector.csproj transitively (with its own global properties) before the server compiles. Building it again as an independent solution node races that same build's CustomAfterBuild target — both instances RemoveDir/Copy into the identical Connectors\ output folder under VS's parallel project builds, intermittently failing with "directory not empty". Exclude the standalone node from Debug builds; Release keeps it for VSIX/CI packaging. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
FindBindingsAtFeatureStep gated candidates on MatchResult.HasDefined, but an ambiguous step's items are typed Ambiguous, not Defined — excluding exactly the steps this picker exists to disambiguate. Both reqnroll/renameTargets (empty picker) and prepareRename (null, which the server's null->throw wiring surfaces as a visible client error popup) were affected. Now also accept HasAmbiguous items. Also distinguish otherwise-identical picker entries by appending the implementing method (shortened to Class.Method, dropping the shared namespace prefix that was pushing the only distinguishing part past the picker's visible width). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
VS Code's Uri.toString() percent-encodes the Windows drive-letter colon (file:///c%3A/...), which reqnroll/selectRenameTarget carried verbatim as a raw string. HandleRenameAsync's session lookup instead keyed off DocumentUri.ToString(), which round-trips unescaped (file:///c:/...) — the two never matched, so TryConsume always missed and HandleRenameAsync silently fell back to the first ambiguous candidate regardless of what the user selected in the picker. Type SelectRenameTargetParams.Uri as DocumentUri (matching every other incoming-URI field in the codebase) so both sides of the session key go through the same normalizing round-trip, closing the gap at its source. RenameSessionManager.NormalizeUri also now unescapes percent-encoding as defense-in-depth. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This was referenced Jul 5, 2026
3 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
prepareRenamepreviously returnednullwhenever the cursor's step text matched more than one step-binding attribute, silently suppressing rename with no explanation to the user.reqnroll/renameTargets(enumerate candidates) andreqnroll/selectRenameTarget(record the user's pick for the nexttextDocument/rename) custom requests — this plumbing is generic, not VS-specific.RenameMiddleware.prepareRenameoverride (src/VSCode/src/renameDisambiguation.ts) that queriesreqnroll/renameTargetsfirst. When 0 or 1 candidates are returned, it delegates straight through to VS Code's nativeprepareRename(no behavior change). When 2+ candidates are returned, it shows avscode.window.showQuickPicklisting the ambiguous binding attributes, sendsreqnroll/selectRenameTargetwith the chosen index (usingversion: 0, matching how the Visual Studio client and the server'sRenameSessionManagerkey sessions), and then proceeds with the normal rename flow so VS Code's native rename input box still opens.Test plan
npm run compilepasses cleanlynpm run lintpasses cleanlynpm test(real Extension Development Host run via@vscode/test-electron) — 23 passing, 1 pending (documents that driving the interactive QuickPick itself isn't automatable headlessly; the dismiss-picker and pass-through branches are covered)Reqnroll.IdeSupport.LSP.Server) code touched, so no LSP spec regression risk.csfile with two[Given]/[When]/[Then]attributes on the same method (or two bindings resolving to the same feature step), invoke rename (F2 or the "Rename Step" command), confirm the QuickPick lists both attributes, and confirm choosing one renames only that binding while dismissing the picker cancels rename cleanly.Closes #10