feat: add copilot.panel module (zbirenbaum#50)

* refactor: use copilot.api in copilot.handlers module

* feat: add copilot.panel module

* feat(panel): use virtual text as marker

Author: MunifTanjim

README.md

@@ -64,6 +64,14 @@ The following is the default configuration:
 ```lua
 panel = { -- no config options yet
   enabled = true,
+  auto_refresh = false,
+  keymap = {
+    jump_prev = "[[",
+    jump_next = "]]",
+    accept = "<CR>",
+    refresh = "gr",
+    open = "<M-CR>"
+  },
 },
 suggestion = {
   enabled = true,
@@ -84,16 +92,10 @@ server_opts_overrides = {},
 
 ##### panel
 
-Enabling panel creates the `CopilotPanel` command, which allows you to preview completions in a split window. Navigating to the split window allows you to jump between them and see each one. (<CR> to accept completion not yet implemented, coming soon)
-
-```lua
-require("copilot").setup {
-  panel = {
-    enabled = false,
-  }
-},
+Enabling panel creates the `CopilotPanel` command, which allows you to preview suggestions
+in a split window.
 
-```
+If `auto_refresh` is `true`, the suggestions are refreshed as you type in the buffer.
 
 #### suggestion
 

lua/copilot/client.lua

@@ -38,8 +38,8 @@ M.merge_server_opts = function (params)
       vim.schedule(register_autocmd)
     end,
     handlers = {
-      -- PanelSolution = api.handlers.PanelSolution,
-      -- PanelSolutionsDone = api.handlers.PanelSolutionsDone,
+      PanelSolution = api.handlers.PanelSolution,
+      PanelSolutionsDone = api.handlers.PanelSolutionsDone,
       statusNotification = api.handlers.statusNotification,
     }
   }, params.server_opts_overrides or {})

lua/copilot/extensions/panel.lua

@@ -1,47 +1,24 @@
-local lsp_handlers = {
-  callbacks = {
-    ["PanelSolution"] = {},
-    ["PanelSolutionsDone"] = {}
-  },
-}
+local api = require("copilot.api")
 
-local handlers = {
-  ["PanelSolution"] = function (_, result, _, config)
-    if not result then return "err" end
-    if result.panelId and config.callbacks[result.panelId] then
-      config.callbacks[result.panelId](result)
-    elseif not config.callbacks[result.panelId] and result.panelId then
-      return
-    else
-      for _, callback in pairs(config.callbacks) do callback() end
-    end
-  end,
+---@deprecated
+local handlers = {}
 
-  ["PanelSolutionsDone"] = function (_, _, _, config)
-    for _, callback in pairs(config.callbacks) do
-      callback()
-    end
-  end
-}
-
-lsp_handlers.add_handler_callback = function (handler, fn_name, fn)
-  lsp_handlers.callbacks[handler][fn_name] = fn
-  vim.lsp.handlers[handler] = vim.lsp.with(handlers[handler], {
-    callbacks = lsp_handlers.callbacks[handler]
-  })
+-- use `require("copilot.api").register_panel_handlers()`
+---@deprecated
+handlers.add_handler_callback = function(method, panelId, fn)
+  api.panel.callback[method][panelId] = fn
 end
 
-lsp_handlers.remove_handler_callback = function (handler, fn_name)
-  lsp_handlers.callbacks[handler][fn_name] = nil
-  vim.lsp.handlers[handler] = vim.lsp.with(handlers[handler], {
-    callbacks = lsp_handlers.callbacks[handler]
-  })
+-- use `require("copilot.api").unregister_panel_handlers()`
+---@deprecated
+handlers.remove_handler_callback = function(method, panelId)
+  api.panel.callback[method][panelId] = nil
 end
 
-lsp_handlers.remove_all_name = function (fn_name)
-  for handler, _ in pairs(lsp_handlers.callbacks) do
-    lsp_handlers.remove_handler_callback(handler, fn_name)
-  end
+-- use `require("copilot.api").unregister_panel_handlers()`
+---@deprecated
+handlers.remove_all_name = function(panelId)
+  api.unregister_panel_handlers(panelId)
 end
 
-return lsp_handlers
+return handlers

lua/copilot/extensions/print_panel.lua

@@ -1,10 +1,19 @@
 local M = { client_info = nil }
 local client = require("copilot.client")
 local highlight = require("copilot.highlight")
+local panel = require("copilot.panel")
 local suggestion = require("copilot.suggestion")
 local defaults = {
-  panel = { -- no config options yet
+  panel = {
     enabled = true,
+    auto_refresh = false,
+    keymap = {
+      jump_prev = "[[",
+      jump_next = "]]",
+      accept = "<CR>",
+      refresh = "gr",
+      open = "<M-CR>"
+    }
   },
   suggestion = {
     enabled = true,
@@ -38,9 +47,7 @@ local create_cmds = function (_)
   end, {})
 
   vim.api.nvim_create_user_command("CopilotPanel", function ()
-    local panel = require("copilot.extensions.panel").create()
-    panel.send_request()
-    require("copilot.extensions.print_panel").create(panel.buf)
+    require("copilot.panel").open()
   end, {})
 
   vim.api.nvim_create_user_command("CopilotAuth", function()
@@ -59,6 +66,7 @@ M.setup = function(opts)
     client.start(user_config)
 
     if user_config.panel.enabled then
+      panel.setup(user_config.panel)
       create_cmds(user_config)
     end