chore: move watcher logic (#714)

Co-authored-by: Oli Morris <[email protected]>

Author: olimorris

lua/codecompanion/strategies/chat/init.lua

@@ -591,58 +591,8 @@ function Chat:submit(opts)
 
   local message = ts_parse_messages(self, user_role, self.header_line)
 
-  for _, ref in ipairs(self.refs) do
-    if ref.bufnr and ref.opts and ref.opts.watched then
-      local changes = self.watchers:get_changes(ref.bufnr)
-      log:debug("Checking watched buffer %d, found %d changes", ref.bufnr, changes and #changes or 0)
-
-      if changes and #changes > 0 then
-        local changes_text = string.format(
-          "Changes detected in `%s` (buffer %d):\n",
-          vim.fn.fnamemodify(api.nvim_buf_get_name(ref.bufnr), ":t"),
-          ref.bufnr
-        )
-
-        for _, change in ipairs(changes) do
-          if change.type == "delete" then
-            changes_text = changes_text
-              .. string.format(
-                "Lines %d-%d were deleted:\n```%s\n%s\n```\n",
-                change.start,
-                change.end_line,
-                vim.bo[ref.bufnr].filetype,
-                table.concat(change.lines, "\n")
-              )
-          elseif change.type == "modify" then
-            changes_text = changes_text
-              .. string.format(
-                "Lines %d-%d were modified from:\n```%s\n%s\n```\nto:\n```%s\n%s\n```\n",
-                change.start,
-                change.end_line,
-                vim.bo[ref.bufnr].filetype,
-                table.concat(change.old_lines, "\n"),
-                vim.bo[ref.bufnr].filetype,
-                table.concat(change.new_lines, "\n")
-              )
-          else -- type == "add"
-            changes_text = changes_text
-              .. string.format(
-                "Lines %d-%d were added:\n```%s\n%s\n```\n",
-                change.start,
-                change.end_line,
-                vim.bo[ref.bufnr].filetype,
-                table.concat(change.lines, "\n")
-              )
-          end
-        end
-
-        self:add_message({
-          role = config.constants.USER_ROLE,
-          content = changes_text,
-        }, { visible = true })
-      end
-    end
-  end
+  -- Check if any watched buffers have any changes
+  self.watchers:check_for_changes(self)
 
   if not self:has_user_messages(message) or message.content == "" then
     return log:warn("No messages to submit")

lua/codecompanion/strategies/chat/watchers.lua

@@ -3,61 +3,11 @@ Watchers track changes in Neovim buffers by comparing buffer content over time.
 a state for each watched buffer, recording the current content and last sent content. When
 checked, it compares states to detect line additions, deletions, and modifications.
 ]]
+local config = require("codecompanion.config")
 local log = require("codecompanion.utils.log")
 
 local api = vim.api
 
----@class CodeCompanion.Watchers
-local Watchers = {}
-
-function Watchers.new()
-  return setmetatable({
-    buffers = {},
-    augroup = api.nvim_create_augroup("CodeCompanionWatcher", { clear = true }),
-  }, { __index = Watchers })
-end
-
----Watch a buffer for changes
----@param bufnr number
----@return nil
-function Watchers:watch(bufnr)
-  if self.buffers[bufnr] then
-    return
-  end
-
-  if not api.nvim_buf_is_valid(bufnr) then
-    log:debug("Cannot watch invalid buffer: %d", bufnr)
-    return
-  end
-
-  log:debug("Starting to watch buffer: %d", bufnr)
-  local initial_content = api.nvim_buf_get_lines(bufnr, 0, -1, false)
-
-  self.buffers[bufnr] = {
-    content = initial_content,
-    last_sent = initial_content,
-    changedtick = api.nvim_buf_get_changedtick(bufnr),
-  }
-
-  api.nvim_create_autocmd("BufDelete", {
-    group = self.augroup,
-    buffer = bufnr,
-    callback = function()
-      self:unwatch(bufnr)
-    end,
-  })
-end
-
----Stop watching a buffer
----@param bufnr number
----@return nil
-function Watchers:unwatch(bufnr)
-  if self.buffers[bufnr] then
-    log:debug("Unwatching buffer %d", bufnr)
-    self.buffers[bufnr] = nil
-  end
-end
-
 ---Find the index of a line in a list of lines
 ---@param line string
 ---@param lines table
@@ -184,6 +134,57 @@ local function detect_changes(old_lines, new_lines)
   return changes
 end
 
+---@class CodeCompanion.Watchers
+local Watchers = {}
+
+function Watchers.new()
+  return setmetatable({
+    buffers = {},
+    augroup = api.nvim_create_augroup("CodeCompanionWatcher", { clear = true }),
+  }, { __index = Watchers })
+end
+
+---Watch a buffer for changes
+---@param bufnr number
+---@return nil
+function Watchers:watch(bufnr)
+  if self.buffers[bufnr] then
+    return
+  end
+
+  if not api.nvim_buf_is_valid(bufnr) then
+    log:debug("Cannot watch invalid buffer: %d", bufnr)
+    return
+  end
+
+  log:debug("Starting to watch buffer: %d", bufnr)
+  local initial_content = api.nvim_buf_get_lines(bufnr, 0, -1, false)
+
+  self.buffers[bufnr] = {
+    content = initial_content,
+    last_sent = initial_content,
+    changedtick = api.nvim_buf_get_changedtick(bufnr),
+  }
+
+  api.nvim_create_autocmd("BufDelete", {
+    group = self.augroup,
+    buffer = bufnr,
+    callback = function()
+      self:unwatch(bufnr)
+    end,
+  })
+end
+
+---Stop watching a buffer
+---@param bufnr number
+---@return nil
+function Watchers:unwatch(bufnr)
+  if self.buffers[bufnr] then
+    log:debug("Unwatching buffer %d", bufnr)
+    self.buffers[bufnr] = nil
+  end
+end
+
 ---Get any changes in a watched buffer
 ---@param bufnr number
 ---@return CodeCompanion.Change[]|nil
@@ -210,4 +211,61 @@ function Watchers:get_changes(bufnr)
   return changes
 end
 
+---Check all watched buffers for changes
+---@param chat CodeCompanion.Chat
+function Watchers:check_for_changes(chat)
+  for _, ref in ipairs(chat.refs) do
+    if ref.bufnr and ref.opts and ref.opts.watched then
+      local changes = self:get_changes(ref.bufnr)
+      log:debug("Checking watched buffer %d, found %d changes", ref.bufnr, changes and #changes or 0)
+
+      if changes and #changes > 0 then
+        local changes_text = string.format(
+          "Changes detected in `%s` (buffer %d):\n",
+          vim.fn.fnamemodify(api.nvim_buf_get_name(ref.bufnr), ":t"),
+          ref.bufnr
+        )
+
+        for _, change in ipairs(changes) do
+          if change.type == "delete" then
+            changes_text = changes_text
+              .. string.format(
+                "Lines %d-%d were deleted:\n```%s\n%s\n```\n",
+                change.start,
+                change.end_line,
+                vim.bo[ref.bufnr].filetype,
+                table.concat(change.lines, "\n")
+              )
+          elseif change.type == "modify" then
+            changes_text = changes_text
+              .. string.format(
+                "Lines %d-%d were modified from:\n```%s\n%s\n```\nto:\n```%s\n%s\n```\n",
+                change.start,
+                change.end_line,
+                vim.bo[ref.bufnr].filetype,
+                table.concat(change.old_lines, "\n"),
+                vim.bo[ref.bufnr].filetype,
+                table.concat(change.new_lines, "\n")
+              )
+          else -- type == "add"
+            changes_text = changes_text
+              .. string.format(
+                "Lines %d-%d were added:\n```%s\n%s\n```\n",
+                change.start,
+                change.end_line,
+                vim.bo[ref.bufnr].filetype,
+                table.concat(change.lines, "\n")
+              )
+          end
+        end
+
+        chat:add_message({
+          role = config.constants.USER_ROLE,
+          content = changes_text,
+        }, { visible = false })
+      end
+    end
+  end
+end
+
 return Watchers

lua/codecompanion/types.lua

@@ -55,7 +55,7 @@
 ---@field augroup integer The autocmd group ID
 ---@field watch fun(self: CodeCompanion.Watchers, bufnr: number): nil Start watching a buffer
 ---@field unwatch fun(self: CodeCompanion.Watchers, bufnr: number): nil Stop watching a buffer
----@field get_changes fun(self: CodeCompanion.Watchers, bufnr: number): CodeCompanion.Change[]|nil Get changes since last check
+---@field get_changes fun(self: CodeCompanion.Watchers, bufnr: number): CodeCompanion.Change[]|nil Get the latest changes in the buffer
 
 ---@class CodeCompanion.WatcherState
 ---@field content string[] Complete buffer content