feat(search): add fuzzy search for keybindings by description#1060
Open
MrZeLee wants to merge 1 commit into
Open
feat(search): add fuzzy search for keybindings by description#1060MrZeLee wants to merge 1 commit into
MrZeLee wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a fuzzy keymap search to which-key: instead of drilling through the
popup, you can search for a keybinding by its description and execute it.
It walks which-key's existing per-mode keymap tree to collect every executable
keybinding for the current mode and buffer, then presents them through
vim.ui.select, so it integrates with whatever picker the user already has(builtin, telescope, snacks, fzf-lua, dressing, …) with no hard dependency.
Each entry shows the formatted key sequence plus a description breadcrumb that
prepends parent group names (e.g.
git → commit changes). Picking an entryfeeds its keys to execute the binding.
This keeps the implementation small and self-contained — a new
lua/which-key/search.luamodule plus thin entry points; no changes to theexisting rendering/state code.
Usage
Changes
lua/which-key/search.lua(new) — collect → format →vim.ui.select→ execute.lua/which-key/init.lua— exposerequire("which-key").search(opts).lua/which-key/config.lua— register the:WhichKeySearch [mode]command.README.md— feature bullet and a "Search" section.Related Issue(s)
Screenshots