Xin Zhao
adfcb45abe
## Context Closes #46698 This PR fixes a bug where the `cs` (change surrounds) operator fails on symmetric delimiters like quotes. In a sequence like `c s ' "`, Zed previously performed two independent searches. For a line like `I'm 'goˇod'`, the first step (`cs'`) correctly moves the cursor to the second quote: `I'm ˇ'good'`. However, when the replacement character `"` is pressed, `change_surrounds` would perform another scan from the new cursor position. Because quotes are symmetric, this second search would incorrectly match `'m '` as the target pair, leading to a broken result like `I"m "good'`. I've refactored the workflow to ensure the search happens only once. `prepare_and_move_to_valid_bracket_pair` now computes and stores the `Anchor` positions of the detected pair directly into the operator state. `change_surrounds` then simply reuses these anchors instead of re-executing the search. This ensures correctness for quotes while remaining consistent with Vim/Neovim cursor behavior. While this slightly increases coupling between these two functions, it is an intentional trade-off since they exclusively serve the `cs` operation. ## How to Review The main changes are in `crates/vim/src/surrounds.rs`. I renamed `check_and_move_to_valid_bracket_pair` to `prepare_and_move_to_valid_bracket_pair` and updated it to return the detected bracket anchors. In `change_surrounds`, I removed the redundant search logic and updated it to perform the replacement using the provided anchors. You can also see the updated `Operator::ChangeSurrounds` enum variant in `crates/vim/src/state.rs` which now carries the anchor data. ## Self-Review Checklist <!-- Check before requesting review: --> - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - Fixed an issue where the `cs` Vim operator incorrectly identified symmetric quotes in certain contexts. --------- Co-authored-by: Conrad Irwin <conrad.irwin@gmail.com>
This contains the code for Zed's Vim emulation mode.
Vim mode in Zed is supposed to primarily "do what you expect": it mostly tries to copy vim exactly, but will use Zed-specific functionality when available to make things smoother. This means Zed will never be 100% vim compatible, but should be 100% vim familiar!
The backlog is maintained in the #vim channel notes.
Testing against Neovim
If you are making a change to make Zed's behavior more closely match vim/nvim, you can create a test using the NeovimBackedTestContext.
For example, the following test checks that Zed and Neovim have the same behavior when running * in visual mode:
#[gpui::test]
async fn test_visual_star_hash(cx: &mut gpui::TestAppContext) {
let mut cx = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("ˇa.c. abcd a.c. abcd").await;
cx.simulate_shared_keystrokes(["v", "3", "l", "*"]).await;
cx.assert_shared_state("a.c. abcd ˇa.c. abcd").await;
}
To keep CI runs fast, by default the neovim tests use a cached JSON file that records what neovim did (see crates/vim/test_data), but while developing this test you'll need to run it with the neovim flag enabled:
cargo test -p vim --features neovim test_visual_star_hash
This will run your keystrokes against a headless neovim and cache the results in the test_data directory. Note that neovim must be installed and reachable on your $PATH in order to run the feature.
Testing zed-only behavior
Zed does more than vim/neovim in their default modes. The VimTestContext can be used instead. This lets you test integration with the language server and other parts of zed's UI that don't have a NeoVim equivalent.