## Summary Vim allows searching for punctuation runs using */# and furthermore does not require the word to be searched for, to be adjacent to the cursor. See also [pattern.txt](https://github.com/neovim/neovim/blob/7e394dbb896eaf86cb1046666dd423d512cda55f/runtime/doc/pattern.txt#L62) Vim's priority for selecting the run to be searched for is: 1. Word under the cursor 2. First word somewhere to the right of the cursor on the same line 3. Punctuation run under the cursor 4. First punctuation run somewhere to the right of the cursor on the same line Currently, Zed only allows picking words directly adjacent to the cursor (both to the left and to the right) and will otherwise not search for anything. After this change, Zed will no longer search for a word on the immediate left of the cursor, which did not match Vim's behavior. Instead, the chosen run will be selected according to the priorities outlined above. ## Testing Pick any file and optionally a Neovim instance and observe that */# behave as in Neovim. In particular * Zed will no longer search for a word on the immediate left of the cursor. * Zed will only pick runs that either surround the cursor or are somewhere to the right of the cursor. * It is possible to search for punctuation runs. * Word runs are always prioritized over punctuation runs. For example: `(ˇ[ tmp ([tmp` will result in `([ tmp ([ˇtmp` (this is also included in the test cases). ## Self-review - [x] I've reviewed my diff for quality, security, reliability, and performance. - [ ] UI changes follow the [checklist](https://zed.dev/docs/development/ui-checklist). - [x] Tests cover the new or changed behavior. Release Notes: - Improved `*` and `#` in Vim mode to follow Neovim's behavior and search for the next word on the line when the cursor isn't on a word, and for punctuation when no word follows --------- Co-authored-by: dino <dinojoaocosta@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.