feat(inline): add keymap to stop request (#2426)

Closes #2420

Author: olimorris

doc/codecompanion.txt

@@ -1,4 +1,4 @@
-*codecompanion.txt*        For NVIM v0.11        Last change: 2025 November 19
+*codecompanion.txt*        For NVIM v0.11        Last change: 2025 November 23
 
 ==============================================================================
 Table of Contents                            *codecompanion-table-of-contents*
@@ -878,10 +878,9 @@ The configuration for both types of adapters is exactly the same, however they
 sit within their own tables (`adapters.http.*` and `adapters.acp.*`) and have
 different options available. HTTP adapters use `models` to allow users to
 select the specific LLM they’d like to interact with. ACP adapters use
-`commands` to allow users to customize their interaction with agents
-(e.g. enabling `yolo` mode). As there is a lot of shared functionality between
-the two adapters, it is recommend that you read this page alongside the ACP
-one.
+`commands` to allow users to customize their interaction with agents (e.g.�
+enabling `yolo` mode). As there is a lot of shared functionality between the
+two adapters, it is recommend that you read this page alongside the ACP one.
 
 
 CHANGING THE DEFAULT ADAPTER ~
@@ -913,7 +912,7 @@ the adapter’s URL, headers, parameters and other fields at runtime.
 
 Supported `env` value types: - **Plain environment variable name (string)**: if
 the value is the name of an environment variable that has already been set
-(e.g. `"HOME"` or `"GEMINI_API_KEY"`), the plugin will read the value. -
+(e.g.� `"HOME"` or `"GEMINI_API_KEY"`), the plugin will read the value. -
 **Command (string prefixed with cmd:)**: any value that starts with `cmd:` will
 be executed via the shell. Example: `"cmd:op read
 op://personal/Gemini/credential --no-newline"`. - **Function**: you can provide
@@ -2214,8 +2213,26 @@ The inline assistant supports keymaps for accepting or rejecting changes:
     })
 <
 
-In this example, `<leader>a` (or `ga` on some keyboards) accepts inline
-changes, while `gr` rejects them.
+In this example, `ga` accepts inline changes, while `gr` rejects them.
+
+You can also cancel an inline request with:
+
+>lua
+    require("codecompanion").setup({
+      strategies = {
+        inline = {
+          keymaps = {
+            stop = {
+              modes = { n = "q" },
+              index = 4,
+              callback = "keymaps.stop",
+              description = "Stop request",
+            },
+          },
+        },
+      },
+    })
+<
 
 
 VARIABLES ~
@@ -2952,7 +2969,7 @@ The fastest way to copy an LLM’s code output is with `gy`. This will yank the
 nearest codeblock.
 
 
-APPLYING AN LLM’S EDITS TO A BUFFER OR FILE ~
+APPLYING AN LLM€�S EDITS TO A BUFFER OR FILE ~
 
 The |codecompanion-usage-chat-buffer-tools-files| tool, combined with the
 |codecompanion-usage-chat-buffer-variables.html-buffer| variable or
@@ -5020,7 +5037,7 @@ These handlers manage tool/function calling:
   as a great reference to understand how they’re working with the output of the
   API
 
-OPENAI’S API OUTPUT
+OPENAI€�S API OUTPUT
 
 If we reference the OpenAI documentation
 <https://platform.openai.com/docs/guides/text-generation/chat-completions-api>
@@ -6927,7 +6944,7 @@ tool to function. In the case of Anthropic, we insert additional headers.
 <
 
 Some adapter tools can be a `hybrid` in terms of their implementation. That is,
-they’re an adapter tool that requires a client-side component (i.e. a
+they’re an adapter tool that requires a client-side component (i.e.� a
 built-in tool). This is the case for the
 |codecompanion-usage-chat-buffer-tools-memory| tool from Anthropic. To allow
 for this, ensure that the tool definition in `available_tools` has

doc/configuration/inline-assistant.md

@@ -36,7 +36,26 @@ require("codecompanion").setup({
 })
 ```
 
-In this example, `<leader>a` (or `ga` on some keyboards) accepts inline changes, while `gr` rejects them.
+In this example, `ga` accepts inline changes, while `gr` rejects them.
+
+You can also cancel an inline request with:
+
+```lua
+require("codecompanion").setup({
+  strategies = {
+    inline = {
+      keymaps = {
+        stop = {
+          modes = { n = "q" },
+          index = 4,
+          callback = "keymaps.stop",
+          description = "Stop request",
+        },
+      },
+    },
+  },
+})
+```
 
 ## Variables
 

lua/codecompanion/config.lua

@@ -688,6 +688,12 @@ The user is working on a %s machine. Please respond with system specific command
           callback = "keymaps.always_accept",
           description = "Accept and enable auto mode",
         },
+        stop = {
+          modes = { n = "q" },
+          index = 4,
+          callback = "keymaps.stop",
+          description = "Stop request",
+        },
       },
       variables = {
         ["buffer"] = {

lua/codecompanion/strategies/inline/init.lua

@@ -258,6 +258,21 @@ function Inline:parse_special_syntax(prompt)
   return vim.trim(prompt)
 end
 
+---Set keymaps for the inline strategy
+---@param bufnr? number
+---@param opts? table
+---@return nil
+function Inline:set_keymaps(bufnr, opts)
+  keymaps
+    .new({
+      bufnr = bufnr,
+      callbacks = require("codecompanion.strategies.inline.keymaps"),
+      data = self,
+      keymaps = config.strategies.inline.keymaps,
+    })
+    :set(opts)
+end
+
 ---Prompt the LLM
 ---@param user_prompt? string The prompt supplied by the user
 ---@return nil
@@ -411,8 +426,7 @@ function Inline:submit(prompt)
   _streaming = self.adapter.opts.stream
   self.adapter.opts.stream = false
 
-  -- Set keymaps and start diffing
-  self:setup_buffer()
+  self:set_keymaps(self.buffer_context.bufnr, { keymaps = { "stop" } })
 
   self.current_request = client
     .new({ adapter = self.adapter:map_schema_to_params(), user_args = { event = "InlineStarted" } })
@@ -505,27 +519,11 @@ function Inline:done(output)
   end)
 end
 
----Setup the buffer prior to sending the request to the LLM
----@return nil
-function Inline:setup_buffer()
-  -- Add a keymap to cancel the request
-  api.nvim_buf_set_keymap(self.buffer_context.bufnr, "n", "q", "", {
-    desc = "Stop the request",
-    callback = function()
-      log:trace("[Inline] Cancelling the request")
-      if self.current_request then
-        self:stop()
-      end
-    end,
-  })
-end
-
 ---Reset the inline prompt class
 ---@return nil
 function Inline:reset()
   self.adapter.opts.stream = _streaming
   self.current_request = nil
-  api.nvim_buf_del_keymap(self.bufnr, "n", "q")
   api.nvim_clear_autocmds({ group = self.aug })
 end
 
@@ -733,14 +731,7 @@ function Inline:start_diff(original_content)
     return self:reset()
   end
 
-  keymaps
-    .new({
-      bufnr = self.buffer_context.bufnr,
-      callbacks = require("codecompanion.strategies.inline.keymaps"),
-      data = self,
-      keymaps = config.strategies.inline.keymaps,
-    })
-    :set()
+  self:set_keymaps(self.buffer_context.bufnr, { exclude_keymaps = { "stop" } })
 
   local provider = config.display.diff.provider
   local ok, diff = pcall(require, "codecompanion.providers.diff." .. provider)

lua/codecompanion/strategies/inline/keymaps.lua

@@ -52,4 +52,12 @@ M.always_accept = {
   end,
 }
 
+M.stop = {
+  callback = function(inline)
+    inline:stop()
+    clear_map(config.strategies.inline.keymaps, inline.diff.bufnr)
+    log:trace("[Inline] Cancelling the request")
+  end,
+}
+
 return M

lua/codecompanion/utils/keymaps.lua

@@ -62,21 +62,30 @@ function Keymaps:resolve(rhs)
 end
 
 ---Set the keymaps
+---@param opts? table
 ---@return nil
-function Keymaps:set()
-  for _, map in pairs(self.keymaps) do
+function Keymaps:set(opts)
+  opts = opts or {}
+
+  for name, map in pairs(self.keymaps) do
+    if opts.keymaps and not vim.tbl_contains(opts.keymaps, name) then
+      goto continue
+    end
+    if opts.exclude_keymaps and vim.tbl_contains(opts.exclude_keymaps, name) then
+      goto continue
+    end
     if map == false then
       goto continue
     end
 
     local callback
     local rhs, action_opts = self:resolve(map.callback)
-    if type(map.condition) == "function" and not map.condition() then
+    if type(map.condition) == "function" and not map.condition(opts) then
       goto continue
     end
 
     local default_opts = { desc = map.description or action_opts.desc, buffer = self.bufnr, nowait = true }
-    local opts = vim.tbl_deep_extend("force", default_opts, map.opts or {})
+    local key_opts = vim.tbl_deep_extend("force", default_opts, map.opts or {})
 
     if type(rhs) == "function" then
       callback = function()
@@ -92,10 +101,10 @@ function Keymaps:set()
       if mode ~= "" then
         if type(key) == "table" then
           for _, v in ipairs(key) do
-            vim.keymap.set(mode, v, callback, opts)
+            vim.keymap.set(mode, v, callback, key_opts)
           end
         else
-          vim.keymap.set(mode, key, callback, opts)
+          vim.keymap.set(mode, key, callback, key_opts)
         end
       end
     end

tests/config.lua

@@ -369,6 +369,7 @@ return {
     },
     inline = {
       adapter = "test_adapter",
+      keymaps = og_config.strategies.inline.keymaps,
       variables = {
         ["foo"] = {
           callback = vim.fn.getcwd() .. "/tests/strategies/inline/variables/foo.lua",