feat: add command :Copilot (zbirenbaum#59)

* feat(client): add functions to attach/detach copilot

* feat: add copilot.command module

* feat: add command :Copilot

* feat: deprecate :CopilotAuth and :CopilotPanel

Author: MunifTanjim

lua/copilot/auth.lua

@@ -101,6 +101,15 @@ function M.setup(client)
   initiate_setup()
 end
 
+function M.signin()
+  local client = u.get_copilot_client()
+  if not client then
+    return
+  end
+
+  M.setup(client)
+end
+
 function M.signout()
   local client = u.get_copilot_client()
   if not client then

lua/copilot/client.lua

@@ -48,19 +48,36 @@ local function is_ft_disabled(ft)
   return false
 end
 
-M.buf_attach_copilot = function()
-  if is_ft_disabled(vim.bo.filetype) then
-    return
-  end
+---@param force? boolean
+function M.buf_attach(client, force)
+  if not force then
+    if is_ft_disabled(vim.bo.filetype) then
+      return
+    end
 
-  if not vim.bo.buflisted or not vim.bo.buftype == "" then return end
-  -- The filter param to get_active_clients() can be used on Neovim 0.8 and later.
-  for _, client in pairs(vim.lsp.get_active_clients()) do
-    if client.name == "copilot" and not vim.lsp.buf_is_attached(0, client.id) then
-      vim.lsp.buf_attach_client(0, client.id)
-      client.completion_function = M.params.extensions
+    if not vim.bo.buflisted or not vim.bo.buftype == "" then
+      return
     end
   end
+
+  client = client or util.get_copilot_client()
+  if client and not util.is_attached(client) then
+    vim.lsp.buf_attach_client(0, client.id)
+
+    ---@todo unknown property, remove this
+    client.completion_function = M.params.extensions
+  end
+end
+
+function M.buf_detach(client)
+  client = client or util.get_copilot_client()
+  if client and util.is_attached(client) then
+    vim.lsp.buf_detach_client(0, client.id)
+  end
+end
+
+M.buf_attach_copilot = function()
+  M.buf_attach()
 end
 
 M.merge_server_opts = function (params)

lua/copilot/command.lua

@@ -0,0 +1,89 @@
+local a = require("copilot.api")
+local c = require("copilot.client")
+local u = require("copilot.util")
+
+local mod = {}
+
+function mod.version()
+  local info = u.get_editor_info()
+
+  local lines = {
+    info.editorInfo.name .. " " .. info.editorInfo.version,
+    info.editorPluginInfo.name .. " " .. info.editorPluginInfo.version,
+    "copilot.lua" .. " " .. u.get_copilot_lua_version(),
+  }
+
+  local client = u.get_copilot_client()
+
+  coroutine.wrap(function()
+    if client then
+      local _, data = a.get_version(client)
+      lines[#lines + 1] = "copilot/dist/agent.js" .. " " .. data.version
+    else
+      lines[#lines + 1] = "copilot/dist/agent.js" .. " " .. "not running"
+    end
+
+    vim.api.nvim_echo(
+      vim.tbl_map(function(line)
+        return { line .. "\n" }
+      end, lines),
+      true,
+      {}
+    )
+  end)()
+end
+
+function mod.status()
+  local function on_output(err)
+    print("[Copilot] " .. err)
+  end
+
+  local client = u.get_copilot_client()
+  if not client then
+    on_output("Not running")
+    return
+  end
+
+  coroutine.wrap(function()
+    ---@todo check startup error
+
+    local cserr, status = a.check_status(client)
+    if cserr then
+      on_output(cserr)
+      return
+    end
+
+    ---@todo check enabled status
+
+    if not status.user then
+      on_output("Not authenticated. Run ':Copilot auth'")
+      return
+    end
+
+    if string.lower(a.status.data.status) == "error" then
+      on_output(a.status.data.message)
+      return
+    end
+
+    on_output("Enabled and online")
+  end)()
+end
+
+---@param opts? { force?: boolean }
+function mod.toggle(opts)
+  opts = opts or {}
+  print(vim.inspect(opts))
+
+  local client = u.get_copilot_client()
+  if not client then
+    return
+  end
+
+  if u.is_attached(client) then
+    c.buf_detach(client)
+  else
+    c.buf_attach(client, opts.force)
+  end
+end
+
+return mod

lua/copilot/init.lua

@@ -48,11 +48,13 @@ local create_cmds = function (_)
   end, {})
 
   vim.api.nvim_create_user_command("CopilotPanel", function ()
-    require("copilot.panel").open()
+    vim.deprecate("':CopilotPanel'", "':Copilot panel'", "in future", "copilot.lua")
+    vim.cmd("Copilot panel")
   end, {})
 
   vim.api.nvim_create_user_command("CopilotAuth", function()
-    require("copilot.util").auth()
+    vim.deprecate("':CopilotAuth'", "':Copilot auth'", "in future", "copilot.lua")
+    vim.cmd("Copilot auth")
   end, {})
 end
 

lua/copilot/util.lua

@@ -21,6 +21,17 @@ function M.get_editor_info()
   return info
 end
 
+local copilot_lua_version = nil
+function M.get_copilot_lua_version()
+  if not copilot_lua_version then
+    local plugin_version_ok, plugin_version = pcall(function()
+      return vim.fn.systemlist("git rev-parse HEAD")[1]
+    end)
+    copilot_lua_version = plugin_version_ok and plugin_version or "dev"
+  end
+  return copilot_lua_version
+end
+
 -- keep for debugging reasons
 local get_capabilities = function ()
   return {
@@ -46,6 +57,11 @@ M.get_copilot_client = function()
   end
 end
 
+function M.is_attached(client)
+  client = client or M.get_copilot_client()
+  return client and vim.lsp.buf_is_attached(0, client.id) or false
+end
+
 local eol_by_fileformat = {
   unix = "\n",
   dos = "\r\n",

plugin/copilot.lua

@@ -0,0 +1,70 @@
+local completion_store = {
+  [""] = { "auth", "panel", "suggestion", "status", "toggle", "version" },
+  auth = { "signin", "signout" },
+  panel = { "accept", "jump_next", "jump_prev", "open", "refresh" },
+  suggestion = { "accept", "dismiss", "next", "prev", "toggle_auto_trigger" },
+}
+
+vim.api.nvim_create_user_command("Copilot", function(opts)
+  local params = vim.split(opts.args, "%s+", { trimempty = true })
+
+  local mod_name, action_name = params[1], params[2]
+
+  local u = require("copilot.util")
+
+  local ok, mod = pcall(require, "copilot." .. mod_name)
+  if not ok then
+    action_name = mod_name
+    mod_name = "command"
+    mod = require("copilot.command")
+  end
+
+  if not action_name then
+    if mod_name == "auth" then
+      action_name = "signin"
+    elseif mod_name == "panel" then
+      action_name = "open"
+    elseif mod_name == "suggestion" then
+      action_name = "toggle_auto_trigger"
+    end
+  end
+
+  if not mod[action_name] then
+    print("[Copilot] Unknown params: " .. opts.args)
+    return
+  end
+
+  if not u.get_copilot_client() then
+    print("[Copilot] Not running")
+    return
+  end
+
+  mod[action_name]({
+    force = opts.bang,
+  })
+end, {
+  bang = true,
+  nargs = "?",
+  complete = function(_, cmd_line)
+    local has_space = string.match(cmd_line, "%s$")
+    local params = vim.split(cmd_line, "%s+", { trimempty = true })
+
+    if #params == 1 then
+      return completion_store[""]
+    elseif #params == 2 and not has_space then
+      return vim.tbl_filter(function(cmd)
+        return not not string.find(cmd, "^" .. params[2])
+      end, completion_store[""])
+    end
+
+    if #params >= 2 and completion_store[params[2]] then
+      if #params == 2 then
+        return completion_store[params[2]]
+      elseif #params == 3 and not has_space then
+        return vim.tbl_filter(function(cmd)
+          return not not string.find(cmd, "^" .. params[3])
+        end, completion_store[params[2]])
+      end
+    end
+  end,
+})