feat(nvim): Implement wildcard tool opts for CodeCompanion (#232)

* refactor(nvim): Enable wildcard tool opts for CodeCompanion

* fix(nvim): Use correct tool opts getter for summary system prompt

* refactor(nvim): Move `process_result` to `query_tool.lua`

* refactor(nvim): Refactor tool opts merging logic for CodeCompanion

Author: Davidyz

lua/codecompanion/_extensions/vectorcode/init.lua

@@ -12,40 +12,44 @@
 local vc_config = require("vectorcode.config")
 local logger = vc_config.logger
 
-local use_lsp = vc_config.get_user_config().async_backend == "lsp"
-
 ---@type VectorCode.CodeCompanion.ExtensionOpts|{}
 local default_extension_opts = {
   tool_opts = {
-    ls = { use_lsp = use_lsp, requires_approval = false, include_in_toolbox = true },
-    query = { use_lsp = use_lsp, requires_approval = false, include_in_toolbox = true },
-    vectorise = {
-      use_lsp = use_lsp,
-      requires_approval = true,
-      include_in_toolbox = true,
-    },
-    files_ls = {
-      use_lsp = use_lsp,
-      requires_approval = false,
-      include_in_toolbox = false,
-    },
-    files_rm = {
-      use_lsp = use_lsp,
-      requires_approval = true,
-      include_in_toolbox = false,
-    },
+    -- NOTE: the other default opts are defined in the source code files of the tools.
+    -- `include_in_toolbox` is here so that the extension setup works as expected.
+
+    ls = { include_in_toolbox = true },
+    query = { include_in_toolbox = true },
+    vectorise = { include_in_toolbox = true },
+    files_ls = {},
+    files_rm = {},
   },
   tool_group = { enabled = true, collapse = true, extras = {} },
 }
 
 ---@type sub_cmd[]
 local valid_tools = { "ls", "query", "vectorise", "files_ls", "files_rm" }
 
+---@param tool_opts table<sub_cmd, VectorCode.CodeCompanion.ToolOpts>
+---@return table<sub_cmd, VectorCode.CodeCompanion.ToolOpts>
+local function merge_tool_opts(tool_opts)
+  local wildcard_opts = tool_opts["*"]
+  if wildcard_opts then
+    for tool_name, opts in pairs(tool_opts) do
+      if tool_name ~= "*" then
+        tool_opts[tool_name] = vim.tbl_deep_extend("force", wildcard_opts, opts)
+      end
+    end
+  end
+  return tool_opts
+end
+
 ---@type CodeCompanion.Extension
 local M = {
   ---@param opts VectorCode.CodeCompanion.ExtensionOpts
   setup = vc_config.check_cli_wrap(function(opts)
     opts = vim.tbl_deep_extend("force", default_extension_opts, opts or {})
+    opts.tool_opts = merge_tool_opts(opts.tool_opts)
     logger.info("Received codecompanion extension opts:\n", opts)
     local cc_config = require("codecompanion.config").config
     local cc_integration = require("vectorcode.integrations").codecompanion.chat

lua/vectorcode/integrations/codecompanion/common.lua

@@ -5,83 +5,6 @@ local vc_config = require("vectorcode.config")
 local notify_opts = vc_config.notify_opts
 local logger = vc_config.logger
 
----@type VectorCode.CodeCompanion.QueryToolOpts
-local default_query_options = {
-  max_num = { chunk = -1, document = -1 },
-  default_num = { chunk = 50, document = 10 },
-  no_duplicate = true,
-  chunk_mode = false,
-  summarise = {
-    enabled = false,
-    query_augmented = true,
-    system_prompt = [[You are an expert and experienced code analyzer and summarizer. Your primary task is to analyze provided source code, which will be given as a list of XML objects, and generate a comprehensive, well-structured Markdown summary. This summary will serve as a concise source of information for others to quickly understand how the code works and how to interact with it, without needing to delve into the full source code.
-
-Input Format:
-Each XML object represents either a full file or a chunk of a file, containing the following tags:
-- `<path>...</path>`: The absolute file path of the source code.
-- `<document>...</document>`: The full content of a source code file. This tag will not coexist with `<chunk>`.
-- `<chunk>...</chunk>`: A segment of source code from a file. This tag will not coexist with `<document>`.
-- `<start_line>...</start_line>` and `<end_line>...</end_line>`: These tags will be present only when a `<chunk>` tag is used, indicating the starting and ending line numbers of the chunk within its respective file.
-
-Your goal is to process each of these XML objects. If multiple chunks belong to the same file, you must synthesize them to form a cohesive understanding of that file. Generate a single Markdown summary that combines insights from all provided objects.
-
-Markdown Structure:
-
-    Top-Level Header (#): The absolute or relative file path of the source code.
-
-    Secondary Headers (##): For each top-level symbol (e.g., functions, classes, global variables) defined directly within the source code file that are importable or includable by other programs.
-
-    Tertiary Headers (###): For symbols nested one level deep within a secondary header's symbol (e.g., methods within a class, inner functions).
-
-    Quaternary Headers (####): For symbols nested two levels deep (e.g., a function defined within a method of a class).
-
-    Continue this pattern, incrementing the header level for each deeper level of nesting.
-
-Content for Each Section:
-
-    Descriptive Summary: Each header section (from secondary headers downwards) must contain a concise and informative summary of the symbol defined by that header.
-
-        For Functions/Methods: Explain their purpose, parameters (including types), return values (including types), high-level implementation details, and any significant side effects or core logic. For example, if summarizing a sorting function, include the sorting algorithm used. If summarizing a function that makes an HTTP request, mention the network library employed.
-
-        For Classes: Describe the class's role, its main responsibilities, and key characteristics.
-
-        For Variables (global or within scope): State their purpose, type (if discernible), and initial value or common usage.
-
-        For Modules/Files (under the top-level header): Provide an overall description of the file's purpose, its main components, and its role within the larger project (if context is available).
-
-General Guidelines:
-
-    Clarity and Conciseness: Summaries should be easy to understand, avoiding jargon where possible, and as brief as possible while retaining essential information. The full summary MUST NOT be longer than the original code input. When quoting a symbol in the code, include the line numbers where possible.
-
-    Accuracy: Ensure the summary accurately reflects the code's functionality.
-
-    Focus on Public Interface/Behavior: Prioritize describing what a function/class does and how it's used. Only include details about symbols (variables, functions, classes) that are importable/includable by other programs. DO NOT include local variables and functions that are not accessible by other functions outside their immediate scope.
-
-    No Code Snippets: Do not include any actual code snippets in the summary. Focus solely on descriptive text. If you need to refer to a specific element for context (e.g., in an error description), describe it and provide line numbers for reference from the source code.
-
-    Syntax/Semantic Errors: If the code contains syntax or semantic errors, describe them clearly within the summary, indicating the nature of the error.
-
-    Language Agnostic: Adapt the summary to the specific programming language of the provided source code (e.g., Python, JavaScript, Java, C++, etc.).
-
-    Handle Edge Cases/Dependencies: If a symbol relies heavily on external dependencies or handles specific edge cases, briefly mention these if they are significant to its overall function.
-
-    Information Source: There will be no extra information available to you. Provide the summary solely based on the provided XML objects.
-
-    Omit meaningless results: For an xml object that contains no meaningful information, you're free to omit it, but please leave a sentence in the summary saying that you did this.
-
-    No extra reply: Your reply should solely consist of the summary. Do not say anything else.
-
-    Merge chunks from the same file: When there are chunks that belong to the same file, merge their content so that they're grouped under the same top level header.
-]],
-  },
-}
-
----@type VectorCode.CodeCompanion.LsToolOpts
-local default_ls_options = {}
-
----@type VectorCode.CodeCompanion.VectoriseToolOpts
-local default_vectorise_options = {}
-
 local TOOL_RESULT_SOURCE = "VectorCodeToolResult"
 
 return {
@@ -96,102 +19,6 @@ return {
     return table.concat(vim.iter(t):flatten(math.huge):totable(), "\n")
   end,
 
-  ---@param opts VectorCode.CodeCompanion.LsToolOpts|{}|nil
-  ---@return VectorCode.CodeCompanion.LsToolOpts
-  get_ls_tool_opts = function(opts)
-    opts = vim.tbl_deep_extend("force", default_ls_options, opts or {})
-    logger.info(
-      string.format(
-        "Loading `vectorcode_ls` with the following opts:\n%s",
-        vim.inspect(opts)
-      )
-    )
-    return opts
-  end,
-
-  ---@param opts VectorCode.CodeCompanion.VectoriseToolOpts|{}|nil
-  ---@return VectorCode.CodeCompanion.VectoriseToolOpts
-  get_vectorise_tool_opts = function(opts)
-    opts = vim.tbl_deep_extend("force", default_vectorise_options, opts or {})
-    logger.info(
-      string.format(
-        "Loading `vectorcode_vectorise` with the following opts:\n%s",
-        vim.inspect(opts)
-      )
-    )
-    return opts
-  end,
-
-  ---@param opts VectorCode.CodeCompanion.QueryToolOpts|{}|nil
-  ---@return VectorCode.CodeCompanion.QueryToolOpts
-  get_query_tool_opts = function(opts)
-    if opts == nil or opts.use_lsp == nil then
-      opts = vim.tbl_deep_extend(
-        "force",
-        opts or {},
-        { use_lsp = vc_config.get_user_config().async_backend == "lsp" }
-      )
-    end
-    opts = vim.tbl_deep_extend("force", default_query_options, opts)
-    if type(opts.default_num) == "table" then
-      if opts.chunk_mode then
-        opts.default_num = opts.default_num.chunk
-      else
-        opts.default_num = opts.default_num.document
-      end
-      assert(
-        type(opts.default_num) == "number",
-        "default_num should be an integer or a table: {chunk: integer, document: integer}"
-      )
-    end
-    if type(opts.max_num) == "table" then
-      if opts.chunk_mode then
-        opts.max_num = opts.max_num.chunk
-      else
-        opts.max_num = opts.max_num.document
-      end
-      assert(
-        type(opts.max_num) == "number",
-        "max_num should be an integer or a table: {chunk: integer, document: integer}"
-      )
-    end
-    logger.info(
-      string.format(
-        "Loading `vectorcode_query` with the following opts:\n%s",
-        vim.inspect(opts)
-      )
-    )
-    return opts
-  end,
-
-  ---@param result VectorCode.QueryResult
-  ---@return string
-  process_result = function(result)
-    -- TODO: Unify the handling of summarised and non-summarised result
-    local llm_message
-    if result.chunk then
-      -- chunk mode
-      llm_message =
-        string.format("<path>%s</path><chunk>%s</chunk>", result.path, result.chunk)
-      if result.start_line and result.end_line then
-        llm_message = llm_message
-          .. string.format(
-            "<start_line>%d</start_line><end_line>%d</end_line>",
-            result.start_line,
-            result.end_line
-          )
-      end
-    else
-      -- full document mode
-      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
   initialise_runner = function(use_lsp)

lua/vectorcode/integrations/codecompanion/files_ls_tool.lua

@@ -1,10 +1,18 @@
 ---@module "codecompanion"
 
 local cc_common = require("vectorcode.integrations.codecompanion.common")
+local vc_config = require("vectorcode.config")
+
+local default_opts = {
+  use_lsp = vc_config.get_user_config().async_backend == "lsp",
+  requires_approval = false,
+  include_in_toolbox = false,
+}
 
 ---@param opts VectorCode.CodeCompanion.FilesLsToolOpts
 ---@return CodeCompanion.Agent.Tool
 return function(opts)
+  opts = vim.tbl_deep_extend("force", default_opts, opts or {})
   local job_runner =
     require("vectorcode.integrations.codecompanion.common").initialise_runner(
       opts.use_lsp

lua/vectorcode/integrations/codecompanion/files_rm_tool.lua

@@ -1,12 +1,21 @@
 ---@module "codecompanion"
 
 local cc_common = require("vectorcode.integrations.codecompanion.common")
+local vc_config = require("vectorcode.config")
+
+local default_opts = {
+  use_lsp = vc_config.get_user_config().async_backend == "lsp",
+  requires_approval = true,
+  include_in_toolbox = false,
+}
 
 ---@alias FilesRmArgs { paths: string[], project_root: string }
 
 ---@param opts VectorCode.CodeCompanion.FilesRmToolOpts
 ---@return CodeCompanion.Agent.Tool
 return function(opts)
+  opts = vim.tbl_deep_extend("force", default_opts, opts or {})
+
   local tool_name = "vectorcode_files_rm"
   local job_runner = cc_common.initialise_runner(opts.use_lsp)
 

lua/vectorcode/integrations/codecompanion/ls_tool.lua

@@ -2,11 +2,33 @@
 
 local cc_common = require("vectorcode.integrations.codecompanion.common")
 local vectorcode = require("vectorcode")
+local vc_config = require("vectorcode.config")
+local logger = vc_config.logger
+
+---@type VectorCode.CodeCompanion.LsToolOpts
+local default_ls_options = {
+  use_lsp = vc_config.get_user_config().async_backend == "lsp",
+  requires_approval = false,
+  include_in_toolbox = true,
+}
+
+---@param opts VectorCode.CodeCompanion.LsToolOpts|{}|nil
+---@return VectorCode.CodeCompanion.LsToolOpts
+local get_ls_tool_opts = function(opts)
+  opts = vim.tbl_deep_extend("force", default_ls_options, opts or {})
+  logger.info(
+    string.format(
+      "Loading `vectorcode_ls` with the following opts:\n%s",
+      vim.inspect(opts)
+    )
+  )
+  return opts
+end
 
 ---@param opts VectorCode.CodeCompanion.LsToolOpts
 ---@return CodeCompanion.Agent.Tool
 return function(opts)
-  opts = cc_common.get_ls_tool_opts(opts)
+  opts = get_ls_tool_opts(opts)
   local job_runner =
     require("vectorcode.integrations.codecompanion.common").initialise_runner(
       opts.use_lsp