feature: Stable API for retrieving keymap definitions

[mrjones2014]

Did you check the docs?

• I have read all the lazy.nvim docs

Is your feature request related to a problem? Please describe.

Hi, feel free to close if you feel its out of scope or not planned etc.

I was just wondering if you'd consider supporting a stable, public API for retrieving keymap tables from plugin specs.

In legendary.nvim I've got an extension that auto-loads all keymaps defined via lazy.nvim into legendary. I got the original implementation from you in GitHub Discussions.

However, yesterday, there was a breaking change in the API, so I fixed it with this PR. It seems like this is a private API which doesn't necessarily remain stable.

Describe the solution you'd like

A simple, public API for grabbing all keymaps defined in plugin specs, maybe something like this?

local lazy = require('lazy')
for plugin, spec in pairs(lazy.get_specs()) do
  local keys = lazy.get_keymaps(plugin, spec)
  -- do whatever with the keys tables
end

Describe alternatives you've considered

PR to fix when there's breaking changes. Which is fine if you decide that's the answer.

Additional context

No response

[folke]

I just responded to your PR. You can get the plugin's keymaps with:

local keys = plugin._.handlers.keys or {}

So you no longer need to use the internal Handler apis.

I can't promise this will always remain where it is now.

Plugin._ contains state information about a plugin in lazy.

[mrjones2014]

Sounds good. Thanks for the context and PR comment!

[folke]

One caveat. plugin._.handlers can actually be nil as well.
But it should always hold a value at the time legendary loads.

But maybe better to add an extra check there just in case :)

[mrjones2014]

It looks like, at the time legendary is loaded, it's nill for lazy.nvim's own plugin spec, but none others. I used vim.tbl_get to safely get the value. Thanks!

[folke]

Ah right, yes, lazy.nvim's spec is a special case. No handlers for that one.