[Feature]: plugin integrations

[mrjones2014]

Similar Issues

• Before filing, I have searched for similar issues.

Description

Just toying with an idea, what if we could integrate with various other plugins that add default keymaps? For example diffview.nvim adds a bunch of keymaps when diffview is open, we could built an integration that would automatically show them in the legendary finder.

[doctoromer]

I tried to integrate it with packer.nvim and failed. My goal is to have keymaps of lazy-loaded plugins displayed in the legendary API before the plugin is actually loaded.
I tried to use the helpers module, but it clashes with packer's bindings for lazy loading.

[mrjones2014]

For now you should be able to manually add the keymaps to legendary. There isn’t a great way to do it automatically at the moment.

I need to put a lot more thought into this.

[doctoromer]

Is there a way to add a keymap without actually mapping it? My goal is to prevent collision with packer's lazy-loaded-by-keys plugins.

[mrjones2014]

Yes, just don’t provide an implementation (2nd list element), just keys and description. See: https://github.com/mrjones2014/legendary.nvim/blob/master/doc/table_structures/KEYMAPS.md

[doctoromer]

Oh, your'e right. I must have missed that.
Thank you very much!

[mrjones2014]

We’ll be starting with nvim-tree. My comment from #289:

Hey there, this is awesome, thanks for filing the issue!

This may be better suited actually for #184, nvim-tree is probably a good candidate for a first one for a proof of concept.

I'm not sure exactly what they will look like, but I have a few ideas. The best idea I have currently is along the lines of:

Legendary.nvim must be loaded before other plugins. We have a set of plugins, or plugins can be provided by the other plugin itself, at legendary.plugins.[plugin name]. This way, plugins can be looked up dynamically; that is, if they wanted to, nvim-tree could provide its own legendary.nvim integration by adding lua/legendary/plugins/nvim_tree.lua in their repo, just for an example.

The plugin is just a plugin-specific script that must handle registering its keymaps, commands, autocmds, and functions. It may set up autocmds to do so on BufEnter for example, or it may call some custom logic to determine the correct buffer to attach to.

So for this example, and nvim-tree / legendary.nvim plugin would look like:

User's config:

require('legendary').setup({
  plugins = {
    nvim_tree = true,
  }
})

File: lua/legendary/plugins/nvim_tree.lua

vim.api.nvim_create_autocmd('FileType', {
  pattern = 'NvimTree',
  once = true,
  callback = function()
        local   nvimtreemappings = require("nvim-tree.keymap").keymaps
        local   keystodisable    = vim.tbl_map(function(e) return e.key end, nvimtreemappings)
        -- Set up Legendary plugin keybindigns
        local keymaps = vim.tbl_map(function(e)
            -- just set up a description-only keymap
            local entry = {}
            entry.mode  = "n"
            entry[1]    = e.key        -- Key
            if type(e.key) == "table" then entry[1] = e.key[1] end
            entry.description = "Nvim-tree: " .. e.desc
            entry.opts = { buffer = bufnr, noremap = true }
            return entry
        end, nvimtreemappings)
        require('legendary').keymaps(keymaps)
  end
})

[mrjones2014]

See also:

• Expose DEFAULT_KEYMAPS And Current Mappings nvim-tree/nvim-tree.lua#1858
• Event.TreeAttachedPost nvim-tree/nvim-tree.lua#1869

[hinell]

@mrjones2014 You may also want to take a look at how persisted.nvim deals with Telescope integration over here.

[hinell]

@mrjones2014 Minor feedback here. I think Legendary dont' needs a sophisticated module-resolving system akin to Telescope one. The best way to handle plugins IMO by registering a plugin table (object) with a meta information and init function that is provided by api instance e.g.:

   local legendary = require("legendary")
   legendary.plugins:add({
      name = "FooPlugin",
      init = function(api)
         api.register({ keymaps = { ... } })
      end
)

I have seen this approach many times in Web development tools.