fix: ensure keymaps are buffer-aware

Fixes zbirenbaum#573

Author: AntoineGS

lua/copilot/client/init.lua

@@ -101,6 +101,9 @@ function M.buf_attach(force, bufnr)
   end
 
   vim.lsp.buf_attach_client(bufnr, M.id)
+  require("copilot.suggestion").set_keymap(bufnr)
+  require("copilot.nes").set_keymap(bufnr)
+
   util.set_buffer_previous_ft(bufnr, vim.bo[bufnr].filetype)
   if force then
     logger.debug("force attached to buffer")
@@ -116,6 +119,8 @@ function M.buf_detach_if_attached(bufnr)
   bufnr = bufnr or vim.api.nvim_get_current_buf()
   if M.buf_is_attached(bufnr) then
     vim.lsp.buf_detach_client(bufnr, M.id)
+    require("copilot.suggestion").unset_keymap(bufnr)
+    require("copilot.nes").unset_keymap(bufnr)
     util.set_buffer_attach_status(bufnr, util.ATTACH_STATUS_NOT_ATTACHED_PREFIX .. "detached")
   end
 end

lua/copilot/keymaps/init.lua

@@ -30,7 +30,8 @@ end
 ---@param key string
 ---@param action function: boolean
 ---@param desc string
-function M.register_keymap_with_passthrough(mode, key, action, desc)
+---@param bufnr integer
+function M.register_keymap_with_passthrough(mode, key, action, desc, bufnr)
   if not key then
     return
   end
@@ -86,17 +87,19 @@ function M.register_keymap_with_passthrough(mode, key, action, desc)
     desc = desc,
     expr = true,
     silent = true,
+    buffer = bufnr,
   })
 end
 
 ---@param mode string
 ---@param key string|false
-function M.unset_keymap_if_exists(mode, key)
+---@param bufnr integer
+function M.unset_keymap_if_exists(mode, key, bufnr)
   if not key then
     return
   end
 
-  local ok, err = pcall(vim.api.nvim_del_keymap, mode, key)
+  local ok, err = pcall(vim.api.nvim_del_buf_keymap, bufnr, mode, key)
 
   if not ok then
     local suggestion_keymaps = config.suggestion.keymap or {}

lua/copilot/nes/init.lua

@@ -19,26 +19,37 @@ local function accept_suggestion(goto_end)
   return result
 end
 
----@class NesKeymap
-local function set_keymap(keymap)
+---@param bufnr integer
+function M.set_keymap(bufnr)
+  if not config.nes.enabled then
+    return
+  end
+
+  local keymap = config.nes.keymap
+
   keymaps.register_keymap_with_passthrough("n", keymap.accept_and_goto, function()
     return accept_suggestion(true)
-  end, "[copilot] (nes) accept suggestion and go to end")
+  end, "[copilot] (nes) accept suggestion and go to end", bufnr)
 
   keymaps.register_keymap_with_passthrough("n", keymap.accept, function()
     return accept_suggestion(false)
-  end, "[copilot] (nes) accept suggestion")
+  end, "[copilot] (nes) accept suggestion", bufnr)
 
   keymaps.register_keymap_with_passthrough("n", keymap.dismiss, function()
     return nes_api.nes_clear()
-  end, "[copilot] (nes) dismiss suggestion")
+  end, "[copilot] (nes) dismiss suggestion", bufnr)
 end
 
----@param keymap NesKeymap
-local function unset_keymap(keymap)
-  keymaps.unset_keymap_if_exists("n", keymap.accept_and_goto)
-  keymaps.unset_keymap_if_exists("n", keymap.accept)
-  keymaps.unset_keymap_if_exists("n", keymap.dismiss)
+---@param bufnr integer
+function M.unset_keymap(bufnr)
+  if not config.nes.enabled then
+    return
+  end
+
+  local keymap = config.nes.keymap
+  keymaps.unset_keymap_if_exists("n", keymap.accept_and_goto, bufnr)
+  keymaps.unset_keymap_if_exists("n", keymap.accept, bufnr)
+  keymaps.unset_keymap_if_exists("n", keymap.dismiss, bufnr)
 end
 
 ---@param lsp_client vim.lsp.Client
@@ -59,16 +70,13 @@ function M.setup(lsp_client)
     logger.error("copilot-lsp nes failed to load:", err)
   end
 
-  set_keymap(config.nes.keymap)
   M.initialized = true
 end
 
 function M.teardown()
   if not M.initialized then
     return
   end
-
-  unset_keymap(config.nes.keymap)
 end
 
 return M

lua/copilot/panel/init.lua

@@ -238,6 +238,12 @@ function panel:accept()
 end
 
 function panel:close()
+  keymaps.unset_keymap_if_exists("i", panel.keymap.open, self.bufnr)
+  keymaps.unset_keymap_if_exists("n", panel.keymap.accept, self.bufnr)
+  keymaps.unset_keymap_if_exists("n", panel.keymap.jump_prev, self.bufnr)
+  keymaps.unset_keymap_if_exists("n", panel.keymap.jump_next, self.bufnr)
+  keymaps.unset_keymap_if_exists("n", panel.keymap.refresh, self.bufnr)
+
   if self.bufnr and vim.api.nvim_win_is_valid(self.bufnr) then
     self:unlock():clear():lock()
   end
@@ -598,15 +604,6 @@ function M.teardown()
     return
   end
 
-  keymaps.unset_keymap_if_exists("i", panel.keymap.open)
-
-  if M.keymaps_set then
-    keymaps.unset_keymap_if_exists("n", panel.keymap.accept)
-    keymaps.unset_keymap_if_exists("n", panel.keymap.jump_prev)
-    keymaps.unset_keymap_if_exists("n", panel.keymap.jump_next)
-    keymaps.unset_keymap_if_exists("n", panel.keymap.refresh)
-  end
-
   panel:close()
   panel.setup_done = false
 end

lua/copilot/suggestion/init.lua

@@ -119,7 +119,14 @@ local function reset_ctx(ctx)
   ctx.accepted_partial = nil
 end
 
-local function set_keymap(keymap)
+---@param bufnr integer
+function M.set_keymap(bufnr)
+  if not config.suggestion.enabled then
+    return
+  end
+
+  local keymap = config.suggestion.keymap or {}
+
   keymaps.register_keymap_with_passthrough("i", keymap.accept, function()
     local ctx = get_ctx()
     if (config.suggestion.trigger_on_accept and not ctx.first) or M.is_visible() then
@@ -128,12 +135,12 @@ local function set_keymap(keymap)
     end
 
     return false
-  end, "[copilot] accept suggestion")
+  end, "[copilot] accept suggestion", bufnr)
 
-  keymaps.register_keymap("i", keymap.accept_word, M.accept_word, "[copilot] accept suggestion (word)")
-  keymaps.register_keymap("i", keymap.accept_line, M.accept_line, "[copilot] accept suggestion (line)")
-  keymaps.register_keymap("i", keymap.next, M.next, "[copilot] next suggestion")
-  keymaps.register_keymap("i", keymap.prev, M.prev, "[copilot] prev suggestion")
+  keymaps.register_keymap("i", keymap.accept_word, M.accept_word, "[copilot] accept suggestion (word)", bufnr)
+  keymaps.register_keymap("i", keymap.accept_line, M.accept_line, "[copilot] accept suggestion (line)", bufnr)
+  keymaps.register_keymap("i", keymap.next, M.next, "[copilot] next suggestion", bufnr)
+  keymaps.register_keymap("i", keymap.prev, M.prev, "[copilot] prev suggestion", bufnr)
 
   keymaps.register_keymap_with_passthrough("i", keymap.dismiss, function()
     if M.is_visible() then
@@ -142,16 +149,22 @@ local function set_keymap(keymap)
     end
 
     return false
-  end, "[copilot] dismiss suggestion")
+  end, "[copilot] dismiss suggestion", bufnr)
 end
 
-local function unset_keymap(keymap)
-  keymaps.unset_keymap_if_exists("i", keymap.accept)
-  keymaps.unset_keymap_if_exists("i", keymap.accept_word)
-  keymaps.unset_keymap_if_exists("i", keymap.accept_line)
-  keymaps.unset_keymap_if_exists("i", keymap.next)
-  keymaps.unset_keymap_if_exists("i", keymap.prev)
-  keymaps.unset_keymap_if_exists("i", keymap.dismiss)
+---@param bufnr integer
+function M.unset_keymap(bufnr)
+  if not config.suggestion.enabled then
+    return
+  end
+
+  local keymap = config.suggestion.keymap or {}
+  keymaps.unset_keymap_if_exists("i", keymap.accept, bufnr)
+  keymaps.unset_keymap_if_exists("i", keymap.accept_word, bufnr)
+  keymaps.unset_keymap_if_exists("i", keymap.accept_line, bufnr)
+  keymaps.unset_keymap_if_exists("i", keymap.next, bufnr)
+  keymaps.unset_keymap_if_exists("i", keymap.prev, bufnr)
+  keymaps.unset_keymap_if_exists("i", keymap.dismiss, bufnr)
 end
 
 local function stop_timer()
@@ -839,8 +852,6 @@ function M.setup()
     return
   end
 
-  set_keymap(opts.keymap or {})
-
   copilot.auto_trigger = opts.auto_trigger
   copilot.hide_during_completion = opts.hide_during_completion
 
@@ -860,10 +871,7 @@ function M.teardown()
     return
   end
 
-  unset_keymap(opts.keymap or {})
-
   vim.api.nvim_clear_autocmds({ group = copilot.augroup })
-
   copilot.setup_done = false
 end