fix: esc key mapping issues

Fixes #570

Author: AntoineGS

lua/copilot/keymaps/init.lua

@@ -2,15 +2,19 @@ local logger = require("copilot.logger")
 local config = require("copilot.config")
 
 local M = {}
-
 local previous_keymaps = {}
 
 ---@param mode string
 ---@param key string
 ---@param action function
 ---@param desc string
 function M.register_keymap(mode, key, action, desc)
-  if not mode or not key or not action then
+  if not key then
+    return
+  end
+
+  if not mode or not action then
+    logger.error("Invalid parameters to register_keymap" .. vim.inspect({ mode, key, action, desc }))
     return
   end
 
@@ -27,7 +31,12 @@ end
 ---@param action function: boolean
 ---@param desc string
 function M.register_keymap_with_passthrough(mode, key, action, desc)
-  if not mode or not key or not action then
+  if not key then
+    return
+  end
+
+  if not mode or not action then
+    logger.error("Invalid parameters to register_keymap_with_passthrough" .. vim.inspect({ mode, key, action, desc }))
     return
   end
 
@@ -41,16 +50,21 @@ function M.register_keymap_with_passthrough(mode, key, action, desc)
   end
 
   vim.keymap.set(mode, key, function()
-    local action_ran = action()
-    if not action_ran then
-      -- If there was a previous mapping, execute it
+    if action() then
+      return "<Ignore>"
+    else
       local prev = previous_keymaps[keymap_key]
+
       if prev then
         vim.api.nvim_feedkeys(vim.api.nvim_replace_termcodes(prev, true, false, true), mode, true)
+        return "<Ignore>"
       end
+
+      return key
     end
   end, {
     desc = desc,
+    expr = true,
     silent = true,
   })
 end

lua/copilot/nes/init.lua

@@ -12,7 +12,7 @@ local M = {
 local function accept_suggestion(goto_end)
   local result = nes_api.nes_apply_pending_nes()
 
-  if goto_end then
+  if goto_end and result then
     nes_api.nes_walk_cursor_end_edit()
   end
 

tests/screenshots/tests-test_suggestion.lua---suggestion()---accept_word,-1-word,-then-dismiss-with-Esc

@@ -0,0 +1,23 @@
+--|---------|-----
+01|1 2 3          
+02|4 5 6          
+03|7 8            
+04|~              
+05|~              
+06|~              
+07|~              
+08|~              
+09|<e] [+] 3,5 All
+10|-- INSERT --   
+
+--|---------|-----
+01|000000000000000
+02|000000000000000
+03|000000000000000
+04|111111111111111
+05|111111111111111
+06|111111111111111
+07|111111111111111
+08|111111111111111
+09|222222222222222
+10|333333333333444

tests/test_suggestion.lua

@@ -115,6 +115,20 @@ T["suggestion()"]["accept_word, 1 word, then dismiss"] = function()
   reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 9, 10 }, ignore_attr = { 9, 10 } })
 end
 
+T["suggestion()"]["accept_word, 1 word, then dismiss with Esc"] = function()
+  child.o.lines, child.o.columns = 10, 15
+  child.config.suggestion = child.config.suggestion
+    .. "auto_trigger = true,"
+    .. "keymap = { accept_word = '<C-e>', dismiss = '<Esc>' },"
+  child.cmd("e numbers_with_spaces.txt")
+  child.configure_copilot()
+  child.type_keys("i1 2 3", "<Esc>", "o4 5 6", "<Esc>", "o7 ")
+  child.wait_for_suggestion()
+  child.type_keys("<C-e>", "<Esc>")
+
+  reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 9, 10 }, ignore_attr = { 9, 10 } })
+end
+
 T["suggestion()"]["accept_word, 1 word, then accept"] = function()
   child.o.lines, child.o.columns = 10, 15
   child.config.suggestion = child.config.suggestion