Tip: define your custom surrounds in one place

[smjonas]

If you're like me, you might prefer to keep all your custom surrounds in one place instead of storing them in different files in the filetype directory. Here's how you can achieve that. Simply create a file similar to the following one and require it in packer.nvim's config function:

local custom_surrounds = {
  vimwiki = {
    ["l"] = {
      -- Your custom surround for the "l" character in Vimwiki files,
      -- e.g. https://github.com/kylechui/nvim-surround/discussions/53#discussioncomment-3134891
    },
  },
  lua = {
    ["p"] = {
      -- Custom "p" surround for Lua files,
      -- source: https://github.com/kylechui/nvim-surround/discussions/53#discussioncomment-3341113
      add = { "vim.pretty_print(", ")" },
      find = "vim%.pretty_print%b()",
      delete = "^(vim%.pretty_print%()().-(%))()$",
      change = {
        target = "^(vim%.pretty_print%()().-(%))()$",
      },
    },
  },
}

local group = vim.api.nvim_create_augroup("custom_surrounds", {})
vim.api.nvim_create_autocmd("FileType", {
  group = group,
  pattern = "*",
  callback = function(opts)
    local surrounds = custom_surrounds[opts.match]
    if surrounds then
      require("nvim-surround").buffer_setup { surrounds = surrounds }
    end
  end,
})

Inside the autocommand callback, opts.match is the filetype of the current buffer. I then call nvim-surround's buffer_setup function with the custom_surrounds if there are any for that filetype.