chore: rename references in chat (#715)

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

Author: olimorris

lua/codecompanion/strategies/chat/init.lua

@@ -196,7 +196,7 @@ function Chat.new(args)
   end
   self.parser = parser
 
-  self.References = require("codecompanion.strategies.chat.references").new({ chat = self })
+  self.references = require("codecompanion.strategies.chat.references").new({ chat = self })
   self.watchers = require("codecompanion.strategies.chat.watchers").new()
   self.tools = require("codecompanion.strategies.chat.tools").new({ bufnr = self.bufnr, messages = self.messages })
   self.variables = require("codecompanion.strategies.chat.variables").new()
@@ -502,7 +502,7 @@ function Chat:add_tool(tool, tool_config)
   end
 
   local id = "<tool>" .. tool .. "</tool>"
-  self.References:add({
+  self.references:add({
     source = "tool",
     name = "tool",
     id = id,
@@ -602,7 +602,7 @@ function Chat:submit(opts)
   if not opts.regenerate and not vim.tbl_isempty(message) then
     self:add_message({ role = config.constants.USER_ROLE, content = message.content })
   end
-  message = self.References:clear(self.messages[#self.messages])
+  message = self.references:clear(self.messages[#self.messages])
 
   self:apply_tools_and_variables(message)
   self:check_references()
@@ -697,7 +697,7 @@ function Chat:done(output)
   local assistant_range = self.header_line
   self:set_range(-2)
   self.ui:display_tokens(self.parser, self.header_line)
-  self.References:render()
+  self.references:render()
 
   if self.status == CONSTANTS.STATUS_SUCCESS and self:has_tools() then
     self.tools:parse_buffer(self, assistant_range, self.header_line - 1)
@@ -727,7 +727,7 @@ end
 ---Reconcile the references table to the references in the chat buffer
 ---@return nil
 function Chat:check_references()
-  local refs = self.References:get_from_chat()
+  local refs = self.references:get_from_chat()
   if vim.tbl_isempty(refs) and vim.tbl_isempty(self.refs) then
     return
   end

lua/codecompanion/strategies/chat/keymaps.lua

@@ -327,7 +327,7 @@ M.pin_reference = {
     local icon = config.display.chat.icons.pinned_buffer
     local id = line:gsub("^> %- ", "")
 
-    if not chat.References:can_be_pinned(id) then
+    if not chat.references:can_be_pinned(id) then
       return util.notify("This reference type cannot be pinned", vim.log.levels.WARN)
     end
 
@@ -366,7 +366,7 @@ M.toggle_watch = {
 
     local icons = config.display.chat.icons
     local id = line:gsub("^> %- ", "")
-    if not chat.References:can_be_watched(id) then
+    if not chat.references:can_be_watched(id) then
       return util.notify("This reference type cannot be watched", vim.log.levels.WARN)
     end
 

lua/codecompanion/strategies/chat/slash_commands/buffer.lua

@@ -146,7 +146,7 @@ function SlashCommand:read(selected)
     content = buf.format_with_line_numbers(selected.bufnr)
   end
 
-  local id = "<buf>" .. self.Chat.References:make_id_from_buf(selected.bufnr) .. "</buf>"
+  local id = "<buf>" .. self.Chat.references:make_id_from_buf(selected.bufnr) .. "</buf>"
 
   return content, filename, id
 end
@@ -186,7 +186,7 @@ function SlashCommand:output(selected, opts)
     return
   end
 
-  self.Chat.References:add({
+  self.Chat.references:add({
     bufnr = selected.bufnr,
     id = id,
     path = selected.path,

lua/codecompanion/strategies/chat/slash_commands/fetch.lua

@@ -43,7 +43,7 @@ local function output(chat, data, opts)
     content = format_output(data.url, data.content),
   }, { reference = id, visible = false })
 
-  chat.References:add({
+  chat.references:add({
     source = "slash_command",
     name = "fetch",
     id = id,

lua/codecompanion/strategies/chat/slash_commands/file.lua

@@ -186,7 +186,7 @@ function SlashCommand:output(selected, opts)
     return
   end
 
-  self.Chat.References:add({
+  self.Chat.references:add({
     id = id or "",
     path = selected.path,
     source = "codecompanion.strategies.chat.slash_commands.file",

lua/codecompanion/strategies/chat/slash_commands/help.lua

@@ -88,7 +88,7 @@ Note the path to the help file is `%s`.
     ),
   }, { reference = id, visible = false })
 
-  Chat.References:add({
+  Chat.references:add({
     source = "slash_command",
     name = "help",
     id = id,

lua/codecompanion/strategies/chat/slash_commands/symbols.lua

@@ -265,7 +265,7 @@ Prompt the user if you need to see more than the symbolic outline.
     content = description,
   }, { reference = id, visible = false })
 
-  self.Chat.References:add({
+  self.Chat.references:add({
     source = "slash_command",
     name = "symbols",
     id = id,

lua/codecompanion/strategies/chat/variables/buffer.lua

@@ -26,7 +26,7 @@ function Variable:read(bufnr, range)
   local content = buf_utils.format_with_line_numbers(bufnr, range)
   log:trace("Buffer Variable:\n---\n%s", content)
 
-  local name = self.Chat.References:make_id_from_buf(bufnr)
+  local name = self.Chat.references:make_id_from_buf(bufnr)
   if name == "" then
     name = "Buffer " .. bufnr
   end
@@ -76,7 +76,7 @@ function Variable:output(selected, opts)
     return
   end
 
-  self.Chat.References:add({
+  self.Chat.references:add({
     bufnr = bufnr,
     params = params,
     id = id,

lua/codecompanion/strategies/chat/variables/user.lua

@@ -25,7 +25,7 @@ function Variable:output()
     content = self.config.callback(),
   }, { reference = id, tag = "variable", visible = false })
 
-  self.Chat.References:add({
+  self.Chat.references:add({
     bufnr = self.Chat.bufnr,
     id = id,
     source = "codecompanion.strategies.chat.variables.user",

lua/codecompanion/types.lua

@@ -78,7 +78,7 @@
 ---@field intro_message? boolean Whether the welcome message has been shown
 ---@field messages? table The messages in the chat buffer
 ---@field parser vim.treesitter.LanguageTree The Tree-sitter parser for the chat buffer
----@field References CodeCompanion.Chat.References
+---@field references CodeCompanion.Chat.References
 ---@field refs? table<CodeCompanion.Chat.Ref> References which are sent to the LLM e.g. buffers, slash command output
 ---@field settings? table The settings that are used in the adapter of the chat buffer
 ---@field subscribers table The subscribers to the chat buffer