CopilotPanel Improvements and reorg

Author: zbirenbaum

lua/copilot/client.lua

@@ -1,31 +1,25 @@
 local M = { params = {} }
-local util = require("copilot.util")
+
+local register_autocmd = function ()
+  vim.api.nvim_create_autocmd({ "BufEnter" }, {
+    callback = vim.schedule_wrap(M.buf_attach_copilot),
+  })
+end
 
 M.buf_attach_copilot = function()
   if vim.tbl_contains(M.params.ft_disable, vim.bo.filetype) then return end
   if not vim.bo.buflisted or not vim.bo.buftype == "" then return end
-  local client_id = util.find_copilot_client()
-  local buf_clients = vim.lsp.buf_get_clients(0)
-  if not buf_clients and client_id or (client_id and not buf_clients[client_id]) then
-    vim.lsp.buf_attach_client(0, client_id)
-  end
-end
-
-local register_autocmd = function ()
-  if vim.fn.has("nvim-0.7") > 0 then
-    vim.api.nvim_create_autocmd({ "BufEnter" }, {
-      callback = vim.schedule_wrap(M.buf_attach_copilot),
-    })
-  else
-    vim.cmd("au BufEnter * lua vim.schedule(function() require('copilot.client').buf_attach_copilot() end)")
+  local name = M.params.server_opts_overrides.name or "copilot"
+  local client = vim.lsp.get_active_clients({name=name})[1]
+  if client and not vim.lsp.buf_is_attached(0, client.id) then
+    vim.lsp.buf_attach_client(0, client.id)
   end
 end
 
 M.merge_server_opts = function (params)
   return vim.tbl_deep_extend("force", {
     cmd = { "node", require("copilot.util").get_copilot_path(params.plugin_manager_path) },
     name = "copilot",
-    trace = "messages",
     root_dir = vim.loop.cwd(),
     autostart = true,
     on_init = function(_, _)
@@ -41,9 +35,7 @@ end
 
 M.start = function(params)
   M.params = params
-  local client_id = vim.lsp.start_client(M.merge_server_opts(params))
-  local client = vim.lsp.get_client_by_id(client_id)
-  return { client_id, client }
+  vim.lsp.start_client(M.merge_server_opts(params))
 end
 
 return M

lua/copilot/extensions/panel.lua

@@ -7,18 +7,18 @@ local panel = {
   method = "getPanelCompletions",
   usecmp = false,
   buf = "",
-  uri = "",
+  uri = "copilot:///placeholder",
 }
 
-local existing_matches= {}
-
 panel.send_request = function (callback)
   local completion_params = util.get_completion_params()
   completion_params.panelId = panel.uri
   callback = callback or function () end
   vim.lsp.buf_request(0, panel.method, completion_params, callback)
 end
 
+local existing_matches= {}
+
 local verify_existing = function (context)
   existing_matches[context.bufnr] = existing_matches[context.bufnr] or {}
   existing_matches[context.bufnr][context.cursor.row] = existing_matches[context.bufnr][context.cursor.row] or {}
@@ -60,35 +60,8 @@ function panel.create (max_results)
   panel.uri = vim.uri_from_bufnr(panel.buf)
 
   vim.api.nvim_create_user_command("CopilotPanel", function ()
+    panel.send_request()
     print_buf.create(panel.buf)
-    local items = {}
-    handler.add_handler_callback("PanelSolution", "pb", function (result)
-      local formatted = format.deindent(result.displayText)
-      items[formatted] = 1
-    end)
-    handler.add_handler_callback("PanelSolutionsDone", "pb", function ()
-      local item_list = vim.tbl_add_reverse_lookup(vim.tbl_keys(items))
-      local result_text = vim.tbl_flatten(vim.tbl_map(function(v)
-        local s = vim.fn.split(v, '\n')
-        local text = vim.tbl_map(function (t)
-          local number_string = "[" .. item_list[v] .. "]"
-          local str = (s[1] == t and number_string .. string.rep(' ', vim.o.shiftwidth)) or string.rep(' ', vim.o.shiftwidth+string.len(number_string))
-          return str .. t
-        end, s)
-        table.insert(text, '')
-        return text
-      end, item_list))
-      print_buf.set_text(result_text)
-      items = {}
-    end)
-    vim.api.nvim_create_autocmd("WinClosed", {
-      pattern = { tostring(print_buf.win) },
-      callback = function ()
-        handler.remove_handler_callback("PanelSolution", "pb")
-        handler.remove_handler_callback("PanelSolutionsDone", "pb")
-      end,
-      once = true,
-    })
   end, {})
 
   return panel

lua/copilot/extensions/print_panel.lua

@@ -1,28 +1,84 @@
 local a = vim.api
 local cmd = vim.cmd
 local wo = vim.wo
+local handler = require("copilot.handlers")
+local format = require("copilot_cmp.format")
+local print_panel = {}
 
-local print_buf = {}
+local set_text = function (full_text)
+  vim.api.nvim_buf_set_lines(print_panel.bufnr, 0, -1, false, {})
+  vim.api.nvim_buf_set_option(print_panel.bufnr, "modifiable", true)
+  vim.api.nvim_buf_set_option(print_panel.bufnr, "readonly", false)
 
-print_buf.set_text = function (full_text)
   local ft = vim.bo.filetype
-  vim.api.nvim_buf_call(print_buf.bufnr, function ()
+  vim.api.nvim_buf_call(print_panel.bufnr, function ()
     vim.bo.filetype = ft
   end)
-  vim.api.nvim_buf_set_lines(print_buf.bufnr, 0, -1, false, {})
-  vim.api.nvim_buf_set_var(print_buf.bufnr, "modifiable", 1)
-  vim.api.nvim_buf_set_var(print_buf.bufnr, "readonly", 0)
-  vim.api.nvim_buf_set_lines(print_buf.bufnr, 0, #full_text, false,full_text)
-
-  vim.schedule(function()
-    vim.api.nvim_buf_set_var(print_buf.bufnr, "modifiable", 0)
-    vim.api.nvim_buf_set_var(print_buf.bufnr, "readonly", 1)
+  vim.api.nvim_buf_set_lines(print_panel.bufnr, 0, #full_text, false,full_text)
+
+  vim.api.nvim_buf_set_option(print_panel.bufnr, "modifiable", false)
+  vim.api.nvim_buf_set_option(print_panel.bufnr, "readonly", true)
+end
+
+local format_entry = function (number, str)
+  local lines = {}
+  for s in str:gmatch("[^\r\n]+") do table.insert(lines, s) end
+  table.insert(lines, '')
+  return {
+    len = #lines,
+    lines = lines,
+    number = number,
+  }
+end
+
+local sort_items = function (items)
+  local sorted = {}
+  for fmt_string, value in pairs(items) do
+    sorted[value.score] = fmt_string
+  end
+  return sorted
+end
+
+local make_entries = function (items)
+  local entries = {}
+  items = sort_items(items)
+  for number, str in ipairs(vim.tbl_values(items)) do
+    table.insert(entries, format_entry(number, str))
+  end
+  for index, _ in ipairs(entries) do
+    local last = entries[index-1]
+    entries[index].linenr = last and last.linenr + last.len or 1
+  end
+  return entries
+end
+
+local get_full_text = function (entries)
+  return vim.tbl_flatten(vim.tbl_map(function(e)
+    return e.lines
+  end, entries))
+end
+
+print_panel.add_panel_callbacks = function ()
+  local items = {}
+
+  handler.add_handler_callback("PanelSolution", "pb", function (result)
+    local formatted = format.deindent(result.displayText)
+    items[formatted] = result
+  end)
+
+  handler.add_handler_callback("PanelSolutionsDone", "pb", function ()
+    if vim.tbl_isempty(items) then return end
+    print_panel.entries = make_entries(items)
+    print_panel.current = 1
+    set_text(get_full_text(print_panel.entries))
+    items = {}
   end)
 end
 
 local create_win = function ()
   local oldwin = a.nvim_get_current_win() --record current window
-  cmd("vsplit")
+  local height = tostring(math.floor(vim.api.nvim_win_get_height(oldwin)*.3))
+  cmd(height .. "split")
   local win = a.nvim_get_current_win()
   wo.number = false
   wo.relativenumber = false
@@ -32,10 +88,113 @@ local create_win = function ()
   return win
 end
 
-print_buf.create = function (bufnr)
-  print_buf.bufnr = bufnr
-  print_buf.win = create_win()
-  a.nvim_win_set_buf(print_buf.win, print_buf.bufnr)
+print_panel.select = function (id)
+  if not id then id = print_panel.current or 1 end
+  local selection = print_panel.entries[id]
+  vim.api.nvim_win_set_cursor(print_panel.win, {selection.linenr, 0})
+  vim.cmd("normal zt")
+  print_panel.current = id
+  print_panel.linenr = selection.linenr
+end
+
+print_panel.next = function ()
+  local entries = print_panel.entries
+  local current = print_panel.current
+  local id = entries[current+1] and current+1 or 1
+  print_panel.select(id)
 end
 
-return print_buf
+print_panel.prev = function ()
+  local entries = print_panel.entries
+  local current = print_panel.current
+  local id = entries[current-1] and current-1 or #entries
+  print_panel.select(id)
+end
+
+print_panel.set_options = function ()
+  local opts = {
+    win = { fcs = "eob: ", signcolumn = "no", list = false},
+    buf = { bufhidden = "wipe", buftype = "nofile", swapfile = false, buflisted = false, }
+  }
+  for option, value in pairs(opts.win) do
+    vim.api.nvim_win_set_option(print_panel.win, option, value)
+  end
+
+  for option, value in pairs(opts.buf) do
+    vim.api.nvim_buf_set_option(print_panel.bufnr, option, value)
+  end
+end
+
+print_panel.create = function (bufnr)
+  print_panel.bufnr = bufnr
+  print_panel.win = create_win()
+  print_panel.last = 1
+  a.nvim_win_set_buf(print_panel.win, print_panel.bufnr)
+  print_panel.set_options()
+  print_panel.add_panel_callbacks()
+
+  local keymaps = {
+    ["j"] = print_panel.next,
+    ["k"] = print_panel.prev,
+    ["<CR>"] = print_panel.select,
+  }
+
+  for key, fn  in pairs(keymaps) do
+    vim.keymap.set("n", key, fn, {
+      silent = true,
+      buffer = print_panel.bufnr,
+    })
+  end
+
+  local id = vim.api.nvim_create_augroup("Panel", {
+    clear = false
+  })
+
+  vim.api.nvim_create_autocmd({"TextChangedI", "TextChangedP"}, {
+    callback = function ()
+      print("callback")
+      require("copilot.extensions.panel").send_request()
+    end,
+    group = id,
+  })
+
+  vim.api.nvim_create_autocmd("WinEnter", {
+    callback = function ()
+      if print_panel.entries then
+        print_panel.select(print_panel.entries.current)
+      end
+    end,
+    buffer = print_panel.bufnr,
+    group = id,
+  })
+
+  vim.api.nvim_create_autocmd("WinClosed", {
+    pattern = { tostring(print_panel.win) },
+    callback = function ()
+      -- cleanup panel triggers
+      vim.api.nvim_create_augroup("Panel", { clear = true })
+      handler.remove_handler_callback("PanelSolution", "pb")
+      handler.remove_handler_callback("PanelSolutionsDone", "pb")
+    end,
+    once = true,
+    group = id,
+  })
+end
+
+return print_panel
+
+-- if you add back numbering:
+--
+-- local add_prefix_spacing = function (str, number)
+--   return string.rep(' ', number) .. str
+-- end
+--
+-- local entry_str = "[" .. number .. "]"
+-- for index, value in ipairs(lines) do
+--   if index == 1 then
+--     lines[index] = entry_str .. add_prefix_spacing(value, vim.o.shiftwidth)
+--   else
+--     lines[index] = add_prefix_spacing(value, vim.o.shiftwidth+entry_str:len())
+--   end
+-- end
+

lua/copilot/init.lua

@@ -3,13 +3,12 @@ local client = require("copilot.client")
 
 local defaults = {
   cmp = {
-    method = "getPanelCompletions",
+    method = "getCompletionsCycling",
     max_results = 5,
   },
   extensions = {
-    getPanelCompletions = function (max_results)
-      local panel = require("copilot.extensions.panel").create(max_results)
-      require("copilot_cmp").setup(panel.complete)
+    getPanelCompletions = function ()
+      require("copilot_cmp").setup(require("copilot.panel").complete)
     end,
     getCompletionsCycling = function ()
       require("copilot_cmp").setup()
@@ -33,6 +32,7 @@ end
 
 M.setup = function(opts)
   local user_config = config_handler(opts)
+  require("copilot.extensions.panel").create()
   vim.schedule(function () client.start(user_config) end)
 end
 

lua/copilot/util.lua

@@ -1,14 +1,5 @@
 local M = {}
 
-local oldprint = print
-local print = function (args)
-  if type(args) == "table" then
-    oldprint(vim.inspect(args))
-  else
-    oldprint(args)
-  end
-end
-
 local format_pos = function()
   local pos = vim.api.nvim_win_get_cursor(0)
   return { character = pos[2], line = pos[1] - 1 }
@@ -20,23 +11,10 @@ local get_relfile = function()
 end
 
 M.find_copilot_client = function()
-  for _, client in ipairs(vim.lsp.get_active_clients()) do
-    if client.name == "copilot" then
-      return client.id
-    end
-  end
+  vim.lsp.get_active_clients({name="copilot"})
 end
 
-M.find_copilot_buf_client = function()
-  for _, client in ipairs(vim.lsp.buf_get_clients(0)) do
-    if client.name == "copilot" then
-      return client.id
-    end
-  end
-end
-
-
-M.get_completion_params = function(method)
+M.get_completion_params = function()
   local rel_path = get_relfile()
   local uri = vim.uri_from_bufnr(0)
   local params = {