Eric Holk
b1db5de445
When clipboard data was produced by the editor's copy/cut with multiple entire-line selections, vim's paste would panic with `byte index N is out of bounds`. The editor's `do_copy` and `cut_common` skip the `\n` separator between clipboard selections when the previous selection was an entire-line selection (because the text already ends with `\n`). However, vim's paste code unconditionally did `start_offset = end_offset + 1`, always assuming a `\n` separator exists between every pair of selections. This caused the accumulated offset to exceed the text length, resulting in a string slicing panic. The fix checks `clipboard_selection.is_entire_line` to decide whether to skip the separator, matching the behavior of the editor's own `do_paste` method. The same fix is applied to both the vim and helix paste implementations. Release Notes: - Fixed a crash when using vim paste on clipboard data copied with the editor's copy command containing multiple entire-line selections.
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.