How to configure lightspeed to work with vim-surround?

[jackysee]

It seems that vim-surround's mappings are always applied last. So I'm not sure how should I make it work.
(I know can use vim-sandwich with surround mappings. Just want to know if it can be done without switching plugin)

Minimal config

if has('vim_starting')
  set encoding=utf-8
endif
scriptencoding utf-8

if &compatible
  set nocompatible
endif

let s:plug_dir = expand('/tmp/plugged/vim-plug')
if !filereadable(s:plug_dir .. '/plug.vim')
  execute printf('!curl -fLo %s/autoload/plug.vim --create-dirs https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim', s:plug_dir)
end

execute 'set runtimepath+=' . s:plug_dir
call plug#begin(s:plug_dir)
Plug 'ggandor/lightspeed.nvim'
Plug 'tpope/vim-surround'
call plug#end()
PlugInstall | quit

map S S
xmap gs <Plug>VSurround
xmap S <Plug>Lightspeed_S

[ggandor]

Yep, good question, already answered here (same issue): justinmk/vim-sneak#268 (comment)

...
Plug 'ggandor/lightspeed.nvim'
Plug 'tpope/vim-surround'
...
let g:surround_no_mappings = 1
nmap ds       <Plug>Dsurround
nmap cs       <Plug>Csurround
nmap cS       <Plug>CSurround
nmap ys       <Plug>Ysurround
nmap yS       <Plug>YSurround
nmap yss      <Plug>Yssurround
nmap ySs      <Plug>YSsurround
nmap ySS      <Plug>YSsurround
xmap gs       <Plug>VSurround
xmap gS       <Plug>VgSurround

[ggandor]

This won't enable vim-surround in Visual mode though, will it?

[clementnuss]

no indeed, you're right I missed that point. the full config for LunarVim therefore is:

   {
      "tpope/vim-surround",
      keys = {"c", "d", "y"},
      config = function ()
        vim.cmd("nmap ds       <Plug>Dsurround")
        vim.cmd("nmap cs       <Plug>Csurround")
        vim.cmd("nmap cS       <Plug>CSurround")
        vim.cmd("nmap ys       <Plug>Ysurround")
        vim.cmd("nmap yS       <Plug>YSurround")
        vim.cmd("nmap yss      <Plug>Yssurround")
        vim.cmd("nmap ySs      <Plug>YSsurround")
        vim.cmd("nmap ySS      <Plug>YSsurround")
        vim.cmd("xmap gs       <Plug>VSurround")
        vim.cmd("xmap gS       <Plug>VgSurround")
      end
    },

Hope this will be helpful :)

[ggandor]

1. But since keys = {"c", "d", "y"} lazy-loads surround on the aforementioned keys, if you invoke a Visual mode vim-surround command before those are triggered, it will throw an error I guess. We might need something like this:

local ctrl_v = vim.api.nvim_replace_termcodes("<c-v>", true, true, true)}
...
-- add all Visual mode triggers too
keys = {"c", "d", "y", "v", "V", ctrl_v }

2. We still need let g:surround_no_mappings = 1, because otherwise vim-surround prevents Lightspeed mapping S in Visual mode. (Or, alternatively, you can xmap S <Plug>Lightspeed_S manually.)

[clementnuss]

actually it seems to be working well only with keys = {"c", "d", "y"},
I don't have enough vim experience to say whether more config is needed or not, will udpate in a few weeks if I find more information.
thanks for your help!

[afreakk]

For anyone looking, this seems to work nice with lazy.nvim:

{
        'tpope/vim-surround',
        keys = {
            { "cs", "<Plug>Csurround", desc = "change surrounding #1 by #2" },
            { "ds", "<Plug>Dsurround", desc = "delete surrounding #1" },
            { "cS", "<Plug>CSurround", desc = "change surrounding #1 by #2 + new line" },
            { "ys", "<Plug>Ysurround", desc = "wraps #1 in #2 (surround)" },
            { "yS", "<Plug>YSurround", desc = "wraps #1 in #2 (surround) + new line" },
            { "yss", "<Plug>Yssurround", desc = "wraps line in #1 (surround)" },
            { "ySs", "<Plug>YSsurround", desc = "wraps line in #1 (surround) + new line" },
            { "ySS", "<Plug>YSsurround", desc = "wraps line in #1 (surround) + new line" },
            { "gs", "<Plug>VSurround", desc = "wraps visual selection in #1 (surround)", mode = "x" },
            { "gS", "<Plug>VgSurround", desc = "wraps visual selection in #1 (surround) + new line", mode = "x" },
        },
        init = function()
            vim.g.surround_no_mappings = 1
        end
}