[mini.surround] Call "Output surrounding" with arguments like text, range

[drowning-cat]

I’m trying to implement sal where l stands for log, similar to what’s shown in YouTube: Neovim: Save HOURS by building a Macro collection in your Config.

For example,

local |name = "mini.nvim is great"

After running saiwl, it becomes:

local name = "mini.nvim is great"
|vim.print({ "name", name })

The idea is to use mini.surround for this purpose:

local MiniSurround = require("mini.surround")
MiniSurround.setup({
  custom_surroundings = {
    l = {
      output = function(text, range) -- NOTE: Pass `text`, `range`
        -- Some logic to insert a log statement on the next line
        -- ...
        -- NOTE: No return value
        return nil
      end,
    },
  },
})

Would it be a good idea to pass text and range into the output function for better scriptability?

Also, mini.surround only supports single-letter mappings, so something like ["<C-l>"] doesn’t work. It could be useful in the same fashion as function keys. For example:

• sal → surround with l
• sa<C-l> → surround with a log statement

Thank you for the response :0

[echasnovski]

For example,

local |name = "mini.nvim is great"

Arguably this is not a surrounding, because "add surrounding" is to add text to the left and to the right of the selected region. This looks like a good candidate for a separate operator. I'd not try to fit any use case that operates on a selected text range into "add surrounding".

Would it be a good idea to pass text and range into the output function for better scriptability?

Both - not really, because redundant. Supplying range (left + right + selection type) is enough to get the text, although it would need to account for the selection type (charwise/linewise/blockwise).

Should be doable, but I'd rather wait for a reasonable use case where computation of output surrounding might depend on the surrounded text range.

Also, mini.surround only supports single-letter mappings, so something like ["<C-l>"] doesn’t work. It could be useful in the same fashion as function keys.

It does work with any single character supported by getcharstr(). Executing :=vim.fn.getcharstr() and pressing <C-l> shows that it is a single character '\f'. Using custom_surroundings = { ['\f'] = { ... } } works as expected.

[drowning-cat]

1. Understood! In short, not worth it.
2. Oh, reading isn’t my speciality, I guess. Cool to know about getcharstr() and '\f'.

Thanks for the response! 😉

[drowning-cat]

-- after/ftplugin/lua.lua
if vim then
  vim.b.minisurround_log_insert = [[vim.print({ "%s", %s })]]
end

-- init.lua
local MiniSurround = require("mini.surround")
local surround_sel = function()
  local mark1, mark2
  if vim.v.operator == ":" then
    mark1, mark2 = "<", ">"
  else
    mark1, mark2 = "[", "]"
  end
  local pos1 = vim.api.nvim_buf_get_mark(0, mark1)
  local pos2 = vim.api.nvim_buf_get_mark(0, mark2)
  local text = vim.api.nvim_buf_get_text(0, pos1[1] - 1, pos1[2], pos2[1] - 1, pos2[2] + 1, {})
  return text, pos1, pos2
end
MiniSurround.setup({
  custom_surroundings = {
    l = {
      output = function()
        if vim.b.minisurround_log_insert then
          local sel = surround_sel()
          local row = vim.fn.line(".")
          local log = string.format(vim.b.minisurround_log_insert, sel[1], sel[1])
          local indent = vim.fn.getline(row):match("^%s+") or ""
          vim.api.nvim_buf_set_lines(0, row, row, true, { indent .. log })
          vim.api.nvim_win_set_cursor(0, { row + 1, #indent })
        end
      end,
    },
  },
})