feat: added triggers_blacklist to blacklist certain whichkey hooks #73

README.md

@@ -114,7 +114,14 @@ WhichKey comes with the following defaults:
   hidden = { "<silent>", "<cmd>", "<Cmd>", "<CR>", "call", "lua", "^:", "^ "}, -- hide mapping boilerplate
   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 = {"<leader>"} -- or specify a list manually
+  triggers_blacklist = {
+    -- list of mode / prefixes that should never be hooked by WhichKey
+    -- this is mostly relevant for key maps that start with a native binding
+    -- most people should not need to change this
+    i = { "j", "k" },
+    v = { "j", "k" },
+  },
 }
 ```
 

lua/which-key/config.lua

@@ -51,7 +51,12 @@ local defaults = {
   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>
+  triggers_blacklist = {
+    -- list of mode / prefixes that should never be hooked by WhichKey
+    -- this is mostly relevant for keymaps that start with a native binding
+    i = { "j", "k" },
+    v = { "j", "k" },
+  },
 }
 
 ---@type Options

lua/which-key/keys.lua

@@ -11,6 +11,7 @@ local M = {}
 M.functions = {}
 M.operators = {}
 M.nowait = {}
+M.blacklist = {}
 
 function M.setup()
   local builtin_ops = require("which-key.plugins.presets").operators
@@ -29,6 +30,12 @@ function M.setup()
   end
   M.register(mappings, { mode = "n" })
   M.register({ i = { name = "inside" }, a = { name = "around" } }, { mode = "v" })
+  for mode, blacklist in pairs(Config.options.triggers_blacklist) do
+    for _, prefix in ipairs(blacklist) do
+      M.blacklist[mode] = M.blacklist[mode] or {}
+      M.blacklist[mode][prefix] = true
+    end
+  end
 end
 
 function M.get_operator(prefix)
@@ -306,6 +313,10 @@ function M.hook_del(prefix, mode, buf)
 end
 
 function M.hook_add(prefix, mode, buf, secret_only)
+  -- check if this trigger is blacklisted
+  if M.blacklist[mode] and M.blacklist[mode][prefix] then
+    return
+  end
   -- don't hook to j or k in INSERT mode
   if mode == "i" and (prefix == "j" or prefix == "k") then
     return