feat: add automatic chat autocompletion

deathbeam · deathbeam · commit 9d07da5d5bfd · 2024-11-18T09:41:29.000+01:00
Adds new config option `chat_autocomplete` (enabled by default) that will
trigger completion automatically when typing trigger characters (@, /, #,
$). This replaces the nvim-cmp integration which is now deprecated in
favor of this new solution.

The automatic completion is debounced to avoid too many triggers and
uses the same completion logic as before, just moved to separate
function.

Signed-off-by: Tomas Slusny &lt;slusnucky@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -276,6 +276,7 @@ Also see [here](/lua/CopilotChat/config.lua):
   error_header = '## Error ', -- Header to use for errors
   separator = '───', -- Separator to use in chat
 
+  chat_autocomplete = true, -- Enable chat autocompletion (when disabled, requires manual `mappings.complete` trigger)
   show_folds = true, -- Shows folds for sections in chat
   show_help = true, -- Shows help message as virtual lines when waiting for user input
   auto_follow_cursor = true, -- Auto-follow cursor in chat
@@ -575,30 +576,6 @@ Requires [fzf-lua](https://github.com/ibhagwan/fzf-lua) plugin to be installed.
 
 </details>
 
-<details>
-<summary>nvim-cmp integration</summary>
-
-Requires [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) plugin to be installed (and properly configured).
-
-```lua
--- Registers copilot-chat source and enables it for copilot-chat filetype (so copilot chat window)
-require("CopilotChat.integrations.cmp").setup()
-
--- You might also want to disable default <tab> complete mapping for copilot chat when doing this
-require('CopilotChat').setup({
-  mappings = {
-    complete = {
-      insert = '',
-    },
-  },
-  -- rest of your config
-})
-```
-
-![image](https://github.com/CopilotC-Nvim/CopilotChat.nvim/assets/5115805/063fc99f-a4b2-4187-a065-0fdd287ebee2)
-
-</details>
-
 <details>
 <summary>render-markdown integration</summary>
 
diff --git a/lua/CopilotChat/config.lua b/lua/CopilotChat/config.lua
@@ -83,6 +83,7 @@ local select = require('CopilotChat.select')
 ---@field answer_header string?
 ---@field error_header string?
 ---@field separator string?
+---@field chat_autocomplete boolean?
 ---@field show_folds boolean?
 ---@field show_help boolean?
 ---@field auto_follow_cursor boolean?
@@ -114,6 +115,7 @@ return {
   error_header = '## Error ', -- Header to use for errors
   separator = '───', -- Separator to use in chat
 
+  chat_autocomplete = true, -- Enable chat autocompletion (when disabled, requires manual `mappings.complete` trigger)
   show_folds = true, -- Shows folds for sections in chat
   show_help = true, -- Shows help message as virtual lines when waiting for user input
   auto_follow_cursor = true, -- Auto-follow cursor in chat
diff --git a/lua/CopilotChat/init.lua b/lua/CopilotChat/init.lua
@@ -44,22 +44,6 @@ local state = {
   help = nil,
 }
 
-local function blend_color_with_neovim_bg(color_name, blend)
-  local color_int = vim.api.nvim_get_hl(0, { name = color_name }).fg
-  local bg_int = vim.api.nvim_get_hl(0, { name = 'Normal' }).bg
-
-  if not color_int or not bg_int then
-    return
-  end
-
-  local color = { (color_int / 65536) % 256, (color_int / 256) % 256, color_int % 256 }
-  local bg = { (bg_int / 65536) % 256, (bg_int / 256) % 256, bg_int % 256 }
-  local r = math.floor((color[1] * blend + bg[1] * (100 - blend)) / 100)
-  local g = math.floor((color[2] * blend + bg[2] * (100 - blend)) / 100)
-  local b = math.floor((color[3] * blend + bg[3] * (100 - blend)) / 100)
-  return string.format('#%02x%02x%02x', r, g, b)
-end
-
 local function find_lines_between_separator(
   lines,
   current_line,
@@ -260,6 +244,47 @@ local function key_to_info(name, key, surround)
   return out
 end
 
+local function trigger_complete()
+  local info = M.complete_info()
+  local bufnr = vim.api.nvim_get_current_buf()
+  local line = vim.api.nvim_get_current_line()
+  local cursor = vim.api.nvim_win_get_cursor(0)
+  local row = cursor[1]
+  local col = cursor[2]
+  if col == 0 or #line == 0 then
+    return
+  end
+
+  local prefix, cmp_start = unpack(vim.fn.matchstrpos(line:sub(1, col), info.pattern))
+  if not prefix then
+    return
+  end
+
+  if vim.startswith(prefix, '#') and vim.endswith(prefix, ':') then
+    local found_context = M.config.contexts[prefix:sub(2, -2)]
+    if found_context and found_context.input then
+      found_context.input(function(value)
+        if not value then
+          return
+        end
+
+        vim.api.nvim_buf_set_text(bufnr, row - 1, col, row - 1, col, { tostring(value) })
+      end)
+    end
+
+    return
+  end
+
+  M.complete_items(function(items)
+    vim.fn.complete(
+      cmp_start + 1,
+      vim.tbl_filter(function(item)
+        return vim.startswith(item.word:lower(), prefix:lower())
+      end, items)
+    )
+  end)
+end
+
 --- Get the completion info for the chat window, for use with custom completion providers
 ---@return table
 function M.complete_info()
@@ -275,8 +300,8 @@ function M.complete_items(callback)
   async.run(function()
     local models = state.copilot:list_models()
     local agents = state.copilot:list_agents()
-    local items = {}
     local prompts_to_use = M.prompts()
+    local items = {}
 
     for name, prompt in pairs(prompts_to_use) do
       items[#items + 1] = {
@@ -323,6 +348,10 @@ function M.complete_items(callback)
       }
     end
 
+    table.sort(items, function(a, b)
+      return a.kind < b.kind
+    end)
+
     vim.schedule(function()
       callback(items)
     end)
@@ -784,9 +813,17 @@ function M.setup(config)
   end
 
   local hl_ns = vim.api.nvim_create_namespace('copilot-chat-highlights')
-  vim.api.nvim_set_hl(hl_ns, '@diff.plus', { bg = blend_color_with_neovim_bg('DiffAdd', 20) })
-  vim.api.nvim_set_hl(hl_ns, '@diff.minus', { bg = blend_color_with_neovim_bg('DiffDelete', 20) })
-  vim.api.nvim_set_hl(hl_ns, '@diff.delta', { bg = blend_color_with_neovim_bg('DiffChange', 20) })
+  vim.api.nvim_set_hl(hl_ns, '@diff.plus', { bg = utils.blend_color_with_neovim_bg('DiffAdd', 20) })
+  vim.api.nvim_set_hl(
+    hl_ns,
+    '@diff.minus',
+    { bg = utils.blend_color_with_neovim_bg('DiffDelete', 20) }
+  )
+  vim.api.nvim_set_hl(
+    hl_ns,
+    '@diff.delta',
+    { bg = utils.blend_color_with_neovim_bg('DiffChange', 20) }
+  )
   vim.api.nvim_set_hl(0, 'CopilotChatSpinner', { link = 'CursorColumn', default = true })
   vim.api.nvim_set_hl(0, 'CopilotChatHelp', { link = 'DiagnosticInfo', default = true })
   vim.api.nvim_set_hl(0, 'CopilotChatSelection', { link = 'Visual', default = true })
@@ -906,46 +943,23 @@ function M.setup(config)
 
       map_key(M.config.mappings.reset, bufnr, M.reset)
       map_key(M.config.mappings.close, bufnr, M.close)
+      map_key(M.config.mappings.complete, bufnr, trigger_complete)
 
-      map_key(M.config.mappings.complete, bufnr, function()
-        local info = M.complete_info()
-        local line = vim.api.nvim_get_current_line()
-        local cursor = vim.api.nvim_win_get_cursor(0)
-        local row = cursor[1]
-        local col = cursor[2]
-        if col == 0 or #line == 0 then
-          return
-        end
-
-        local prefix, cmp_start = unpack(vim.fn.matchstrpos(line:sub(1, col), info.pattern))
-        if not prefix then
-          return
-        end
-
-        if vim.startswith(prefix, '#') and vim.endswith(prefix, ':') then
-          local found_context = M.config.contexts[prefix:sub(2, -2)]
-          if found_context and found_context.input then
-            found_context.input(function(value)
-              if not value then
-                return
-              end
-
-              vim.api.nvim_buf_set_text(bufnr, row - 1, col, row - 1, col, { tostring(value) })
-            end)
-          end
-
-          return
-        end
+      if M.config.chat_autocomplete then
+        vim.api.nvim_create_autocmd('TextChangedI', {
+          buffer = bufnr,
+          callback = function()
+            local line = vim.api.nvim_get_current_line()
+            local cursor = vim.api.nvim_win_get_cursor(0)
+            local col = cursor[2]
+            local char = line:sub(col, col)
 
-        M.complete_items(function(items)
-          vim.fn.complete(
-            cmp_start + 1,
-            vim.tbl_filter(function(item)
-              return vim.startswith(item.word:lower(), prefix:lower())
-            end, items)
-          )
-        end)
-      end)
+            if vim.tbl_contains(M.complete_info().triggers, char) then
+              utils.debounce(trigger_complete, 100)
+            end
+          end,
+        })
+      end
 
       map_key(M.config.mappings.submit_prompt, bufnr, function()
         local chat_lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
diff --git a/lua/CopilotChat/integrations/cmp.lua b/lua/CopilotChat/integrations/cmp.lua
@@ -1,52 +1,9 @@
-local cmp = require('cmp')
-local chat = require('CopilotChat')
-
-local Source = {}
-
-function Source:get_trigger_characters()
-  return chat.complete_info().triggers
-end
-
-function Source:get_keyword_pattern()
-  return chat.complete_info().pattern
-end
-
-function Source:complete(params, callback)
-  chat.complete_items(function(items)
-    items = vim.tbl_map(function(item)
-      return {
-        label = item.word,
-        kind = cmp.lsp.CompletionItemKind.Keyword,
-      }
-    end, items)
-
-    local prefix = string.lower(params.context.cursor_before_line:sub(params.offset))
-
-    callback({
-      items = vim.tbl_filter(function(item)
-        return vim.startswith(item.label:lower(), prefix:lower())
-      end, items),
-    })
-  end)
-end
-
----@param completion_item lsp.CompletionItem
----@param callback fun(completion_item: lsp.CompletionItem|nil)
-function Source:execute(completion_item, callback)
-  callback(completion_item)
-  vim.api.nvim_set_option_value('buflisted', false, { buf = 0 })
-end
+local utils = require('CopilotChat.utils')
 
 local M = {}
 
---- Setup the nvim-cmp source for copilot-chat window
 function M.setup()
-  cmp.register_source('copilot-chat', Source)
-  cmp.setup.filetype('copilot-chat', {
-    sources = {
-      { name = 'copilot-chat' },
-    },
-  })
+  utils.deprecate('CopilotChat.integrations.cmp.setup', 'config.chat_autocomplete=true')
 end
 
 return M
diff --git a/lua/CopilotChat/utils.lua b/lua/CopilotChat/utils.lua
@@ -1,4 +1,3 @@
-local log = require('plenary.log')
 local M = {}
 
 --- Create class
@@ -74,6 +73,23 @@ function M.table_equals(a, b)
   return true
 end
 
+--- Blend a color with the neovim background
+function M.blend_color_with_neovim_bg(color_name, blend)
+  local color_int = vim.api.nvim_get_hl(0, { name = color_name }).fg
+  local bg_int = vim.api.nvim_get_hl(0, { name = 'Normal' }).bg
+
+  if not color_int or not bg_int then
+    return
+  end
+
+  local color = { (color_int / 65536) % 256, (color_int / 256) % 256, color_int % 256 }
+  local bg = { (bg_int / 65536) % 256, (bg_int / 256) % 256, bg_int % 256 }
+  local r = math.floor((color[1] * blend + bg[1] * (100 - blend)) / 100)
+  local g = math.floor((color[2] * blend + bg[2] * (100 - blend)) / 100)
+  local b = math.floor((color[3] * blend + bg[3] * (100 - blend)) / 100)
+  return string.format('#%02x%02x%02x', r, g, b)
+end
+
 --- Return to normal mode
 function M.return_to_normal_mode()
   local mode = vim.fn.mode():lower()
@@ -84,8 +100,17 @@ function M.return_to_normal_mode()
   end
 end
 
+--- Mark a function as deprecated
 function M.deprecate(old, new)
-  vim.deprecate(old, new, '3.0.0', 'CopilotChat.nvim', false)
+  vim.deprecate(old, new, '3.0.X', 'CopilotChat.nvim', false)
+end
+
+--- Debounce a function
+function M.debounce(fn, delay)
+  if M.timer then
+    M.timer:stop()
+  end
+  M.timer = vim.defer_fn(fn, delay)
 end
 
 return M
