Disable in specific filetypes

[llakala]

Would it be possible to add an option to exclude some filetypes from having surround maps?

I'm facing an issue with Fugitive, where I'd like d to trigger the inline diff there. However, I have ds mapped in nvim-surround, so d always needs to go through timeout. Surround doesn't make sense in a fugitive context, but I can't just :unmap the bind, since the unmap will apply to other filetypes as well.

Ideally, nvim-surround would provide an interface like this:

require("nvim-surround").setup({
  disabled_filetypes = { "fugitive" }
})

Then, the keymaps binds would only happen within an autocmd, where the pattern excludes any filetype in the list.

[kylechui]

As a temporary workaround, you could use the buffer_setup function call and disable the keymap by setting it to false. This can be done in after/ftplugin/fugitive.lua to only disable the keymap for your particular filetype.

In general, I do regret exposing keymaps as a part of the setup function call. I think that a cleaner/simpler approach would be to just not set up keymaps by default, and have the user choose when/when not to do things themselves.

[llakala]

Are you sure that works? I just tried it, and am getting the same issue with this minimal setup:

-- nvim/after/ftplugin/fugitive.lua
vim.cmd([[
  " Remove the default d binds, so we can map `d` to inline diff
  nunmap <buffer> dp
  nunmap <buffer> dd
  nunmap <buffer> dv
  nunmap <buffer> ds
  nunmap <buffer> dh
  nunmap <buffer> dq
  nunmap <buffer> d?
]])

-- d for diff
vim.keymap.set("n", "d", "<plug>fugitive:=", {
  buffer = true,
})

require("nvim-surround").buffer_setup({
  keymaps = {
    delete = false,
  },
})

[kylechui]

Ah I think I see the issue---it seems like the keymap might still be getting set, just set to <NOP>. This can be checked via :verbose nmap d. Not quite sure why the nunmap strategy isn't working by itself though 🤔

[kylechui]

It seems like you can add nowait = true to the keymap to solve your immediate issue though, right after buffer = true.