vim: Add sneak motion

[nilehmann]

A (re)continuation of #21067.

This takes the original implementation in #15572 and adds the test in #21067. Then, as requested in #21067 (comment), it documents how to map a keybinding instead of having a setting.

Closes #13858

Release Notes:

• Added support for the popular vim_sneak plugin. This is disabled by default and can be enabled by binding a key to the Sneak and SneakBackward operators.

Reference:
https://github.com/justinmk/vim-sneak

[cla-bot]

We require contributors to sign our Contributor License Agreement, and we don't have @nilehmann on file. You can sign our CLA at https://zed.dev/cla. Once you've signed, post a comment here that says '@cla-bot check'.

[nilehmann]

@cla-bot check

[cla-bot]

The cla-bot has been summoned, and re-checked this pull request!

[ConradIrwin]

@nilehmann Thanks for taking the time to clean this up! I pushed a few minor tweaks, and will merge when green

[jmagaram]

How do I use this? I'm on 168.3 but can't find/see any sneak option in the default vim keymap.

[ConradIrwin]

@jmagaram This will first appear in 0.170 (which will likely go to preview on Wednesday, and stable one week later).

[cwooldridge1]

Thanks for adding this feature, maybe my understanding of "smartcase" being set to true is wrong but if smart case is set to true and I type s ca shouldnt that jump to the word Cat e.g. ignoring the casing difference? As right now it does not ignoring the casing difference.

[nilehmann]

Your understanding is correct and that's the behavior I'm seeing. Do you have {"vim": {"use_smartcase_find": true}} in settings.json?

[cwooldridge1]

{"vim": {"use_smartcase_find": tru

I did not have this, thank you, it works now.

[cwooldridge1]

Is there a plan to add streak mode for this? If streak mode existed the demand for something like easymotion would be limitted.

[ConradIrwin]

No plans, but if you want to help implement it I'd happily pair: https://calendly.com/conradirwin/pairing

[ChzenChzen]

Hello! I am newbie in vim mode, I already have s key in vim for delete char and switch to insert mode.
I enabled sneakpeak mode, but when I try to press s key, I will get default s key behavior for vim mode.

"vim": {
        "enable_vim_sneak": true,
        "use_system_clipboard": "never"
    }

Maybe I need to set up keybinds, but I don't know good solution for that )).
Could you share your settings and keybinds for this feature. Thanks!

---

update: I tried to set up the next:

    {
        "context": "Editor && vim_mode == visual && !VimWaiting && !VimObject",
        "bindings": {
            "s": "vim::Sneak",
            "S": "vim::SneakBackward"
        }
    },

but it does change nothing.

[dream-dasher]

@ChzenChzen

[
  {
    "context": "vim_mode == normal || vim_mode == visual",
    "bindings": {
      "s": ["vim::PushOperator", { "Sneak": {} }],
      "S": ["vim::PushOperator", { "SneakBackward": {} }]
    }
  }
]

Per here

If that's not working you've, and you're editing the correct document, then you've likely either (a) got a syntax break somewhere, which will retain previous keybinds and just not update (can be confusing) or (b) have competing keybinds somewhere (you can try "s/"S/shift-s and look about)

[machin3io]

Thank you for this, after the recent Easymotion implementation was turned down, having this now is the next best thing :) Working great, except that ctrl-o does not seem to return to the starting point?

[fourcolors]

Thank you for making this!

[fourcolors]

How do I enable the highlighting?

[ConradIrwin]

Highlighting is not yet supported! I think we could add something with the existing editor.highlight_background API.

If you want to pair with me on this: https://cal.com/conradirwin/pairing