1This contains the code for Zed's Vim emulation mode.
 2
 3Vim 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!
 4
 5The backlog is maintained in the `#vim` channel notes.
 6
 7## Testing against Neovim
 8
 9If you are making a change to make Zed's behavior more closely match vim/nvim, you can create a test using the `NeovimBackedTestContext`.
10
11For example, the following test checks that Zed and Neovim have the same behavior when running `*` in visual mode:
12
13```rust
14#[gpui::test]
15async fn test_visual_star_hash(cx: &mut gpui::TestAppContext) {
16    let mut cx = NeovimBackedTestContext::new(cx).await;
17
18    cx.set_shared_state("ˇa.c. abcd a.c. abcd").await;
19    cx.simulate_shared_keystrokes(["v", "3", "l", "*"]).await;
20    cx.assert_shared_state("a.c. abcd ˇa.c. abcd").await;
21}
22```
23
24To keep CI runs fast, by default the neovim tests use a cached JSON file that records what neovim did (see crates/vim/test_data),
25but while developing this test you'll need to run it with the neovim flag enabled:
26
27```sh
28cargo test -p vim --features neovim test_visual_star_hash
29```
30
31This 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.
32
33
34## Testing zed-only behavior
35
36Zed 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.