fix: support for keymap passthrough to function callbacks

Author: AntoineGS

lua/copilot/keymaps/init.lua

@@ -43,9 +43,17 @@ function M.register_keymap_with_passthrough(mode, key, action, desc)
   local keymap_key = mode .. ":" .. key
   -- Save any existing mapping for this key
   local existing = vim.fn.maparg(key, mode, false, true)
-  if existing and existing.rhs and existing.rhs ~= "" then
-    previous_keymaps[keymap_key] = existing.rhs
-    logger.trace("Saved existing keymap for " .. keymap_key .. ": " .. existing.rhs)
+  if existing then
+    if existing.rhs and existing.rhs ~= "" then
+      previous_keymaps[keymap_key] = { type = "rhs", value = existing.rhs }
+      logger.trace("Saved existing keymap for " .. keymap_key .. ": " .. existing.rhs)
+    elseif existing.callback then
+      previous_keymaps[keymap_key] = { type = "callback", value = existing.callback }
+      logger.trace("Saved existing keymap callback for " .. keymap_key)
+    else
+      previous_keymaps[keymap_key] = nil
+      logger.trace("No existing keymap for " .. keymap_key)
+    end
   else
     previous_keymaps[keymap_key] = nil
     logger.trace("No existing keymap for " .. keymap_key)
@@ -61,8 +69,13 @@ function M.register_keymap_with_passthrough(mode, key, action, desc)
       local prev = previous_keymaps[keymap_key]
 
       if prev then
-        logger.trace("Passing through to previous keymap for " .. keymap_key .. ": " .. prev)
-        vim.api.nvim_feedkeys(vim.api.nvim_replace_termcodes(prev, true, false, true), mode, true)
+        if prev.type == "rhs" then
+          logger.trace("Passing through to previous keymap for " .. keymap_key .. ": " .. prev.value)
+          vim.api.nvim_feedkeys(vim.api.nvim_replace_termcodes(prev.value, true, false, true), mode, true)
+        elseif prev.type == "callback" then
+          logger.trace("Passing through to previous keymap callback for " .. keymap_key)
+          prev.value()
+        end
         return "<Ignore>"
       end
       logger.trace("No previous keymap to pass through for " .. keymap_key)

tests/screenshots/tests-test_keymaps.lua---keymaps()---passthrough-Esc-with-func---return-false,-will-remove-hl

@@ -0,0 +1,23 @@
+--|---------|-----
+01|123            
+02|456            
+03|~              
+04|~              
+05|~              
+06|~              
+07|~              
+08|~              
+09|<e] [+] 1,1 All
+10|W [            
+
+--|---------|-----
+01|000000000000000
+02|000000000000000
+03|111111111111111
+04|111111111111111
+05|111111111111111
+06|111111111111111
+07|111111111111111
+08|111111111111111
+09|222222222222222
+10|333333333333333

tests/test_keymaps.lua

@@ -29,6 +29,23 @@ T["keymaps()"]["passthrough Esc - base test setting highlight"] = function()
   reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 9, 10 }, ignore_attr = { 9, 10 } })
 end
 
+T["keymaps()"]["passthrough Esc with func - return false, will remove hl"] = function()
+  child.o.lines, child.o.columns = 10, 15
+  child.lua(
+    [[vim.keymap.set("n", "<Esc>", function() vim.cmd.nohlsearch() end, { desc = "general clear highlights" })]]
+  )
+  child.lua([[
+    require("copilot.keymaps").register_keymap_with_passthrough("n", "<esc>", function()
+      return false
+    end, "Passthrough Esc")
+  ]])
+  child.type_keys("i123", "<Esc>", "o456", "<Esc>")
+  child.type_keys("/123", "<CR>")
+  child.type_keys("<Esc>")
+
+  reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 9, 10 }, ignore_attr = { 9, 10 } })
+end
+
 T["keymaps()"]["passthrough Esc - return false, will remove hl"] = function()
   child.o.lines, child.o.columns = 10, 15
   child.lua([[vim.keymap.set("n", "<Esc>", "<cmd>noh<CR>", { desc = "general clear highlights" })]])