VSCodeVim / VSCodeVim/Vim

Feature Request: Add Custom Key Mapping Configurations for Vim-Surround

Open
#8,525 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
15.2k
Forks
1.5k
Avg merge
3d 18h
Merged PRs (30d)
6

Description

Is your feature request related to a problem? Please describe.
I am currently unable to specify my own combination of keys for the vim-surround plugin within VSCode Vim. This feature is available in Neovim, where I can customize the vim-surround plugin as per my preferences in the Neovim configuration file.

Describe the solution you'd like
I would like the ability to customize the key bindings for vim-surround in VSCode Vim. For instance, in Neovim, I can set a specific key combination for surround like so: vim.g.surround_45 = "{(\"/r\")}". I would like a similar functionality to be available in VSCode Vim, where I can set my own key combinations in the settings or in a dedicated configuration file.

This would be configurable in the vscode settings like this:

"vim.surround": {
  "normalModeKeyBindings": [{"before": "-", "after": "{(\"/r\")}"}],
  "visualModeKeyBindings": [...], // etc
}

Here is a Link talking about how you can benefit from the extra surround features the original plugin has to offer.

Describe alternatives you've considered
A potential alternative could be the ability to import Neovim settings into VSCode Vim. However, I believe that having a dedicated setting within the plugin would provide a cleaner and more streamlined user experience.

Additional context
This feature would enhance the user experience by allowing users to have a consistent vim experience across different editors and platforms. It would also help users who have specific vim workflow preferences to efficiently use the vim-surround plugin within VSCode Vim.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not identify repository files, tests, or entry points. Start by locating the existing vim-surround handling and VS Code settings definitions, then determine how normal- and visual-mode mappings should be represented. Done means users can configure custom surround mappings in settings and those mappings work in the requested modes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.