fix(state): use cached mode. Fixes #787. Closes #789

Author: folke

lua/which-key/mappings.lua

@@ -276,7 +276,7 @@ function M.add(mapping, ret, opts)
     local modes = mapping.mode or { "n" } --[[@as string|string[] ]]
     modes = type(modes) == "string" and vim.split(modes, "") or modes --[[@as string[] ]]
     for _, mode in ipairs(modes) do
-      if mode ~= "v" and mode ~= Util.mapmode(mode) then
+      if mode ~= "v" and mode ~= Util.mapmode({ mode = mode }) then
         M.warn("Invalid mode `" .. mode .. "`", mapping)
       end
       local m = vim.deepcopy(mapping)

lua/which-key/state.lua

@@ -89,11 +89,16 @@ function M.setup()
     return Config.defer(ctx)
   end
 
-  local cooldown = Util.cooldown()
   -- this prevents restarting which-key in the same tick
+  local cooldown = Util.cooldown()
+
+  -- cache the mode, since it can change outside of ModeChanged events
+  Util.mode = vim.api.nvim_get_mode().mode
+
   vim.api.nvim_create_autocmd("ModeChanged", {
     group = group,
     callback = function(ev)
+      Util.mode = vim.api.nvim_get_mode().mode
       Util.trace("ModeChanged(" .. ev.match .. ")")
       local mode = Buf.get()
 

lua/which-key/util.lua

@@ -17,6 +17,7 @@ M.BS = M.t("<bs>")
 M.EXIT = M.t("<C-\\><C-n>")
 M.LUA_CALLBACK = "\x80\253g"
 M.CMD = "\x80\253h"
+M.mode = "n"
 
 function M.exit()
   vim.api.nvim_feedkeys(M.EXIT, "n", false)
@@ -76,9 +77,10 @@ function M.keys(lhs, opts)
   return ret
 end
 
----@param mode? string
-function M.mapmode(mode)
-  mode = mode or vim.api.nvim_get_mode().mode
+---@param opts? {mode?: string, cached?: boolean}
+function M.mapmode(opts)
+  opts = opts or {}
+  local mode = opts.mode or (opts.cached ~= false and M.mode) or vim.api.nvim_get_mode().mode
   mode = mode:gsub(M.t("<C-V>"), "v"):gsub(M.t("<C-S>"), "s"):lower()
   if mode:sub(1, 2) == "no" then
     return "o"