feat: option to make some triggers show immediately, regardless of ti…

…meoutlen

README.md

@@ -60,10 +60,10 @@ use {
 > ❗️ IMPORTANT: the timeout when **WhichKey** opens is controlled by the vim setting [timeoutlen](https://neovim.io/doc/user/options.html#'timeoutlen').
 > Please refer to the documentation to properly set it up. Setting it to `0`, will effectively
 > always show **WhichKey** immediately, but a setting of `500` (500ms) is probably more appropriate.
-> 
+
 > ❗️ don't create any keymappings yourself to trigger WhichKey. Unlike with *vim-which-key*, we do this fully automatically.
 > Please remove any left-over triggers you might have from using *vim-which-key*.
->
+
 > 🚑 You can run `:checkhealth which_key` to see if there's any conflicting keymaps that will prevent triggering **WhichKey**
 
 WhichKey comes with the following defaults:
@@ -109,6 +109,8 @@ WhichKey comes with the following defaults:
   show_help = true, -- show help message on the command line when the popup is visible
   triggers = "auto", -- automatically setup triggers
   -- triggers = {"<leader>"} -- or specifiy a list manually
+  triggers_nowait = {}, -- list of triggers, where WhichKey should not wait for timeoutlen and show immediately
+  -- triggers_nowait = {"<leader>"} -- shows WK immediately when hitting <leader>
 }
 ```
 

lua/which-key/config.lua

@@ -43,6 +43,8 @@ local defaults = {
   show_help = true, -- show a help message in the command line for using WhichKey
   triggers = "auto", -- automatically setup triggers
   -- triggers = {"<leader>"} -- or specifiy a list manually
+  triggers_nowait = {}, -- list of triggers, where WhichKey should not wait for timeoutlen and show immediately
+  -- triggers_nowait = {"<leader>"} -- shows WK immediately when hitting <leader>
 }
 
 ---@type Options

lua/which-key/keys.lua

@@ -10,6 +10,7 @@ local M = {}
 
 M.functions = {}
 M.operators = {}
+M.nowait = {}
 
 function M.setup()
   local builtin_ops = require("which-key.plugins.presets").operators
@@ -21,6 +22,7 @@ function M.setup()
       mappings[op] = { name = label, i = { name = "inside" }, a = { name = "around" } }
     end
   end
+  for _, t in pairs(Config.options.triggers_nowait) do M.nowait[t] = true end
   M.register(mappings, { mode = "n" })
   M.register({ i = { name = "inside" }, a = { name = "around" } }, { mode = "v" })
 end
@@ -307,7 +309,7 @@ function M.hook_add(prefix, mode, buf, secret_only)
 
     local mapmode = mode == "v" and "x" or mode
     if secret_only ~= true then M.map(mapmode, prefix, cmd, buf, opts) end
-    M.map(mapmode, prefix .. secret, "<nop>", buf, opts)
+    if not M.nowait[prefix] then M.map(mapmode, prefix .. secret, "<nop>", buf, opts) end
 
     M.hooked[id] = true
   end