ee420d530e
The `Vim.exit_temporary_normal` method had been updated (https://github.com/zed-industries/zed/pull/42742) to expect and `Option<&Motion>` that would then be used to determine whether to move the cursor right in case the motion was `Some(EndOfLine { ..})`. Unfortunately this meant that all callers now had to provide this argument, even if just `None`. After merging those changes I remember that we could probably play around with `clip_at_line_ends` so this commit removes those intial changes in favor of updating the `vim::normal::Vim.move_cursor` method so that, if vim is in temporary mode and `EndOfLine` is used, it disables clipping at line ends so that the newline character can be selected. Closes [#42278](https://github.com/zed-industries/zed/issues/42278) Release Notes: - N/A
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.