How to turn off default mappings

[benbrastmckie]

I'm also switching from the old surround plugins to this one, and would like to turn off most of the default mappings which I don't use, keeping just the few that I do. I imagine there must be a way to do this, but couldn't find anything in the existing discussion or issues.

I would also like to use the few surround functions that I use via WhichKey. Right now it works OK mapping <space>ss to ys and etc., however, if it was possible to put whatever it is that ys triggers in place of ys, that would be preferable. I see that ys corresponds to normal under keymaps which is under M.default_opts in the config, however, given my limited understanding of how lua works, I can't see my way all the way to an answer to my question. Any help would be greatly appreciated.

[kylechui]

As per :h nvim-surround.configuration,

However, to disable any default behavior, the corresponding value needs to explicitly be set to `false`.

In your case, set the corresponding keymaps to false in the setup function, i.e.

require('nvim-surround').setup({
    keymaps = {
        insert = false,
    }
})

The default configuration can be found in the config.lua file, or (hopefully) the help menu.

I don't personally use which-key, so if you could provide a bit more context on your issue, I'd be glad to help!

[benbrastmckie]

That's great, thanks so much! WhichKey is easy to configure, though I need to know what command to put in place of COMMAND below:

  s = {
    name = "SURROUND",
    s = { "COMMAND", "surround" },
    d = { "COMMAND", "delete" },
    c = { "COMMAND", "change" },
  },

I've tried putting ys etc., but want to remove these keybindings as well so that all surround features are accessible through WhichKey by hitting <space>sx where x is replaced by either s, d, or c as above.

Typically the commands in WhichKey look something like: <cmd>lua _HTOP_TOGGLE()<cr> or <cmd>Telescope git_branches<cr>, etc.

Thanks again for your help!

[benbrastmckie]

Sorry that wasn't clear. What I had in mind is where you are located at the 'X' in the following:

$ \varphi \wedge [ X \psi \vee ( \chi \right arrow \gamma ) ] $
$ \varphi \wedge [ \psi \vee ( \chi X \right arrow \gamma ) ] $

Then if you trigger the surround-kill command that I am imagining, it would delete the most immediate containing surround-object. So in the first line, the square brackets would go away, and in the second line the round brackets would go away.

Hope that makes more sense.

[kylechui]

Ah, as of right now the s alias is used to target any built-in surrounding pair, so something like dss is possible.

[benbrastmckie]

I see. Is there a corresponding command that I could bind to in WhichKey? Right now I have all the aliases set to false.

My aim here is to keep most of the additions to the vanilla vim bindings in WhichKey for the sake of new users (academics using LaTeX with no knowledge of Vim, etc.). That way they can learn the standard Vim bindings with one of those online trainer programs, and see what else they can do by navigating WhichKey.

I may add a branch which reduces reliance on WhichKey at some point, but for now I want to get this up and running. If there is no command corresponding to dss that's totally fine. The command for delete works great.

[benbrastmckie]

I've started using my new config, and have noticed while working that your surround plugin is quite a bit faster than what I am used to from my vimscript config. Makes such a difference :)

[kylechui]

The aim for nvim-surround is to be extensible, so unfortunately the only keymaps are the ones provided in the setup function. Otherwise I would need to set up different keymaps for ds}, ds', etc.

The speed thing is very interesting, considering I haven't optimized at all and know of a few places that could be better haha.

[benbrastmckie]

Ok so I created a WhichKey binding with the VimTex command <Plug>(vimtex-delim-delete) taken from here. It works great, deleting whatever the closest surround objects are, except for $ ... $. Is there a way to have one command that will delete whatever the closest surround objects are including $? I realise that I could specify $ in telling it what to delete, but it would be nice if I didn't have to. Any thoughts would be greatly appreciated.

[kylechui]

Woops, completely missed this thread. You can configure your own "delete any" surround by setting an alias (should be :h nvim-surround.config.aliases)