implement filter for keymaps

[bn-peters]

Description

There was a todo for more flexible filtering in builtin.keymaps (

telescope.nvim/lua/telescope/builtin/__internal.lua

Line 1127 in 7141515

-- TODO: make filtering include the mapping and the action

). I implemented this by adding another filter option accepting a keymap as its argument.

I wanted to use this to only filter keymaps with a desc. While this could be a separate flag, I feel like this is cleaner. lhs_filter is now somewhat redundant.

Type of change

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

How Has This Been Tested?

Setup a keymap with a description, and select it:

vim.keymap.set("n", "abc", "<CR>", { desc = "do something" })
vim.keymap.set("n", "def", "<CR>", { desc = "do something else" })
vim.keymap.set("n", "xyz", function()
                               require("telescope.builtin").keymaps({ 
                                   filter = function(keymap)
                                       return keymap.desc and keymap.desc ~= "Nvim builtin"
                                   end,
                               })
                           end)

Configuration:

• Neovim version (nvim --version):

  NVIM v0.10.0-dev-41b7586
  Build type: Release
  LuaJIT 2.1.0-beta3
  
     system vimrc file: "$VIM/sysinit.vim"
    fall-back for $VIM: "/usr/local/share/nvim"
  

Checklist:

• My code follows the style guidelines of this project (stylua)
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (lua annotations)

[Conni2461]

thanks :)