feat(nvim): allow customising the system prompt as a function

Author: Zhe Yu

lua/vectorcode/integrations/codecompanion/common.lua

@@ -5,13 +5,6 @@ local vc_config = require("vectorcode.config")
 local notify_opts = vc_config.notify_opts
 local logger = vc_config.logger
 
----@class VectorCode.CodeCompanion.SummariseOpts
----@field enabled boolean|(fun(chat: CodeCompanion.Chat,results: VectorCode.QueryResult[]):boolean)|nil
----@field adapter string|CodeCompanion.Adapter|nil
----@field system_prompt string
----When set to true, include the query messages so that the LLM may make task-related summarisations.
----@field query_augmented boolean
-
 ---@type VectorCode.CodeCompanion.QueryToolOpts
 local default_query_options = {
   max_num = { chunk = -1, document = -1 },
@@ -75,6 +68,8 @@ General Guidelines:
     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.
 ]],
   },
 }

lua/vectorcode/integrations/codecompanion/query_tool.lua

@@ -113,12 +113,23 @@ local function generate_summary(result, summarise_opts, cmd, callback)
       return cc_common.process_result(res)
     end)
     :totable())
+
   if summarise_opts.enabled and type(callback) == "function" then
     ---@type CodeCompanion.Adapter
     local adapter =
       vim.deepcopy(require("codecompanion.adapters").resolve(summarise_opts.adapter))
 
     local system_prompt = summarise_opts.system_prompt
+    if type(system_prompt) == "function" then
+      system_prompt = system_prompt(
+        cc_common.get_query_tool_opts().summarise.system_prompt --[[@as string]]
+      )
+    end
+
+    assert(
+      type(system_prompt) == "string",
+      "`system_prompt` should have been converted to a string."
+    )
     if summarise_opts.query_augmented then
       system_prompt = string.format(
         [[%s

lua/vectorcode/types.lua

@@ -113,3 +113,22 @@
 ---@field raw_results VectorCode.QueryResult[]
 ---@field count integer
 ---@field summary string|nil
+
+---@class VectorCode.CodeCompanion.SummariseOpts
+---A boolean flag that controls whether summarisation should be enabled.
+---This can also be a function that returns a boolean.
+---In this case, you can use this option to dynamically control whether summarisation is enabled during a chat.
+---
+---This function recieves 2 parameters:
+--- - `CodeCompanion.Chat`: the chat object;
+--- - `VectorCode.QueryResult[]`: a list of query results.
+---@field enabled boolean|(fun(chat: CodeCompanion.Chat, results: VectorCode.QueryResult[]):boolean)|nil
+---The adapter used for the summarisation task. When set to `nil`, the adapter from the current chat will be used.
+---@field adapter string|CodeCompanion.Adapter|nil
+---The system prompt sent to the summariser model.
+---When set to a function, it'll recieve the default system prompt as the only parameter,
+---and should return the new (full) system prompt. This allows you to customise or rewrite the system prompt.
+---@field system_prompt string|(fun(original_prompt: string): string)
+---When set to true, include the query messages so that the LLM may make task-related summarisations.
+---This happens __after__ the `system_prompt` callback processing
+---@field query_augmented boolean