gregorias/nvim-surround-wk — explained in plain English
Analysis updated 2026-05-18
See a labeled popup menu of available surround types while editing text in Neovim.
Add readable labels to custom surround definitions so Which Key can display them.
Learn nvim-surround shortcuts faster by seeing options instead of memorizing them.
| gregorias/nvim-surround-wk | shenawy29/xdg-nvfilechooser.nvim | bjarneo/omarchy-ochre-theme | |
|---|---|---|---|
| Stars | 35 | 19 | 16 |
| Language | Lua | Lua | Lua |
| Setup difficulty | easy | hard | easy |
| Complexity | 1/5 | 3/5 | 1/5 |
| Audience | developer | developer | general |
Figures from each repo's GitHub metadata at analysis time.
Requires Neovim 0.11 or newer plus specific recent versions of nvim-surround and Which Key.
This is a small plugin for Neovim, a text editor popular among programmers, that connects two existing plugins together. The first is nvim-surround, which lets you quickly wrap text in brackets, quotes, HTML tags, or other paired characters and then change or remove those wrappers with short keyboard commands. The second is Which Key, which shows a popup menu of available keyboard shortcuts while you are in the middle of typing a command sequence, so you do not have to remember every option from memory. What this plugin adds is that when you trigger a surround action in Neovim, Which Key will now show a labeled menu of the available surround types you can apply. Without this plugin, nvim-surround works but offers no visual hint about which character to type next. With it, you see a list of options with readable labels like the one shown in the README screenshot. Setup is straightforward if you already use these tools. You add the plugin through your package manager and call the setup function. For the built-in surrounds that come with nvim-surround, labels are already provided. For any custom surrounds you define yourself, you add a label field to the surround configuration table so Which Key has text to display. The README notes two limitations: all surrounds that should appear in the menu need to be configured in advance because Which Key cannot process triggers it has not been told about, and the space character cannot be used as a trigger key, which the author attributes to a Which Key limitation. The plugin requires Neovim 0.11 or newer and specific recent versions of both dependency plugins.
A Neovim plugin that shows a labeled keyboard shortcut menu for nvim-surround actions using Which Key.
Mainly Lua. The stack also includes Lua, Neovim.
Setup difficulty is rated easy, with roughly 5min to a first successful run.
Mainly developer.
This repo across BitVibe Labs
Verify against the repo before relying on details.