[surround] Short keymap for frenquently used surround

[HalibutGitWiz]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.surround

Question

I have mini.surround set up this way (Lazyvim default)

{
  "nvim-mini/mini.surround",
  keys = function(_, keys)
    -- Populate the keys based on the user's options
    local opts = LazyVim.opts("mini.surround")
    local mappings = {
      { opts.mappings.add, desc = "Add Surrounding", mode = { "n", "x" } },
      { opts.mappings.delete, desc = "Delete Surrounding" },
      { opts.mappings.find, desc = "Find Right Surrounding" },
      { opts.mappings.find_left, desc = "Find Left Surrounding" },
      { opts.mappings.highlight, desc = "Highlight Surrounding" },
      { opts.mappings.replace, desc = "Replace Surrounding" },
      { opts.mappings.update_n_lines, desc = "Update `MiniSurround.config.n_lines`" },
    }
    mappings = vim.tbl_filter(function(m)
      return m[1] and #m[1] > 0
    end, mappings)
    return vim.list_extend(mappings, keys)
  end,
  opts = {
    mappings = {
      add = "gsa", -- Add surrounding in Normal and Visual modes
      delete = "gsd", -- Delete surrounding
      find = "gsf", -- Find surrounding (to the right)
      find_left = "gsF", -- Find surrounding (to the left)
      highlight = "gsh", -- Highlight surrounding
      replace = "gsr", -- Replace surrounding
      update_n_lines = "gsn", -- Update `n_lines`
    },
  },
}

I use the surround gsaiw` frequently in SQL queries, so I'd like to create a shorter keymaps : gs`

My problem is : if I simply do this

vim.keymap.set("n", "gs`", "gsaiw`")

Neovim doesn't understand that the gsa part of the command means "Add a surround", it will perform a regular Neovim keymap. gs doesn't do anything in my config, but then a toggles insert mode. Instead of adding a surround around the current word, my keymap inserts iw` in the middle of it.

Mini.surround does not seem to expose commands. I took a look at the code, I believe it may be done by calling MiniSurround.add function directly (even though the code comments tell me not to 😅), but I don't really know how to do that.

Did anyone manage to perform that trick ?

[echasnovski]

My problem is : if I simply do this

vim.keymap.set("n", "gs`", "gsaiw`")

Neovim doesn't understand that the gsa part of the command means "Add a surround", it will perform a regular Neovim keymap. gs doesn't do anything in my config, but then a toggles insert mode. Instead of adding a surround around the current word, my keymap inserts iw` in the middle of it.

That's because vim.keymap.set by default uses noremap variant of the mapping, which means that keys are treated as if they are not mapped (i.e. as default). Adding { remap = true } as fourth argument should fix the issue. So something like this:

vim.keymap.set("n", "gs`", "gsaiw`", { remap = true })

[HalibutGitWiz]

That was it, thanks for the very fast reply, and for all your amazing work on mini.nvim 😉