feat: add cancel keymap for cancelling quick_chat session

Author: sudo-tee

lua/opencode/config.lua

@@ -22,7 +22,6 @@ M.defaults = {
       ['<leader>ot'] = { 'toggle_focus', desc = 'Toggle focus' },
       ['<leader>oT'] = { 'timeline', desc = 'Session timeline' },
       ['<leader>oq'] = { 'close', desc = 'Close Opencode window' },
-      ['<leader>oQ'] = { 'quick_chat', desc = 'Quick chat with current context', mode = { 'n', 'x' } },
       ['<leader>os'] = { 'select_session', desc = 'Select session' },
       ['<leader>oR'] = { 'rename_session', desc = 'Rename session' },
       ['<leader>op'] = { 'configure_provider', desc = 'Configure provider' },
@@ -42,6 +41,7 @@ M.defaults = {
       ['<leader>oPa'] = { 'permission_accept', desc = 'Accept permission' },
       ['<leader>oPA'] = { 'permission_accept_all', desc = 'Accept all permissions' },
       ['<leader>oPd'] = { 'permission_deny', desc = 'Deny permission' },
+      ['<leader>o/'] = { 'quick_chat', desc = 'Quick chat with current context', mode = { 'n', 'x' } },
     },
     output_window = {
       ['<esc>'] = { 'close' },
@@ -91,6 +91,9 @@ M.defaults = {
       delete_entry = { '<C-d>', mode = { 'i', 'n' } },
       clear_all = { '<C-X>', mode = { 'i', 'n' } },
     },
+    quick_chat = {
+      cancel = { '<C-c>', mode = { 'i', 'n' } },
+    },
   },
   ui = {
     position = 'right',
@@ -221,18 +224,6 @@ M.defaults = {
 
 M.values = vim.deepcopy(M.defaults)
 
----Get function names from keymap config, used when normalizing legacy config
----@param keymap_config table
-local function get_function_names(keymap_config)
-  local names = {}
-  for _, config in pairs(keymap_config) do
-    if type(config) == 'table' and config[1] then
-      table.insert(names, config[1])
-    end
-  end
-  return names
-end
-
 local function update_keymap_prefix(prefix, default_prefix)
   if prefix == default_prefix or not prefix then
     return

lua/opencode/quick_chat.lua

@@ -20,7 +20,11 @@ local M = {}
 ---@type table<string, OpencodeQuickChatRunningSession>
 local running_sessions = {}
 
---- Creates an ephemeral session title
+--- Global keymaps that are active during quick chat sessions
+---@type table<string, boolean>
+local active_global_keymaps = {}
+
+--- Creates an quicklchat session title
 ---@param buf integer Buffer handle
 ---@return string title The session title
 local function create_session_title(buf)
@@ -32,6 +36,69 @@ local function create_session_title(buf)
   return string.format('[QuickChat] %s:%d (%s)', relative_path, line_num, timestamp)
 end
 
+--- Removes global keymaps for quick chat
+local function teardown_global_keymaps()
+  if not next(active_global_keymaps) then
+    return
+  end
+
+  for key, _ in pairs(active_global_keymaps) do
+    pcall(vim.keymap.del, { 'n', 'i' }, key)
+  end
+
+  active_global_keymaps = {}
+end
+
+--- Cancels all running quick chat sessions
+local function cancel_all_quick_chat_sessions()
+  for session_id, session_info in pairs(running_sessions) do
+    if state.api_client then
+      local ok, result = pcall(function()
+        return state.api_client:abort_session(session_id):wait()
+      end)
+
+      if not ok then
+        vim.notify('Quick chat abort error: ' .. vim.inspect(result), vim.log.levels.WARN)
+      end
+    end
+
+    if session_info and session_info.spinner then
+      session_info.spinner:stop()
+    end
+
+    if config.values.debug.quick_chat and not config.values.debug.quick_chat.keep_session then
+      state.api_client:delete_session(session_id):catch(function(err)
+        vim.notify('Error deleting quicklchat session: ' .. vim.inspect(err), vim.log.levels.WARN)
+      end)
+    end
+
+    running_sessions[session_id] = nil
+  end
+
+  -- Teardown keymaps once at the end
+  teardown_global_keymaps()
+  vim.notify('Quick chat cancelled by user', vim.log.levels.WARN)
+end
+
+--- Sets up global keymaps for quick chat
+local function setup_global_keymaps()
+  if next(active_global_keymaps) then
+    return
+  end
+
+  local quick_chat_keymap = config.keymap.quick_chat or {}
+  if quick_chat_keymap.cancel then
+    vim.keymap.set(quick_chat_keymap.cancel.mode or { 'n', 'i' }, quick_chat_keymap.cancel[1], function()
+      cancel_all_quick_chat_sessions()
+    end, {
+      desc = quick_chat_keymap.cancel.desc or 'Cancel quick chat session',
+      silent = true,
+    })
+
+    active_global_keymaps[quick_chat_keymap.cancel[1]] = true
+  end
+end
+
 --- Helper to clean up session info and spinner
 ---@param session_info table Session tracking info
 ---@param session_id string Session ID
@@ -43,11 +110,17 @@ local function cleanup_session(session_info, session_id, message)
 
   if config.debug.quick_chat and not config.debug.quick_chat.keep_session then
     state.api_client:delete_session(session_id):catch(function(err)
-      vim.notify('Error deleting ephemeral session: ' .. vim.inspect(err), vim.log.levels.WARN)
+      vim.notify('Error deleting quicklchat session: ' .. vim.inspect(err), vim.log.levels.WARN)
     end)
   end
 
   running_sessions[session_id] = nil
+
+  -- Check if there are no more running sessions and teardown global keymaps
+  if not next(running_sessions) then
+    teardown_global_keymaps()
+  end
+
   if message then
     vim.notify(message, vim.log.levels.WARN)
   end
@@ -67,7 +140,7 @@ local function extract_response_text(message)
   return vim.trim(response_text)
 end
 
---- Processes response from ephemeral session
+--- Processes response from quicklchat session
 ---@param session_info table Session tracking info
 ---@param messages OpencodeMessage[] Session messages
 ---@return boolean success Whether the response was processed successfully
@@ -308,7 +381,7 @@ M.quick_chat = Promise.async(function(message, options, range)
   local quick_chat_session = core.create_new_session(title):await()
   if not quick_chat_session then
     spinner:stop()
-    return Promise.new():reject('Failed to create ephemeral session')
+    return Promise.new():reject('Failed to create quicklchat session')
   end
 
   if config.debug.quick_chat and config.debug.quick_chat.set_active_session then
@@ -323,6 +396,9 @@ M.quick_chat = Promise.async(function(message, options, range)
     timestamp = vim.uv.now(),
   }
 
+  -- Set up global keymaps for quick chat
+  setup_global_keymaps()
+
   local context_config = vim.tbl_deep_extend('force', create_context_config(range ~= nil), options.context_config or {})
   local context_instance = context.new_instance(context_config)
   local params = create_message(message, buf, range, context_instance, options):await()
@@ -371,6 +447,7 @@ function M.setup()
         end
       end
       running_sessions = {}
+      teardown_global_keymaps()
     end,
   })
 end

lua/opencode/quick_chat/spinner.lua

@@ -1,19 +1,15 @@
 local config = require('opencode.config')
 local Timer = require('opencode.ui.timer')
 
----@class Timer
----@field start function
----@field stop function
----@field is_running function
-
 ---@class CursorSpinner
 ---@field buf integer
 ---@field row integer
 ---@field col integer
 ---@field ns_id integer
 ---@field extmark_id integer|nil
+---@field highlight_extmark_id integer|nil
 ---@field current_frame integer
----@field timer Timer|nil
+---@field timer table|nil
 ---@field active boolean
 ---@field frames string[]
 ---@field float_win integer|nil
@@ -28,6 +24,7 @@ function CursorSpinner.new(buf, row, col)
   self.col = col
   self.ns_id = vim.api.nvim_create_namespace('opencode_quick_chat_spinner')
   self.extmark_id = nil
+  self.highlight_extmark_id = nil
   self.current_frame = 1
   self.timer = nil
   self.active = true
@@ -58,10 +55,21 @@ function CursorSpinner:create_float()
   vim.api.nvim_set_option_value('wrap', false, { win = self.float_win })
 end
 
+function CursorSpinner:get_cancel_key()
+  local quick_chat_keymap = config.values.keymap.quick_chat or {}
+  return quick_chat_keymap.cancel and quick_chat_keymap.cancel[1] or ''
+end
+
 function CursorSpinner:get_float_config()
+  local cancel_key = self:get_cancel_key()
+  local legend = ' ' .. cancel_key .. ' to cancel'
+  local spinner_width = 3
+  local legend_width = #legend
+  local total_width = spinner_width + legend_width + 1 -- +1 for spacing
+
   return {
     relative = 'cursor',
-    width = 3,
+    width = total_width,
     height = 1,
     row = 0,
     col = 2, -- 2 columns to the right of cursor
@@ -77,8 +85,25 @@ function CursorSpinner:render()
     return
   end
 
-  local frame = ' ' .. self.frames[self.current_frame] .. ' '
-  vim.api.nvim_buf_set_lines(self.float_buf, 0, -1, false, { frame })
+  local spinner_part = ' ' .. self.frames[self.current_frame] .. ' '
+
+  local cancel_key = self:get_cancel_key() or ''
+  local legend_part = cancel_key and ' ' .. cancel_key .. ' to cancel' or ''
+
+  local content = spinner_part .. legend_part
+
+  vim.api.nvim_buf_set_lines(self.float_buf, 0, -1, false, { content })
+
+  if self.highlight_extmark_id and vim.api.nvim_buf_is_valid(self.float_buf) then
+    pcall(vim.api.nvim_buf_del_extmark, self.float_buf, self.ns_id, self.highlight_extmark_id)
+  end
+
+  if vim.api.nvim_buf_is_valid(self.float_buf) then
+    self.highlight_extmark_id = vim.api.nvim_buf_set_extmark(self.float_buf, self.ns_id, 0, #spinner_part + 1, {
+      end_col = #spinner_part + 1 + #cancel_key,
+      hl_group = 'WarningMsg',
+    })
+  end
 end
 
 function CursorSpinner:next_frame()
@@ -98,7 +123,9 @@ function CursorSpinner:start_timer()
     end,
     repeat_timer = true,
   })
-  self.timer:start()
+  if self.timer then
+    self.timer:start()
+  end
 end
 
 function CursorSpinner:stop()
@@ -108,7 +135,7 @@ function CursorSpinner:stop()
 
   self.active = false
 
-  if self.timer then
+  if self.timer and self.timer.stop then
     self.timer:stop()
     self.timer = nil
   end
@@ -124,6 +151,10 @@ function CursorSpinner:stop()
   if self.extmark_id and vim.api.nvim_buf_is_valid(self.buf) then
     pcall(vim.api.nvim_buf_del_extmark, self.buf, self.ns_id, self.extmark_id)
   end
+
+  if self.highlight_extmark_id and vim.api.nvim_buf_is_valid(self.float_buf or self.buf) then
+    pcall(vim.api.nvim_buf_del_extmark, self.float_buf or self.buf, self.ns_id, self.highlight_extmark_id)
+  end
 end
 
 return CursorSpinner

lua/opencode/types.lua

@@ -86,6 +86,7 @@
 ---@field session_picker OpencodeSessionPickerKeymap
 ---@field timeline_picker OpencodeTimelinePickerKeymap
 ---@field history_picker OpencodeHistoryPickerKeymap
+---@field quick_chat OpencodeQuickChatKeymap
 
 ---@class OpencodeSessionPickerKeymap
 ---@field delete_session OpencodeKeymapEntry
@@ -100,6 +101,9 @@
 ---@field delete_entry OpencodeKeymapEntry
 ---@field clear_all OpencodeKeymapEntry
 
+---@class OpencodeQuickChatKeymap
+---@field cancel OpencodeKeymapEntry
+
 ---@class OpencodeCompletionFileSourcesConfig
 ---@field enabled boolean
 ---@field preferred_cli_tool 'server'|'fd'|'fdfind'|'rg'|'git'