fix(nvim): fix tool option type conversions

Author: Zhe Yu

lua/vectorcode/integrations/codecompanion/common.lua

@@ -3,26 +3,16 @@ local vc_config = require("vectorcode.config")
 local notify_opts = vc_config.notify_opts
 local logger = vc_config.logger
 
----@class VectorCode.CodeCompanion.ToolOpts
----@field max_num integer|{document:integer, chunk: integer}|nil
----@field default_num integer|{document:integer, chunk: integer}|nil
----@field include_stderr boolean?
----@field use_lsp boolean?
----@field auto_submit table<string, boolean>?
----@field ls_on_start boolean?
----@field no_duplicate boolean?
----@field chunk_mode boolean?
-
 ---@type VectorCode.CodeCompanion.ToolOpts
 local default_options = {
-  max_num = -1,
-  default_num = 10,
+  max_num = { chunk = -1, document = -1 },
+  default_num = { chunk = 50, document = 10 },
   include_stderr = false,
   use_lsp = false,
   auto_submit = { ls = false, query = false },
   ls_on_start = false,
   no_duplicate = true,
-  only_chunks = false,
+  chunk_mode = false,
 }
 
 return {
@@ -46,6 +36,7 @@ return {
         { use_lsp = vc_config.get_user_config().async_backend == "lsp" }
       )
     end
+    opts = vim.tbl_deep_extend("force", default_options, opts)
     if type(opts.default_num) == "table" then
       if opts.chunk_mode then
         opts.default_num = opts.default_num.chunk
@@ -68,33 +59,34 @@ return {
         "max_num should be an integer or a table: {chunk: integer, document: integer}"
       )
     end
-    return vim.tbl_deep_extend("force", default_options, opts)
+    return opts
   end,
 
   ---@param result VectorCode.Result
   ---@return string
   process_result = function(result)
+    local llm_message
     if result.chunk then
       -- chunk mode
-      local chunk =
+      llm_message =
         string.format("<path>%s</path><chunk>%s</chunk>", result.path, result.chunk)
       if result.start_line and result.end_line then
-        chunk = chunk
+        llm_message = llm_message
           .. string.format(
             "<start_line>%d</start_line><end_line>%d</end_line>",
             result.start_line,
             result.end_line
           )
       end
-      return chunk
     else
       -- full document mode
-      return string.format(
+      llm_message = string.format(
         "<path>%s</path><content>%s</content>",
         result.path,
         result.document
       )
     end
+    return llm_message
   end,
   ---@param use_lsp boolean
   ---@return VectorCode.JobRunner

lua/vectorcode/integrations/codecompanion/func_calling_tool.lua

@@ -11,6 +11,10 @@ local job_runner = nil
 ---@return CodeCompanion.Agent.Tool
 return check_cli_wrap(function(opts)
   opts = cc_common.get_tool_opts(opts)
+  assert(
+    type(opts.max_num) == "number" and type(opts.default_num) == "number",
+    string.format("Options are not correctly formatted:%s", vim.inspect(opts))
+  )
   ---@type "file"|"chunk"
   local mode
   if opts.chunk_mode then

lua/vectorcode/types.lua

@@ -56,3 +56,30 @@
 ---@field buf_is_enabled fun(bufnr: integer?): boolean Checks if a buffer has been enabled.
 ---@field make_prompt_component fun(bufnr: integer?, component_cb: (fun(result: VectorCode.Result): string)?): {content: string, count: integer} Compile the retrieval results into a string.
 ---@field async_check fun(check_item: string?, on_success: fun(out: vim.SystemCompleted)?, on_failure: fun(out: vim.SystemCompleted)?) Checks if VectorCode has been configured properly for your project.
+
+--- This class defines the options available to the CodeCompanion tool.
+---@class VectorCode.CodeCompanion.ToolOpts
+--- Maximum number of results provided to the LLM.
+--- You may set this to a table to configure different values for document/chunk mode.
+--- When set to negative values, it means unlimited.
+--- Default: `{ document = -1, chunk = -1 }`
+---@field max_num integer|{document:integer, chunk: integer}|nil
+--- Default number of results provided to the LLM.
+--- This value is written in the system prompt and tool description.
+--- Users may ask the LLM to request a different number of results in the chat.
+--- You may set this to a table to configure different values for document/chunk mode.
+--- Default: `{ document = 10, chunk = 50 }`
+---@field default_num integer|{document:integer, chunk: integer}|nil
+--- Whether the stderr should be provided back to the chat
+---@field include_stderr boolean?
+--- Whether to use the LSP backend. Default: `false`
+---@field use_lsp boolean?
+--- Whether to automatically submit the result (no longer necessary in recent CodeCompanion releases). Default: `false`
+---@field auto_submit table<string, boolean>?
+--- Whether to run `vectorcode ls` and tell the LLM about the indexed projects when initialising the tool. Default: `false`
+---@field ls_on_start boolean?
+--- Whether to avoid duplicated references. Default: `true`
+---@field no_duplicate boolean?
+--- Whether to send chunks instead of full files to the LLM. Default: `false`
+--- > Make sure you adjust `max_num` and `default_num` accordingly.
+---@field chunk_mode boolean?