navigate hunks with virtual text keymaps

Author: olimorris

lua/codecompanion/diff/keymaps.lua

@@ -38,7 +38,7 @@ end
 M.always_accept = {
   desc = "Always accept changes from this chat buffer",
   callback = function(diff_ui)
-    log:trace("[Diff] Accepting diff for id=%s", tostring(diff_ui.diff_id))
+    log:trace("[Diff] Accepting diff for id=%s", diff_ui.diff_id)
     notify(diff_ui.diff_id, true)
 
     local approvals = require("codecompanion.interactions.chat.tools.approvals")
@@ -55,7 +55,7 @@ M.always_accept = {
 M.accept_change = {
   desc = "Accept all changes",
   callback = function(diff_ui)
-    log:trace("[Diff] Accepting diff for id=%s", tostring(diff_ui.diff_id))
+    log:trace("[Diff] Accepting diff for id=%s", diff_ui.diff_id)
     notify(diff_ui.diff_id, true)
 
     local Diff = require("codecompanion.diff")
@@ -69,7 +69,7 @@ M.accept_change = {
 M.reject_change = {
   desc = "Reject all changes",
   callback = function(diff_ui)
-    log:trace("[Diff] Rejecting diff for id=%s", tostring(diff_ui.diff_id))
+    log:trace("[Diff] Rejecting diff for id=%s", diff_ui.diff_id)
     notify(diff_ui.diff_id, false)
 
     local Diff = require("codecompanion.diff")
@@ -83,7 +83,7 @@ M.reject_change = {
 M.close_window = {
   desc = "Close window and reject",
   callback = function(diff_ui)
-    log:trace("[Diff] Closing diff window for id=%s", tostring(diff_ui.diff_id))
+    log:trace("[Diff] Closing diff window for id=%s", diff_ui.diff_id)
     notify(diff_ui.diff_id, false, true)
 
     local Diff = require("codecompanion.diff")
@@ -102,11 +102,11 @@ M.next_hunk = {
   end,
 }
 
-M.prev_hunk = {
+M.previous_hunk = {
   desc = "Previous hunk",
   callback = function(diff_ui)
     local cursor = api.nvim_win_get_cursor(diff_ui.winnr)
-    diff_ui:prev_hunk(cursor[1])
+    diff_ui:previous_hunk(cursor[1])
   end,
 }
 

lua/codecompanion/diff/ui.lua

@@ -29,15 +29,21 @@ end
 
 ---Show instructions for diff interaction
 ---@param bufnr number
----@param namespace number
+---@param opts {namespace: number, line?: number, clear?: boolean}
 ---@return nil
-local function show_keymaps(bufnr, namespace)
+local function show_keymaps(bufnr, opts)
+  local namespace = "codecompanion_diff_ui_" .. tostring(opts.namespace)
+
   local always_accept = config.interactions.inline.keymaps.always_accept.modes.n
   local accept = config.interactions.inline.keymaps.accept_change.modes.n
   local reject = config.interactions.inline.keymaps.reject_change.modes.n
   local next_hunk = config.interactions.inline.keymaps.next_hunk.modes.n
   local previous_hunk = config.interactions.inline.keymaps.previous_hunk.modes.n
 
+  if opts.clear then
+    ui_utils.clear_notification(bufnr, { namespace = namespace })
+  end
+
   ui_utils.show_buffer_notification(bufnr, {
     text = string.format(
       "[%s] Always Accept | [%s] Accept | [%s] Reject | [%s]/[%s] Next/Prev hunks | [q] Close",
@@ -48,8 +54,8 @@ local function show_keymaps(bufnr, namespace)
       previous_hunk
     ),
     main_hl = "CodeCompanionChatSubtext",
-    line = 0,
-    namespace = "codecompanion_diff_ui_" .. namespace,
+    line = opts.line or 0,
+    namespace = namespace,
   })
 end
 
@@ -59,29 +65,35 @@ function DiffUI:next_hunk(line)
   for _, hunk in ipairs(self.diff.hunks) do
     local hunk_line = hunk.pos[1] + 1
     if hunk_line > line then
+      show_keymaps(self.bufnr, { clear = true, namespace = self.diff.namespace, line = hunk_line - 2 })
       return ui_utils.scroll_to_line(self.bufnr, hunk_line)
     end
   end
 
   if #self.diff.hunks > 0 then
-    ui_utils.scroll_to_line(self.bufnr, self.diff.hunks[1].pos[1] + 1)
+    line = self.diff.hunks[1].pos[1] + 1
+    show_keymaps(self.bufnr, { clear = true, namespace = self.diff.namespace, line = line - 2 })
+    ui_utils.scroll_to_line(self.bufnr, line)
   end
 end
 
 ---Navigate to previous hunk
 ---@param line number
 ---@return nil
-function DiffUI:prev_hunk(line)
+function DiffUI:previous_hunk(line)
   for i = #self.diff.hunks, 1, -1 do
     local hunk = self.diff.hunks[i]
     local hunk_line = hunk.pos[1] + 1
     if hunk_line < line then
+      show_keymaps(self.bufnr, { clear = true, namespace = self.diff.namespace, line = hunk_line - 2 })
       return ui_utils.scroll_to_line(self.bufnr, hunk_line)
     end
   end
 
   if #self.diff.hunks > 0 then
-    ui_utils.scroll_to_line(self.bufnr, self.diff.hunks[#self.diff.hunks].pos[1] + 1)
+    line = self.diff.hunks[#self.diff.hunks].pos[1] + 1
+    show_keymaps(self.bufnr, { clear = true, namespace = self.diff.namespace, line = line - 2 })
+    ui_utils.scroll_to_line(self.bufnr, line)
   end
 end
 
@@ -149,7 +161,7 @@ function M.show(diff, opts)
   -- Apply diff extmarks
   local Diff = require("codecompanion.diff")
   Diff.apply(diff, bufnr)
-  show_keymaps(bufnr, diff.namespace)
+  show_keymaps(bufnr, { namespace = diff.namespace })
 
   -- Lock the buffer so the user can't make any changes
   vim.bo[bufnr].modified = false

lua/codecompanion/helpers.lua

@@ -23,7 +23,7 @@ function M.get_prompt_aliases()
 end
 
 ---Create and show a diff in a floating window
----@param args { from_lines: string[], to_lines: string[], ft: string, chat_bufnr?: number, title?: string, diff_id: number, width?: number, height?: number }
+---@param args { from_lines: string[], to_lines: string[], ft: string, chat_bufnr?: number, tool_name?: string, title?: string, diff_id: number }
 ---@return CC.Diff diff, number bufnr, number winnr
 function M.show_diff(args)
   local bufnr = vim.api.nvim_create_buf(false, true)
@@ -38,12 +38,11 @@ function M.show_diff(args)
   })
 
   local diff_ui = require("codecompanion.diff.ui")
-  local bufnr, winnr = diff_ui.show(diff_obj, {
-    chat_bufnr = args.chat_bufnr,
+  return diff_ui.show(diff_obj, {
     diff_id = args.diff_id,
+    chat_bufnr = args.chat_bufnr,
+    tool_name = args.tool_name,
   })
-
-  return diff_obj, bufnr, winnr
 end
 
 return M

lua/codecompanion/utils/diff_test.lua

@@ -177,7 +177,7 @@ function M.run_visual_test(test_num)
   local helpers = require("codecompanion.helpers")
   local diff_id = math.random(10000000)
 
-  local diff_obj, bufnr, winnr = helpers.show_diff({
+  local diff_ui = helpers.show_diff({
     from_lines = before_lines,
     to_lines = after_lines,
     ft = test_case.filetype,
@@ -186,24 +186,24 @@ function M.run_visual_test(test_num)
   })
 
   -- Add keymaps for cycling through test cases
-  local keymap_opts = { buffer = bufnr, silent = true, nowait = true }
+  local keymap_opts = { buffer = diff_ui.bufnr, silent = true, nowait = true }
 
   vim.keymap.set("n", "n", function()
     local next_test = test_num % #M.test_cases + 1
     local Diff = require("codecompanion.diff")
-    Diff.clear(diff_obj)
-    if vim.api.nvim_win_is_valid(winnr) then
-      vim.api.nvim_win_close(winnr, true)
+    Diff.clear(diff_ui.diff)
+    if vim.api.nvim_win_is_valid(diff_ui.winnr) then
+      vim.api.nvim_win_close(diff_ui.winnr, true)
     end
     M.run_visual_test(next_test)
   end, vim.tbl_extend("force", keymap_opts, { desc = "Next test case" }))
 
   vim.keymap.set("n", "p", function()
     local prev_test = test_num == 1 and #M.test_cases or test_num - 1
     local Diff = require("codecompanion.diff")
-    Diff.clear(diff_obj)
-    if vim.api.nvim_win_is_valid(winnr) then
-      vim.api.nvim_win_close(winnr, true)
+    Diff.clear(diff_ui.diff)
+    if vim.api.nvim_win_is_valid(diff_ui.winnr) then
+      vim.api.nvim_win_close(diff_ui.winnr, true)
     end
     M.run_visual_test(prev_test)
   end, vim.tbl_extend("force", keymap_opts, { desc = "Previous test case" }))
@@ -242,7 +242,7 @@ function M.run_visual_test(test_num)
     end,
   })
 
-  return diff_obj
+  return diff_ui
 end
 
 return M

tests/utils/test_ui.lua

@@ -145,7 +145,6 @@ T["UI create_float Screenshots"]["Uses existing buffer with content overwrite (d
       filetype = "lua",
       title = "Debug Chat Info",
       style = "minimal",
-      show_dim = true,
     })
 
     -- Verify new content was set