Add explorer integration after snacks has already setup

[thevinchi]

I've added two actions to the explorer which call commands exposed by a different plugin. So far this is working great! However, I would rather create these definitions later when the dependent plugin has loaded. Currently this is what I'm doing, which works perfectly:

{
    "folke/snacks.nvim",
    opts = {
        explorer = {
            enabled = true,
            replace_netrw = true
        },
        picker = {
            enabled = true,
            actions = {
                transfer_up = function(picker, item)
                    vim.cmd.TransferUpload(item.file)
                end,
                transfer_down = function(picker, item)
                    vim.cmd.TransferDownload(item.file)
                end,
            },
            sources = {
                explorer = {
                    win = {
                        list = {
                            keys = {
                                ['tu'] = 'transfer_up',
                                ['td'] = 'transfer_down',
                            }
                        }
                    }
                }
            }
        },
  ... snip ...

While this is working, I would rather do something like this:

return {
    'transfer.nvim',
    config = function()
        require 'transfer'.setup {}

        require 'snacks'.setup {
            ... config here ...
        }
    end
}

However, when I tried this I received an error notification that snacks was already setup, which makes sense. Any suggestions or perhaps should I just live with having the definitions live in the snacks config block?

[drowning-cat]

https://github.com/folke/snacks.nvim/blob/main/docs/picker.md#-examples

[thevinchi]

Well don't I feel silly, I read right past that example. Thank you!

[drowning-cat]

It doesn’t really answer the question properly, so let me explain a bit more in depth. I’m pretty sure there’s a way to lazily extend actions when the plugin is loaded, but it would require touching some implementation details.

The main idea of lazy.nvim is that it merges opts when there are multiple configurations for the same plugin, but it only calls the setup function once. When you define optional = true, you’re basically saying: "merge everything inside specs with other plugins if the parent plugin is defined somewhere." It doesn’t lazily merge the specs for snacks.nvim later — instead, it merges them right when snacks.nvim is loaded.

[drowning-cat]

You can achieve a better effect by simply defining the plugin that snacks.nvim configuration depends on in the dependencies field provided by lazy.nvim. That way, both plugins will be loaded when snacks.nvim is loaded. You can actually define the plugin as a dependency and keep its main configuration in a separate file, as long as both of them do not define a config function.

Alternatively, you can wrap the key in a pcall, which will silently prevent errors. Another option is to check inside the keymap whether the plugin exists before using it. And of course, you could also dig into the internals of snacks.nvim, though that’s usually less ideal.