chore: add luals annotations and rename context (#2567)

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

Author: olimorris

lua/codecompanion/interactions/init.lua

@@ -15,12 +15,12 @@ local function add_adapter(interaction, opts)
 end
 
 ---@class CodeCompanion.Interactions
----@field buffer_context table
+---@field buffer_context CodeCompanion.BufferContext
 ---@field selected table
 local Interactions = {}
 
 ---@class CodeCompanion.InteractionArgs
----@field buffer_context table
+---@field buffer_context CodeCompanion.BufferContext
 ---@field selected table
 
 ---@param args CodeCompanion.InteractionArgs
@@ -274,9 +274,9 @@ end
 
 ---Evaluate a set of prompts based on conditionals and context
 ---@param prompts table
----@param context table
+---@param buffer_context CodeCompanion.BufferContext
 ---@return table
-function Interactions.evaluate_prompts(prompts, context)
+function Interactions.evaluate_prompts(prompts, buffer_context)
   if type(prompts) ~= "table" or vim.tbl_isempty(prompts) then
     return {}
   end
@@ -285,10 +285,10 @@ function Interactions.evaluate_prompts(prompts, context)
     .iter(prompts)
     :filter(function(prompt)
       return not (prompt.opts and prompt.opts.contains_code and not config.can_send_code())
-        and not (prompt.condition and not prompt.condition(context))
+        and not (prompt.condition and not prompt.condition(buffer_context))
     end)
     :map(function(prompt)
-      local content = type(prompt.content) == "function" and prompt.content(context) or prompt.content
+      local content = type(prompt.content) == "function" and prompt.content(buffer_context) or prompt.content
       if prompt.role == config.constants.SYSTEM_ROLE and not prompt.opts then
         prompt.opts = { visible = false, _meta = { tag = "from_custom_prompt" } }
       end

lua/codecompanion/interactions/inline/init.lua

@@ -6,7 +6,7 @@ The Inline Assistant - This is where code is applied directly to a Neovim buffer
 ---@field id number The ID of the inline prompt
 ---@field adapter CodeCompanion.HTTPAdapter The adapter to use for the inline prompt
 ---@field aug number The ID for the autocmd group
----@field buffer_context table The context of the buffer the inline prompt was initiated from
+---@field buffer_context CodeCompanion.BufferContext
 ---@field bufnr number The buffer number to apply the inline edits to
 ---@field chat_context? table The content from the last opened chat buffer
 ---@field classification CodeCompanion.Inline.Classification Where to place the generated code in Neovim
@@ -18,7 +18,7 @@ The Inline Assistant - This is where code is applied directly to a Neovim buffer
 
 ---@class CodeCompanion.InlineArgs
 ---@field adapter? CodeCompanion.HTTPAdapter
----@field buffer_context? table The context of the buffer the inline prompt was initiated from
+---@field buffer_context? CodeCompanion.BufferContext
 ---@field chat_context? table Messages from a chat buffer
 ---@field diff? table The diff provider
 ---@field lines? table The lines in the buffer before the inline changes