feat: add support for dynamic root_dir resolving (zbirenbaum#382)

the configuration supports overriding the default function as root_dir, with a fallback to the current directory.
fixes zbirenbaum#371

Author: AntoineGS

README.md

@@ -88,8 +88,11 @@ require('copilot').setup({
     ["."] = false,
   },
   copilot_node_command = 'node', -- Node.js version must be > 18.x
-  copilot_model = "",  -- Current LSP default is gpt-35-turbo, supports gpt-4o-copilot
   workspace_folders = {},
+  copilot_model = "",  -- Current LSP default is gpt-35-turbo, supports gpt-4o-copilot
+  root_dir = function()
+    return vim.fs.dirname(vim.fs.find(".git", { upward = true })[1])
+  end,
   server_opts_overrides = {},
 })
 ```
@@ -228,6 +231,11 @@ workspace_folders = {
 
 They can also be added runtime, using the command `:Copilot workspace add [folderpath]` where `[folderpath]` is the workspace folder.
 
+### root_dir
+
+This allows changing the function that gets the root folder, the default looks for a parent folder that contains the folder `.git`.
+If none is found, it will use the current working directory.
+
 ## Commands
 
 `copilot.lua` defines the `:Copilot` command that can perform various actions. It has completion support, so try it out.

lua/copilot/client.lua

@@ -105,6 +105,9 @@ function M.buf_attach(force)
     return
   end
 
+  -- In case it has changed, we update it
+  M.config.root_dir = config.get_root_dir()
+
   local ok, client_id_or_err = pcall(lsp_start, M.config)
   if not ok then
     vim.notify(string.format("[Copilot] Failed to start LSP client: %s", client_id_or_err), vim.log.levels.ERROR)
@@ -218,11 +221,7 @@ local function prepare_client_config(overrides)
     ["copilot/openURL"] = api.handlers["copilot/openURL"],
   }
 
-  local root_dir = vim.loop.cwd()
-  if not root_dir then
-    root_dir = vim.fn.getcwd()
-  end
-
+  local root_dir = config.get_root_dir()
   local workspace_folders = {
     --- @type workspace_folder
     {
@@ -247,6 +246,7 @@ local function prepare_client_config(overrides)
     end
   end
 
+  -- LSP config, not to be confused with config.lua
   return vim.tbl_deep_extend("force", {
     cmd = {
       node,

lua/copilot/config.lua

@@ -45,6 +45,10 @@ local default_config = {
   server_opts_overrides = {},
   ---@type string|nil
   copilot_model = nil,
+  ---@type function|string
+  root_dir = function()
+    return vim.fs.dirname(vim.fs.find(".git", { upward = true })[1])
+  end,
 }
 
 local mod = {
@@ -96,4 +100,26 @@ function mod.set(key, value)
   mod.config[key] = value
 end
 
+function mod.get_root_dir()
+  if not mod.config then
+    error("[Copilot] not initialized")
+  end
+
+  local config_root_dir = mod.config.root_dir
+  local root_dir --[[@as string]]
+
+  if type(config_root_dir) == "function" then
+    root_dir = config_root_dir()
+  else
+    root_dir = config_root_dir
+  end
+
+  if not root_dir or root_dir == "" then
+    root_dir = "."
+  end
+
+  root_dir = vim.fn.fnamemodify(root_dir, ":p:h")
+  return root_dir
+end
+
 return mod