feat: improve Copilot status with attach/detached reasons

Author: AntoineGS

lua/copilot/client/init.lua

@@ -13,12 +13,15 @@ local is_disabled = false
 ---@field config vim.lsp.ClientConfig | nil
 ---@field startup_error string | nil
 ---@field initialized boolean
+-- Only for informational purposes, use Vim API to check actual status
+---@field buffer_statuses table<integer, string>
 local M = {
   id = nil,
   capabilities = nil,
   config = nil,
   startup_error = nil,
   initialized = false,
+  buffer_statuses = {},
 }
 
 ---@param id integer
@@ -56,8 +59,11 @@ function M.buf_attach(force)
     return
   end
 
-  if not (force or util.should_attach()) then
-    logger.debug("not attaching to buffer based on force and should_attach criteria")
+  local should_attach, reason = util.should_attach()
+
+  if not (force or should_attach) then
+    logger.debug("not attaching to buffer based should_attach criteria: " .. reason)
+    M.buffer_statuses[bufnr] = "not attached based on " .. reason
     return
   end
 
@@ -73,22 +79,25 @@ function M.buf_attach(force)
   end
 
   if not M.id then
-    logger.trace("failed to start copilot client")
+    logger.error("failed to start copilot client")
     return
   end
 
-  -- This could cause slowdowns when going into Insert mode
-  if not vim.lsp.buf_is_attached(bufnr, M.id) then
-    vim.lsp.buf_attach_client(bufnr, M.id)
-    logger.trace("explicitly attached client to buffer")
+  vim.lsp.buf_attach_client(bufnr, M.id)
+  if force then
+    logger.debug("force attached to buffer")
+    M.buffer_statuses[bufnr] = "force attached"
+  else
+    logger.trace("buffer attached")
+    M.buffer_statuses[bufnr] = "attached"
   end
-
-  logger.trace("buffer attached")
 end
 
 function M.buf_detach()
   if M.buf_is_attached(0) then
     vim.lsp.buf_detach_client(0, M.id)
+    logger.trace("buffer detached")
+    M.buffer_statuses[vim.api.nvim_get_current_buf()] = "manually detached"
   end
 end
 

lua/copilot/status/init.lua

@@ -1,4 +1,3 @@
-local u = require("copilot.util")
 local logger = require("copilot.logger")
 ---@alias copilot_status_notification_data { status: ''|'Normal'|'InProgress'|'Warning', message: string }
 
@@ -98,26 +97,11 @@ function M.status()
       return
     end
 
-    local should_attach, no_attach_reason = u.should_attach()
-    local is_attached = c.buf_is_attached()
-    if is_attached then
-      if not should_attach then
-        add_line("Enabled manually (" .. no_attach_reason .. ")")
-      elseif vim.bo.filetype and vim.bo.filetype ~= "" then
-        add_line("Enabled for " .. vim.bo.filetype)
-      else
-        add_line("Enabled")
-      end
-    elseif not is_attached then
-      if should_attach then
-        if vim.bo.filetype and vim.bo.filetype ~= "" then
-          add_line("Disabled manually for " .. vim.bo.filetype)
-        else
-          add_line("Disabled manually")
-        end
-      else
-        add_line("Disabled (" .. no_attach_reason .. ")")
-      end
+    local buffer_status = c.buffer_statuses[vim.api.nvim_get_current_buf()]
+    if buffer_status then
+      add_line("Buffer status: " .. c.buffer_statuses[vim.api.nvim_get_current_buf()])
+    else
+      add_line("Buffer status: Attach not yet requested")
     end
 
     if string.lower(M.data.status) == "error" then

lua/copilot/util.lua

@@ -47,7 +47,7 @@ function M.should_attach()
   local conf_attach = config.should_attach(bufnr, bufname)
 
   if not conf_attach then
-    return false, "copilot is disabled"
+    return false, "should_attach config"
   end
 
   return true

tests/test_client.lua

@@ -35,7 +35,7 @@ T["client()"]["status info"] = function()
     local messages = ""
     local function has_passed()
       messages = vim.api.nvim_exec("messages", { output = true }) or ""
-      if messages:find(".*Online.*Enabled.*") then
+      if messages:find(".*Online.*not yet requested.*") then
         return true
       end
     end
@@ -47,11 +47,9 @@ T["client()"]["status info"] = function()
     return messages
   ]])
 
-  u.expect_match(messages, ".*Online.*Enabled.*")
+  u.expect_match(messages, ".*Online.*not yet requested.*")
 end
 
-T["client()"] = MiniTest.new_set()
-
 T["client()"]["suggestions work when multiple files open with should_attach logic"] = function()
   child.config.should_attach = [[function(bufnr, bufname)
     local buffername = bufname:match("([^/\\]+)$") or ""
@@ -218,7 +216,7 @@ T["client()"]["auto_trigger off - will not attach automatically"] = function()
     local messages = ""
     local function has_passed()
       messages = vim.api.nvim_exec("messages", { output = true }) or ""
-      if messages:find(".*Online.*Enabled.*") then
+      if messages:find(".*Online.*attached.*") then
         return true
       end
     end
@@ -230,7 +228,7 @@ T["client()"]["auto_trigger off - will not attach automatically"] = function()
     return messages
   ]])
 
-  u.expect_no_match(messages, ".*Online.*Enabled.*")
+  u.expect_no_match(messages, ".*Online.*attached.*")
 end
 
 T["client()"]["auto_trigger off - will attach when requesting suggestion"] = function()
@@ -242,7 +240,7 @@ T["client()"]["auto_trigger off - will attach when requesting suggestion"] = fun
     local messages = ""
     local function has_passed()
       messages = vim.api.nvim_exec("messages", { output = true }) or ""
-      if messages:find(".*Online.*Enabled.*") then
+      if messages:find(".*Online.*attached.*") then
         return true
       end
     end
@@ -254,7 +252,7 @@ T["client()"]["auto_trigger off - will attach when requesting suggestion"] = fun
     return messages
   ]])
 
-  u.expect_match(messages, ".*Online.*Enabled.*")
+  u.expect_match(messages, ".*Online.*attached.*")
 end
 
 return T