50ac7dc925
# Objective Fixes #59129. `vim::HelixJumpToWord` currently treats its two-character target labels as text input. When an IME is active, the printable label keys can therefore enter the IME composition window instead of completing the jump. ## Solution - Treat an active Helix jump as command input rather than character input, preventing the platform input handler from preferring the IME for its label keys. - After normal keybinding resolution, handle action-less, unmodified label keydowns directly from the keystroke's ASCII-equivalent key. This preserves label matching on non-ASCII keyboard layouts while leaving Escape, custom bindings, and Ctrl/Alt/Cmd/Function shortcuts untouched. - Stop propagation after consuming a label key so the platform does not subsequently forward it to the IME. - Keep the existing committed-text handling as a fallback for other input paths. This is complementary to #61270: that PR handles pending GPUI keybinding chords before IME input, while this change handles Helix jump labels after the initiating action has resolved. The changes are also file-disjoint. ## Testing - Added a regression test using the issue's `s` → `vim::HelixJumpToWord` binding. The test verifies that: - no GPUI keybinding chord is pending; - Helix jump does not accept text input or prefer the IME; - both raw label keydown events are consumed; and - the expected jump completes. - Manually tested on macOS with both ABC and Japanese Romaji input sources. ## Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content adheres to Zed's UI standards ([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) and [icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md) guidelines) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable --- Release Notes: - Fixed Helix jump-to-word label input being intercepted by IMEs. |
||
|---|---|---|
| .. | ||
| 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 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.