WIP

Author: AntoineGS

README.md

@@ -1,6 +1,7 @@
 # copilot.lua
 
 This plugin is the pure lua replacement for [github/copilot.vim](https://github.com/github/copilot.vim).
+A huge thank you to @tris203 for the code behind the nes functionality ([copilot-lsp](https://github.com/copilotlsp-nvim/copilot-lsp)).
 
 <details>
 <summary>Motivation behind `copilot.lua`</summary>
@@ -48,7 +49,11 @@ Install the plugin with your preferred plugin manager.
 For example, with [packer.nvim](https://github.com/wbthomason/packer.nvim):
 
 ```lua
-use { "zbirenbaum/copilot.lua" }
+use { "zbirenbaum/copilot.lua" 
+  requires = {
+    "copilotlsp-nvim/copilot-lsp", -- (optional) for NES functionality
+  },
+}
 ```
 
 ### Authentication
@@ -93,6 +98,9 @@ For example:
 ```lua
 use {
   "zbirenbaum/copilot.lua",
+  requires = {
+    "copilotlsp-nvim/copilot-lsp", -- (optional) for NES functionality
+  },
   cmd = "Copilot",
   event = "InsertEnter",
   config = function()
@@ -136,16 +144,8 @@ require('copilot').setup({
       dismiss = "<C-]>",
     },
   },
-  filetypes = {
-    yaml = false,
-    markdown = false,
-    help = false,
-    gitcommit = false,
-    gitrebase = false,
-    hgcommit = false,
-    svn = false,
-    cvs = false,
-    ["."] = false,
+  nes = {
+    enabled = false, -- requires copilot-lsp as a dependency
   },
   auth_provider_url = nil, -- URL to authentication provider, if not "https://github.com/"
   logger = {
@@ -270,6 +270,30 @@ require("copilot.suggestion").toggle_auto_trigger()
 ```
 These can also be accessed through the `:Copilot suggestion <function>` command (eg. `:Copilot suggestion accept`).
 
+### nes (next edit suggestion)
+
+When `enabled` is `true`, copilot will provide suggestions based on the next edit you are likely to make, through [copilot-lsp](https://github.com/copilotlsp-nvim/copilot-lsp).
+For additional configurations, please refer to the [copilot-lsp documentation](https://github.com/copilotlsp-nvim/copilot-lsp/blob/main/README.md).
+
+Configurations are better placed inside the require/dependency definition as such:
+
+```lua
+use {
+  "zbirenbaum/copilot.lua",
+  requires = {
+    "copilotlsp-nvim/copilot-lsp",
+    init = function()
+      vim.g.copilot_nes_debounce = 500
+    end,
+  },
+  cmd = "Copilot",
+  event = "InsertEnter",
+  config = function()
+    require("copilot").setup({})
+  end,
+}
+```
+
 ### filetypes
 
 Specify filetypes for attaching copilot.

lua/copilot/client/config.lua

@@ -122,6 +122,20 @@ function M.prepare_client_config(overrides, client)
         if token_env_set then
           require("copilot.auth").signin()
         end
+
+        if config.nes.enabled then
+          local au = vim.api.nvim_create_augroup("copilotlsp.init", { clear = true })
+
+          local ok, err = pcall(function()
+            require("copilot-lsp.nes").lsp_on_init(lsp_client, au)
+          end)
+
+          if ok then
+            logger.info("copilot-lsp.nes loaded")
+          else
+            logger.error("copilot-lsp.nes failed to load:", err)
+          end
+        end
       end)
     end,
     on_exit = function(code, _, client_id)

lua/copilot/config/init.lua

@@ -5,6 +5,7 @@ local logger = require("copilot.logger")
 ---@field suggestion SuggestionConfig
 ---@field logger LoggerConfig
 ---@field server ServerConfig
+---@field nes NesConfig
 ---@field filetypes table<string, boolean> Filetypes to enable Copilot for
 ---@field auth_provider_url string|nil URL for the authentication provider
 ---@field workspace_folders string[] Workspace folders to enable Copilot for
@@ -23,6 +24,7 @@ local M = {
   suggestion = require("copilot.config.suggestion").default,
   logger = require("copilot.config.logger").default,
   server = require("copilot.config.server").default,
+  nes = require("copilot.config.nes").default,
   root_dir = require("copilot.config.root_dir").default,
   should_attach = require("copilot.config.should_attach").default,
   filetypes = {},
@@ -59,6 +61,7 @@ end
 function M.validate(config)
   vim.validate("panel", config.panel, "table")
   vim.validate("suggestion", config.suggestion, "table")
+  vim.validate("nes", config.nes, "table")
   vim.validate("logger", config.logger, "table")
   vim.validate("server", config.server, "table")
   vim.validate("filetypes", config.filetypes, "table")
@@ -68,14 +71,15 @@ function M.validate(config)
   vim.validate("copilot_model", config.copilot_model, { "string", "nil" })
   vim.validate("root_dir", config.root_dir, { "string", "function" })
   vim.validate("should_attach", config.should_attach, "function")
-  vim.validate("copilot_node_command", config.copilot_node_command, {"string", "table"})
+  vim.validate("copilot_node_command", config.copilot_node_command, { "string", "table" })
 
   require("copilot.config.panel").validate(config.panel)
   require("copilot.config.suggestion").validate(config.suggestion)
   require("copilot.config.logger").validate(config.logger)
   require("copilot.config.server").validate(config.server)
   require("copilot.config.root_dir").validate(config.root_dir)
   require("copilot.config.should_attach").validate(config.should_attach)
+  require("copilot.config.nes").validate(config.nes)
 end
 
 return M

lua/copilot/config/nes.lua

@@ -0,0 +1,39 @@
+local logger = require("copilot.logger")
+---@class NesConfig
+---@field enabled boolean Whether to enable nes (next edit suggestions)
+
+local M = {
+  ---@type NesConfig
+  default = {
+    enabled = false,
+  },
+}
+
+---@type NesConfig
+M.config = vim.deepcopy(M.default)
+
+---@param opts? NesConfig
+function M.setup(opts)
+  opts = opts or {}
+  M.config = vim.tbl_deep_extend("force", M.default, opts)
+end
+
+---@param config NesConfig
+function M.validate(config)
+  vim.validate("enabled", config.enabled, "boolean")
+
+  if config.enabled then
+    local has_nes, _ = pcall(function()
+      require("copilot-lsp.nes")
+    end)
+
+    if not has_nes then
+      logger.error(
+        "copilot-lsp is not available, disabling nes.\nPlease refer to the documentation and ensure it is installed."
+      )
+      config.enabled = false
+    end
+  end
+end
+
+return M

lua/copilot/highlight.lua

@@ -1,3 +1,6 @@
+local logger = require("copilot.logger")
+local config = require("copilot.config")
+
 local M = {
   group = {
     CopilotAnnotation = "CopilotAnnotation",
@@ -19,6 +22,16 @@ function M.setup()
         vim.api.nvim_set_hl(0, from_group, { link = to_group })
       end
     end
+
+    if config.nes.enabled then
+      local ok, err = pcall(function()
+        require("copilot-lsp.util").set_hl()
+      end)
+
+      if not ok then
+        logger.error("Error setting copilot-lsp highlights: ", err)
+      end
+    end
   end)
 end