feat(nvim): use pre_hook to prepare the embeddings.

Author: Davidyz

lua/vectorcode/integrations/codecompanion/prompts/init.lua

@@ -0,0 +1,28 @@
+local M = {}
+
+local vc_config = require("vectorcode.config")
+
+---@param path string[]|string path to files or wildcards.
+---@param project_root? string
+---@param callback? VectorCode.JobRunner.Callback
+function M.vectorise_files(path, project_root, callback)
+  if type(path) == "string" then
+    path = { path }
+  end
+  local jobrunner =
+    require("vectorcode.integrations.codecompanion.common").initialise_runner(
+      vc_config.get_user_config().async_backend == "lsp"
+    )
+
+  local args = { "vectorise", "--pipe" }
+  if project_root then
+    vim.list_extend(args, { "--project_root", project_root })
+  end
+  vim.list_extend(args, path)
+  jobrunner.run_async(args, function(result, error, code, signal)
+    if type(callback) == "function" then
+      callback(result, error, code, signal)
+    end
+  end, 0)
+end
+return M

lua/vectorcode/integrations/codecompanion/prompts/nvim.lua

@@ -1,5 +1,26 @@
 ---@module "codecompanion"
 
+local config = require("vectorcode.config")
+local prepare = function(rtp)
+  vim.notify(
+    "Vectorising neovim runtime files...",
+    vim.log.levels.INFO,
+    config.notify_opts
+  )
+  require("vectorcode.integrations.codecompanion.prompts").vectorise_files(
+    vim.fs.joinpath(rtp, "**/*.lua"),
+    rtp,
+    function(result, _, _, _)
+      if result ~= nil and not vim.tbl_isempty(result) then
+        vim.schedule_wrap(vim.notify)(
+          string.format("Added %d files to the database!", result.add or 0),
+          vim.log.levels.INFO,
+          config.notify_opts
+        )
+      end
+    end
+  )
+end
 return require("vectorcode.config").check_cli_wrap(function()
   local constants = require("codecompanion.config").config.constants
   local rtp = vim.fs.normalize(vim.env.VIMRUNTIME)
@@ -17,23 +38,29 @@ return require("vectorcode.config").check_cli_wrap(function()
       vim.log.levels.ERROR
     )
   end
+
   return {
     name = "Neovim Assistant",
     prompts = {
       strategy = "chat",
       description = "Use VectorCode to index and query from neovim documentation and lua runtime.",
-
+      opts = {
+        pre_hook = function()
+          prepare(rtp)
+        end,
+      },
       prompts = {
         {
           role = constants.SYSTEM_ROLE,
           content = string.format(
             [[You are an neovim expert.
 You will be given tools to index and query from the neovim runtime library.
 This will include lua APIs for the neovim runtime and documentation for the neovim build that the user is running.
-Use the tools to explain the user's questions related to neovim.
 The runtime files are stored in `%s`.
 You can ONLY use the vectorcode tools to interact with these files or directory.
 DO NOT attempt to read from or write into this directory.
+When the user asked a question that is not part of a previous query tool call, make a new query using new keywords that are directly relevant to the new question.
+If the tool returns an error that says the collection doesn't exist, it's because the files are still being indexed, and you should ask the user to wait for it to finish.
 ]],
             rtp
           ),
@@ -42,13 +69,15 @@ DO NOT attempt to read from or write into this directory.
           role = constants.USER_ROLE,
           content = string.format(
             [[
-You are given the @{vectorcode_vectorise} and @{vectorcode_query} tools.
-Vectorrise all lua files and `*.txt` files under this directory using the `vectorcode_vectorise` tool. Use wildcards to match all lua and `txt` files. Use absolute paths when supplying paths to the vectorcode_vectorise tool;
+You are given the @{vectorcode_query} tool.
 Use `%s` as the value of the `project_root` argument;
-When you're done, I'll be asking you questions related to these documents.
+I'll be asking you questions related to these documents.
 Use the vectorcode_query tool to query from the project root and answer my question.
+
+Here's my question:
+
+- 
 ]],
-            rtp,
             rtp
           ),
         },

lua/vectorcode/integrations/codecompanion/vectorise_tool.lua

@@ -52,7 +52,7 @@ The paths should be accurate (DO NOT ASSUME A PATH EXIST) and case case-sensitiv
             paths = {
               type = "array",
               items = { type = "string" },
-              description = "Paths to the files to be vectorised. DO NOT use directories for this parameter.",
+              description = "Paths to the files to be vectorised. DO NOT use directories for this parameter. You may use wildcard here if the user instructed to do so.",
             },
             project_root = {
               type = "string",

lua/vectorcode/jobrunner/init.lua

@@ -1,5 +1,7 @@
 local utils = require("vectorcode.utils")
 
+---@alias VectorCode.JobRunner.Callback fun(result: table, error: table, code:integer, signal: integer?)
+
 --- A class for calling vectorcode commands that aims at providing a unified API for both LSP and command-line backend.
 --- Implementations exist for both direct command-line execution (`cmd.lua`) and LSP (`lsp.lua`).
 --- For the format of the `result`, see https://github.com/Davidyz/VectorCode/blob/main/docs/cli.md#for-developers
@@ -13,7 +15,7 @@ local utils = require("vectorcode.utils")
 --- - `signal`: _for cmd runner only_, the shell signal sent to the process.
 --- The `bufnr` is used for context, potentially to find the project root or attach LSP clients.
 --- Returns a job handle (e.g., PID or LSP request ID) or nil if the job couldn't be started.
----@field run_async fun(args: string[], callback:fun(result: table, error: table, code:integer, signal: integer?)?, bufnr: integer):(job_handle:integer?)
+---@field run_async fun(args: string[], callback:VectorCode.JobRunner.Callback?, bufnr: integer):(job_handle:integer?)
 --- Runs a vectorcode command synchronously, blocking until completion or timeout.
 --- Executes the command specified by `args`. Waits for up to `timeout_ms` milliseconds.
 --- The `bufnr` is used for context, potentially to find the project root or attach LSP clients.