Adding Surround to visual mode selection

[palerdot]

I want to surround the visual selection with S (shift-s) which is the default behaviour of vim-surround/VSCodeVim. I tried adding

  {
    "context": "vim_mode == visual",
    "bindings": {
      "shift-s": ["vim::PushAddSurrounds", {}]
    }
  }

based on the docs here - https://zed.dev/docs/vim

But, it is just erroring out ... Any help on this is appreciated!

[palerdot]

After trial and error, I think I figured this out. It should be

  {
    "context": "vim_mode == visual",
    "bindings": {
      "shift-s": ["vim::PushOperator", { "AddSurrounds": {} }]
    }
  }
]

The docs has to be updated.

[baldwindavid]

I believe we're in the midst of that command changing so some docs and releases aren't quite in sync.

This is the "old" way that is currently in Zed Stable...

"shift-s": ["vim::PushOperator", { "AddSurrounds": {} }]

However, in Zed Preview this has changed to...

"shift-s": ["vim::PushAddSurrounds", {}]

The documentation appears to be just ahead of the stable release. I think this will work itself out next time there's a stable release.

Additionally, when you do hit that point, you'll get a popup asking if you'd like Zed to auto-migrate your keymap to the new keybindings. I know that at least workspace::ActivatePaneInDirection is changing too and will be broken for you when upgrading if they're currently referenced in your keymap (they are in mine) and don't get migrated.

Looks like you've got it sorted, but leaving this for posterity.

P.S. Since I'm trying to summarize here I also noticed that the auto-migration changes task names from "My Task Name" to "my_task_name" which broke all my tasks until I figured out what happened ha