feat(chat): add copilot usage statistics with gS keymap (olimorris#1677)

Author: bassamsdata

doc/codecompanion.txt

@@ -2144,6 +2144,7 @@ The keymaps available to the user in normal mode are:
 - `gR` to go to the file under cursor. If the file is already opened, it’ll jump
     to the existing window. Otherwise, it’ll be opened in a new tab.
 - `gs` to toggle the system prompt on/off
+- `gS` to show copilot usage stats
 - `gta` to toggle auto tool mode
 - `gx` to clear the chat buffer’s contents
 - `gy` to yank the last codeblock in the chat buffer

doc/usage/chat-buffer/index.md

@@ -85,11 +85,11 @@ The keymaps available to the user in normal mode are:
 - `gR` to go to the file under cursor. If the file is already opened, it'll jump
   to the existing window. Otherwise, it'll be opened in a new tab.
 - `gs` to toggle the system prompt on/off
+- `gS` to show copilot usage stats
 - `gta` to toggle auto tool mode
 - `gx` to clear the chat buffer's contents
 - `gy` to yank the last codeblock in the chat buffer
 - `[[` to move to the previous header
 - `]]` to move to the next header
 - `{` to move to the previous chat
 - `}` to move to the next chat
-

lua/codecompanion/adapters/copilot.lua

@@ -226,6 +226,135 @@ local function get_models(self, opts)
   return models
 end
 
+---Get Copilot usage statistics
+---@return table|nil
+local function get_copilot_stats()
+  local dummy_adapter = { url = "" }
+  if not get_and_authorize_token(dummy_adapter) then
+    return nil
+  end
+
+  log:debug("Fetching Copilot usage statistics")
+
+  local ok, response = pcall(function()
+    return curl.get("https://api.github.com/copilot_internal/user", {
+      sync = true,
+      headers = {
+        Authorization = "Bearer " .. _oauth_token,
+        Accept = "*/*",
+        ["User-Agent"] = "CodeCompanion.nvim",
+      },
+      insecure = config.adapters.opts.allow_insecure,
+      proxy = config.adapters.opts.proxy,
+    })
+  end)
+  if not ok then
+    log:error("Could not get Copilot stats: %s", response)
+    return nil
+  end
+
+  local ok, json = pcall(vim.json.decode, response.body)
+  if not ok then
+    log:error("Error parsing Copilot stats response: %s", response.body)
+    return nil
+  end
+
+  return json
+end
+
+---Show Copilot usage statistics in a floating window
+---@return nil
+local function show_copilot_stats()
+  local stats = get_copilot_stats()
+  if not stats then
+    return vim.notify("Could not retrieve Copilot stats", vim.log.levels.ERROR)
+  end
+
+  local lines = {}
+  local ui = require("codecompanion.utils.ui")
+  table.insert(lines, "# 󰾞  GitHub Copilot Usage Statistics 󰾞 ")
+  table.insert(lines, "")
+
+  if stats.quota_snapshots.premium_interactions then
+    local premium = stats.quota_snapshots.premium_interactions
+    table.insert(lines, "##  Premium Interactions")
+    local used = premium.entitlement - premium.remaining
+    local usage_percent = premium.entitlement > 0 and (used / premium.entitlement * 100) or 0
+    table.insert(lines, string.format("   - Used: %d / %d (%.1f%%)", used, premium.entitlement, usage_percent))
+    table.insert(lines, string.format("   - Remaining: %d", premium.remaining))
+    table.insert(lines, string.format("   - Percentage: %.1f%%", premium.percent_remaining))
+    if premium.unlimited then
+      table.insert(lines, "   - Status: Unlimited ✨")
+    else
+      table.insert(lines, "   - Status: Limited")
+    end
+    table.insert(lines, "")
+  end
+
+  if stats.quota_snapshots.chat then
+    local chat = stats.quota_snapshots.chat
+    table.insert(lines, "## 󰭹 Chat")
+    if chat.unlimited then
+      table.insert(lines, "   - Status: Unlimited ✨")
+    else
+      local used = chat.entitlement - chat.remaining
+      local usage_percent = chat.entitlement > 0 and (used / chat.entitlement * 100) or 0
+      table.insert(lines, string.format("   - Used: %d / %d (%.1f%%)", used, chat.entitlement, usage_percent))
+    end
+    table.insert(lines, "")
+  end
+
+  if stats.quota_snapshots.completions then
+    local completions = stats.quota_snapshots.completions
+    table.insert(lines, "##  Completions")
+    if completions.unlimited then
+      table.insert(lines, "   - Status: Unlimited ✨")
+    else
+      local used = completions.entitlement - completions.remaining
+      local usage_percent = completions.entitlement > 0 and (used / completions.entitlement * 100) or 0
+      table.insert(lines, string.format("   - Used: %d / %d (%.1f%%)", used, completions.entitlement, usage_percent))
+    end
+  end
+  if stats.quota_reset_date then
+    table.insert(lines, "")
+    table.insert(lines, string.format("> Quota resets on: %s", stats.quota_reset_date))
+    table.insert(lines, "")
+  end
+
+  -- Create floating window
+  local float_opts = {
+    title = "󰍘 Copilot Stats",
+    lock = true,
+    relative = "editor",
+    row = "center",
+    col = "center",
+    window = {
+      width = 43,
+      height = math.min(#lines + 2, 20),
+    },
+    ignore_keymaps = false,
+  }
+  local _, winnr = ui.create_float(lines, float_opts)
+
+  local function get_usage_highlight(usage_percent)
+    if usage_percent >= 80 then
+      return "Error"
+    else
+      return "MoreMsg"
+    end
+  end
+  vim.api.nvim_win_call(winnr, function()
+    -- Usage percentages with color coding
+    local premium = stats.quota_snapshots.premium_interactions
+    if premium and not premium.unlimited then
+      local used = premium.entitlement - premium.remaining
+      local usage_percent = premium.entitlement > 0 and (used / premium.entitlement * 100) or 0
+      local highlight = get_usage_highlight(usage_percent)
+      vim.fn.matchadd(highlight, string.format("   - Used: %d / %d (%.1f%%)", used, premium.entitlement, usage_percent))
+    end
+  end)
+end
+
 ---@class Copilot.Adapter: CodeCompanion.Adapter
 return {
   name = "copilot",
@@ -256,6 +385,12 @@ return {
     ["Copilot-Integration-Id"] = "vscode-chat",
     ["Editor-Version"] = "Neovim/" .. vim.version().major .. "." .. vim.version().minor .. "." .. vim.version().patch,
   },
+  get_copilot_stats = function()
+    return get_copilot_stats()
+  end,
+  show_copilot_stats = function()
+    return show_copilot_stats()
+  end,
   handlers = {
     ---Check for a token before starting the request
     ---@param self CodeCompanion.Adapter

lua/codecompanion/config.lua

@@ -433,6 +433,12 @@ local defaults = {
           callback = "keymaps.goto_file_under_cursor",
           description = "Open the file under cursor in a new tab.",
         },
+        copilot_stats = {
+          modes = { n = "gS" },
+          index = 20,
+          callback = "keymaps.copilot_stats",
+          description = "Show Copilot usage statistics",
+        },
       },
       opts = {
         blank_prompt = "", -- The prompt to use when the user doesn't provide a prompt

lua/codecompanion/strategies/chat/keymaps.lua

@@ -642,4 +642,18 @@ M.goto_file_under_cursor = {
   end,
 }
 
+M.copilot_stats = {
+  desc = "Show Copilot usage statistics",
+  callback = function(chat)
+    if chat.adapter.name ~= "copilot" then
+      return util.notify("Copilot stats are only available when using the Copilot adapter", vim.log.levels.WARN)
+    end
+    if chat.adapter.show_copilot_stats then
+      chat.adapter.show_copilot_stats()
+    else
+      util.notify("Copilot stats function not available", vim.log.levels.ERROR)
+    end
+  end,
+}
+
 return M

lua/codecompanion/utils/ui.lua

@@ -17,15 +17,25 @@ M.create_float = function(lines, opts)
   local bufnr = opts.bufnr or api.nvim_create_buf(false, true)
 
   require("codecompanion.utils").set_option(bufnr, "filetype", opts.filetype or "codecompanion")
+  -- Calculate center position if not specified
+  local row = opts.row or window.row or 10
+  local col = opts.col or window.col or 0
+  if row == "center" then
+    row = math.floor((vim.o.lines - height) / 2)
+  end
+  if col == "center" then
+    col = math.floor((vim.o.columns - width) / 2)
+  end
 
   local winnr = api.nvim_open_win(bufnr, true, {
     relative = opts.relative or "cursor",
-    border = "single",
+    -- thanks to @mini.nvim for this, it's for >= 0.11, to respect users winborder style
+    border = (vim.fn.exists("+winborder") == 1 and vim.o.winborder ~= "") and vim.o.winborder or "single",
     width = width,
     height = height,
     style = "minimal",
-    row = 10,
-    col = 0,
+    row = row,
+    col = col,
     title = opts.title or "Options",
     title_pos = "center",
   })

tests/adapters/test_copilot.lua

@@ -127,4 +127,47 @@ T["Copilot adapter"]["No Streaming"]["can output for the inline assistant"] = fu
   )
 end
 
+T["Stats"] = new_set()
+
+T["Stats"]["can calculate usage percentages correctly"] = function()
+  local entitlement, remaining = 300, 250
+  local used = entitlement - remaining
+  local usage_percent = entitlement > 0 and (used / entitlement * 100) or 0
+  h.eq(50, used)
+  -- 50/300 * 100 = 16.666... so we need to check the rounded value
+  h.eq(16.7, math.floor(usage_percent * 10 + 0.5) / 10)
+
+  local zero_entitlement = 0
+  local zero_percent = zero_entitlement > 0 and (0 / zero_entitlement * 100) or 0
+  h.eq(0, zero_percent)
+
+  -- Test full usage
+  local full_entitlement, no_remaining = 100, 0
+  local full_used = full_entitlement - no_remaining
+  local full_percent = full_entitlement > 0 and (full_used / full_entitlement * 100) or 0
+  h.eq(100, full_used)
+  h.eq(100.0, full_percent)
+end
+
+T["Stats"]["can determine correct highlight colors based on usage"] = function()
+  local function get_usage_highlight(usage_percent)
+    if usage_percent >= 80 then
+      return "Error"
+    else
+      return "MoreMsg"
+    end
+  end
+
+  -- Test low usage (green)
+  h.eq("MoreMsg", get_usage_highlight(16.7))
+  h.eq("MoreMsg", get_usage_highlight(50))
+  h.eq("MoreMsg", get_usage_highlight(79.9))
+  -- Test high usage (red)
+  h.eq("Error", get_usage_highlight(80))
+  h.eq("Error", get_usage_highlight(85))
+  h.eq("Error", get_usage_highlight(100))
+
+  h.eq("MoreMsg", get_usage_highlight(0))
+end
+
 return T