31e9526544
This change implements the vim [motion](https://github.com/vim/vim/blob/master/runtime/doc/motion.txt) commands to move the cursor to the top, middle and bottom of the visible view. This feature is requested in https://github.com/zed-industries/zed/issues/4941. This change takes inspiration from [crates/vim/src/normal/scroll.rs](https://github.com/zed-industries/zed/blob/main/crates/vim/src/normal/scroll.rs). A note on the behavior of these commands: Because `NeovimBackedTestContext` requires compatibility with nvim, the current implementation causes slightly non-standard behavior: it causes the editor to scroll a few lines. The standard behavior causes no scrolling. It is easy enough to account for the margin by adding `VERTICAL_SCROLL_MARGIN`. However, doing so will cause test failures due to the disparity between nvim and zed states. Perhaps `NeovimBackedTestContext` should have a switch to be more tolerant for such cases. Release Notes: - Added support for moving to top, middle and bottom of the screen in vim mode (`H`, `M`, and `L`) ([#4941](https://github.com/zed-industries/zed/issues/4941)). |
||
---|---|---|
.. | ||
src | ||
test_data | ||
Cargo.toml | ||
LICENSE-GPL | ||
README.md |
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 behaviour 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 behaviour 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.
Testing zed-only behaviour
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.