feat: initial support for workspaces

fixes zbirenbaum#375

Author: AntoineGS

lua/copilot/client.lua

@@ -186,6 +186,31 @@ local function prepare_client_config(overrides)
     ["copilot/openURL"] = api.handlers["copilot/openURL"],
   }
 
+  local workspace = config.get("workspace") --[[@as copilot_config_workspace]]
+  local workspace_config = {}
+
+  if workspace then
+    if workspace.auto_add_root_dir then
+      local workspace_folders = workspace.workspace_folders
+
+      --- @type workspace_folder
+      local workspace_folder = {
+        uri = vim.uri_from_fname(vim.fn.getcwd()),
+        name = "Root Folder",
+      }
+
+      table.insert(workspace_folders, workspace_folder)
+      workspace.workspace_folders = workspace_folders
+    end
+  end
+
+  -- Code fails further down if included empty or nil
+  if #workspace.workspace_folders > 0 then
+    workspace_config = {
+      workspace_folders = workspace.workspace_folders,
+    }
+  end
+
   return vim.tbl_deep_extend("force", {
     cmd = {
       node,
@@ -237,7 +262,7 @@ local function prepare_client_config(overrides)
     init_options = {
       copilotIntegrationId = "vscode-chat",
     },
-  }, overrides)
+  }, workspace_config, overrides)
 end
 
 function M.setup()
@@ -250,6 +275,7 @@ function M.setup()
 
   is_disabled = false
 
+  M.id = nil
   vim.api.nvim_create_augroup(M.augroup, { clear = true })
 
   vim.api.nvim_create_autocmd("FileType", {
@@ -274,4 +300,57 @@ function M.teardown()
   end
 end
 
+function M.add_workspace_folder(folder_path)
+  if type(folder_path) ~= "string" then
+    vim.notify("[Copilot] Workspace folder path must be a string", vim.log.levels.ERROR)
+    return false
+  end
+
+  if vim.fn.isdirectory(folder_path) ~= 1 then
+    vim.notify("[Copilot] Invalid workspace folder: " .. folder_path, vim.log.levels.ERROR)
+    return false
+  end
+
+  -- Normalize path
+  folder_path = vim.fn.fnamemodify(folder_path, ":p")
+
+  --- @type workspace_folder
+  local workspace_folder = {
+    uri = vim.uri_from_fname(folder_path),
+    name = folder_path,
+  }
+
+  local workspace = config.get("workspace") --[[@as copilot_config_workspace]]
+  local workspace_folders = workspace.workspace_folders
+
+  local exists = false
+  for _, existing_folder in ipairs(workspace_folders) do
+    if existing_folder.uri == workspace_folder.uri then
+      exists = true
+      break
+    end
+  end
+
+  if not exists then
+    table.insert(workspace_folders, workspace_folder)
+    workspace.workspace_folders = workspace_folders
+    config.set("workspace", workspace)
+  end
+
+  local client = M.get()
+  if client and client.initialized then
+    client.notify("workspace/didChangeWorkspaceFolders", {
+      event = {
+        added = { workspace_folder },
+        removed = {},
+      },
+    })
+    vim.notify("[Copilot] Added workspace folder: " .. folder_path, vim.log.levels.INFO)
+  else
+    vim.notify("[Copilot] Workspace folder added for next session: " .. folder_path, vim.log.levels.INFO)
+  end
+
+  return true
+end
+
 return M

lua/copilot/config.lua

@@ -17,6 +17,12 @@ local default_config = {
       ratio = 0.4,
     },
   },
+  ---@class copilot_config_workspace
+  workspace = {
+    ---@type workspace_folder[]
+    workspace_folders = {},
+    auto_add_root_dir = true,
+  },
   ---@class copilot_config_suggestion
   suggestion = {
     enabled = true,
@@ -82,4 +88,14 @@ function mod.get(key)
   return mod.config
 end
 
+---@param key string
+---@param value any
+function mod.set(key, value)
+  if not mod.config then
+    error("[Copilot] not initialized")
+  end
+
+  mod.config[key] = value
+end
+
 return mod

lua/copilot/init.lua

@@ -24,6 +24,14 @@ local create_cmds = function ()
     vim.deprecate("':CopilotAuth'", "':Copilot auth'", "in future", "copilot.lua")
     vim.cmd("Copilot auth")
   end, {})
+
+  vim.api.nvim_create_user_command("CopilotAddWorkspaceFolder", function(opts)
+    require("copilot.workspace").add(opts)
+  end, {
+    desc = "Add a workspace folder to Copilot",
+    nargs = "?",
+    complete = "dir",
+  })
 end
 
 M.setup = function(opts)

lua/copilot/workspace.lua

@@ -0,0 +1,16 @@
+local mod = {}
+---@class workspace_folder
+---@field uri string The URI of the workspace folder
+---@field name string The name of the workspace folder
+function mod.add(opts)
+  local folder = opts.args
+  if not folder or folder == "" then
+    folder = vim.fn.getcwd()
+  end
+
+  folder = vim.fn.fnamemodify(folder, ":p")
+
+  require("copilot.client").add_workspace_folder(folder)
+end
+
+return mod

plugin/copilot.lua

@@ -3,6 +3,7 @@ local completion_store = {
   auth = { "signin", "signout" },
   panel = { "accept", "jump_next", "jump_prev", "open", "refresh" },
   suggestion = { "accept", "accept_line", "accept_word", "dismiss", "next", "prev", "toggle_auto_trigger" },
+  workspace = { "add" },
 }
 
 vim.api.nvim_create_user_command("Copilot", function(opts)
@@ -42,9 +43,15 @@ vim.api.nvim_create_user_command("Copilot", function(opts)
     return
   end
 
+  local remaining_args = ""
+  if #params > 2 then
+    remaining_args = table.concat(params, " ", 3)
+  end
+
   require("copilot.client").use_client(function()
     mod[action_name]({
       force = opts.bang,
+      args = remaining_args,
     })
   end)
 end, {