How to add extra lines when surrounding

[oiiiiiiii]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.surround

Question

In nvim.surround, there is the option to move the surrounding to a seperate line. E.g. when using ySiw} instead of ysiw} (capital S) on a word I would transform

some_word

to

{
    some_word
}

Is there a similar option in mini.surround? I didn't find anything in the docs

[echasnovski]

Yes, this is possible in 'mini.surround' to a certain extent via config.respect_selection_type. See more description here.

This particular case would work via sa_}, as it requires linewise movement/selection (while iw is charwise).

[echasnovski]

That is a linewise motion for line, sa_} is "surround add" + "current line" + "} surrounding".

[oiiiiiiii]

One last question, if I didn't want to apply this to the whole line, say transform

let some_text = another text

to

let {
    some_text
}  = another text

how would I do that?

[krovuxdev]

Using saiw{ or saiw} works as described here, but if you want to include newlines in the surrounding, as mentioned here, you should use {\n and \n} instead.

[echasnovski]

... how would I do that?

Unfortunately, there is no easy way to do this, as usually mixing charwise and linewise operations (as this makes charwise selection appear on separate lines with new indent) is up to no good.

The best feasible solution is to follow @krovuxdev's suggestion and dedicate a special identifier for such cases. However, using only {\n and \n} is not enough as it will not keep indent, which is the real problem here. So this would require something like this:

require('mini.surround').setup({
  custom_surroundings = {
    ['{'] = {
      output = function()
        local indent = vim.api.nvim_get_current_line():match('^%s*')
        local sw = vim.bo.shiftwidth
        local tab_text = vim.bo.expandtab and string.rep(' ', sw == 0 and vim.bo.tabstop or sw) or '\t'
        return { left = '{\n' .. indent .. tab_text, right = '\n' .. indent .. '}' }
      end,
    },
  },
})

Note that } will still insert { and } without whitespaces, as is built-in.

[oiiiiiiii]

Hm, ok. Would it maybe make sense to add smilar behavior from nivm.surround to mini.surround? That when using capital S the surrounding is placed on a seperate line? Because if I map it like that I can't use the builtin berhavior of { anymore (unless I bind it to another key of course).

[echasnovski]

Would it maybe make sense to add smilar behavior from nivm.surround to mini.surround?

Not really. Mostly because it doesn't play nicely with deleting and replacing surrounds. To achieve that, there would have to be something like sA, sD, sR mappings, which I am not sure I like to have.

Because if I map it like that I can't use the builtin berhavior of { anymore (unless I bind it to another key of course).

Do you frequently need all three variants (without spaces, with single space, on separate line), though? Even if the answer is yes, there are still a lot of spare identifiers. If you want to have this kind of behavior for multiple brackets, that is also possible with something like this:

local brackets = {
  ['('] = { '(', ')' },
  ['['] = { '[', ']' },
  ['{'] = { '{', '}' },
  ['<'] = { '<', '>' },
}
require('mini.surround').setup({
  custom_surroundings = {
    ['n'] = {
      output = function()
        local id = vim.fn.getcharstr()
        local left, right = unpack(brackets[id])
        local indent = vim.api.nvim_get_current_line():match('^%s*')
        local sw = vim.bo.shiftwidth
        local tab_text = vim.bo.expandtab and string.rep(' ', sw == 0 and vim.bo.tabstop or sw) or '\t'
        return { left = left .. '\n' .. indent .. tab_text, right = '\n' .. indent .. right }
      end,
    },
  },
})

Now doing sa-iw-n( will surround with new lines while keeping indents. Maybe making this special surrounding built-in would make sense, but my initial reaction is that this is too much to be built-in. Maybe as a wiki entry in the future.

[oiiiiiiii]

Yeah maybe to much to be built in, but this is exactly what I wanted. Thanks a lot! :)