feat: add copilot.suggestion module (zbirenbaum#53)

Author: MunifTanjim

README.md

@@ -65,6 +65,17 @@ The following is the default configuration:
 panel = { -- no config options yet
   enabled = true,
 },
+suggestion = {
+  enabled = true,
+  auto_trigger = false,
+  debounce = 75,
+  keymap = {
+   accept = "<M-l>",
+   next = "<M-]>",
+   prev = "<M-[>",
+   dismiss = "<C-]>",
+  },
+},
 ft_disable = {},
 copilot_node_command = 'node', -- Node version must be < 18
 plugin_manager_path = vim.fn.stdpath("data") .. "/site/pack/packer",
@@ -84,6 +95,29 @@ require("copilot").setup {
 
 ```
 
+#### suggestion
+
+When `auto_trigger` is `true`, copilot starts suggesting as soon as you enter insert mode. 
+
+When `auto_trigger` is `false`, use the `next` or `prev` keymap to trigger copilot suggestion.
+
+To toggle auto trigger for the current buffer, use `require("copilot.suggestion").toggle_auto_trigger()`.
+
+Copilot suggestion is automatically hidden when `popupmenu-completion` is open. In case you use a custom
+menu for completion, you can set the `copilot_suggestion_hidden` buffer variable to `true` to have the
+same behavior. For example, with `nvim-cmp`:
+
+```lua
+cmp.event:on("menu_opened", function()
+  vim.b.copilot_suggestion_hidden = true
+end)
+
+cmp.event:on("menu_closed", function()
+  vim.b.copilot_suggestion_hidden = false
+end)
+```
+
+
 ##### ft_disable
 
 Prevents copilot from attaching to buffers with specific filetypes.

lua/copilot/highlight.lua

@@ -0,0 +1,19 @@
+local mod = {
+  group = {
+    CopilotAnnotation = "CopilotAnnotation",
+    CopilotSuggestion = "CopilotSuggestion",
+  },
+}
+
+local links = {
+  [mod.group.CopilotAnnotation] = "Comment",
+  [mod.group.CopilotSuggestion] = "Comment",
+}
+
+function mod.setup()
+  for from_group, to_group in pairs(links) do
+    vim.api.nvim_command("highlight default link " .. from_group .. " " .. to_group)
+  end
+end
+
+return mod

lua/copilot/init.lua

@@ -1,9 +1,22 @@
 local M = { client_info = nil }
 local client = require("copilot.client")
+local highlight = require("copilot.highlight")
+local suggestion = require("copilot.suggestion")
 local defaults = {
   panel = { -- no config options yet
     enabled = true,
   },
+  suggestion = {
+    enabled = true,
+    auto_trigger = false,
+    debounce = 75,
+    keymap = {
+      accept = "<M-l>",
+      next = "<M-]>",
+      prev = "<M-[>",
+      dismiss = "<C-]>",
+    }
+  },
   ft_disable = {},
   copilot_node_command = "node",
   plugin_manager_path = vim.fn.stdpath("data") .. "/site/pack/packer",
@@ -49,7 +62,12 @@ M.setup = function(opts)
       create_cmds(user_config)
     end
 
+    if user_config.suggestion.enabled then
+      suggestion.setup(user_config.suggestion)
+    end
   end)
+
+  highlight.setup()
 end
 
 return M