Merge pull request #422 from zbirenbaum/various_cleanups

Various cleanups

Author: AntoineGS

README.md

@@ -11,6 +11,11 @@ As lua is far more efficient and makes things easier to integrate with modern pl
 
 </details>
 
+## Requirements
+
+- Curl
+- NeoVim 0.10.0 or higher
+
 ## Install
 
 Install the plugin with your preferred plugin manager.

lua/copilot/api.lua

@@ -3,7 +3,7 @@ local mod = {}
 
 ---@param callback? fun(err: any|nil, data: table, ctx: table): nil
 ---@return any|nil err
----@return table data
+---@return any data
 ---@return table ctx
 function mod.request(client, method, params, callback)
   logger.trace("api request:", method, params)
@@ -139,14 +139,13 @@ function mod.get_completions_cycling(client, params, callback)
   return mod.request(client, "getCompletionsCycling", params, callback)
 end
 
----@alias copilot_get_panel_completions_data { solutionCountTarget: integer }
 ---@alias copilot_panel_solution_data { panelId: string, completionText: string, displayText: string, range: { ['end']: { character: integer, line: integer }, start: { character: integer, line: integer } }, score: number, solutionId: string }
 ---@alias copilot_panel_on_solution_handler fun(result: copilot_panel_solution_data): nil
 ---@alias copilot_panel_solutions_done_data { panelId: string, status: 'OK'|'Error', message?: string }
 ---@alias copilot_panel_on_solutions_done_handler fun(result: copilot_panel_solutions_done_data): nil
 
 ---@return any|nil err
----@return copilot_get_panel_completions_data data
+---@return integer data
 ---@return table ctx
 function mod.get_panel_completions(client, params, callback)
   return mod.request(client, "getPanelCompletions", params, callback)

lua/copilot/client.lua

@@ -40,26 +40,6 @@ local function store_client_id(id)
   M.id = id
 end
 
-local lsp_start = vim.lsp.start
-if not lsp_start then
-  local function reuse_client(client, conf)
-    return client.config.root_dir == conf.root_dir and client.name == conf.name
-  end
-
-  -- shim for neovim < 0.8.2
-  lsp_start = function(lsp_config)
-    local bufnr = vim.api.nvim_get_current_buf()
-    local client = M.get()
-    if client and reuse_client(client, lsp_config) then
-      vim.lsp.buf_attach_client(bufnr, client.id)
-      return client.id
-    end
-    local client_id = vim.lsp.start_client(lsp_config) --[[@as number]]
-    vim.lsp.buf_attach_client(bufnr, client_id)
-    return client_id
-  end
-end
-
 function M.buf_is_attached(bufnr)
   return M.id and vim.lsp.buf_is_attached(bufnr or 0, M.id)
 end
@@ -92,7 +72,7 @@ function M.buf_attach(force)
   -- In case it has changed, we update it
   M.config.root_dir = config.get_root_dir()
 
-  local ok, client_id_or_err = pcall(lsp_start, M.config)
+  local ok, client_id_or_err = pcall(vim.lsp.start, M.config)
   if not ok then
     logger.error(string.format("failed to start LSP client: %s", client_id_or_err))
     return
@@ -111,6 +91,7 @@ function M.buf_detach()
   end
 end
 
+---@return nil|vim.lsp.Client
 function M.get()
   return vim.lsp.get_client_by_id(M.id)
 end
@@ -134,7 +115,7 @@ function M.use_client(callback)
       return
     end
 
-    local client_id, err = vim.lsp.start_client(M.config)
+    local client_id, err = vim.lsp.start(M.config)
 
     if not client_id then
       logger.error(string.format("error starting LSP client: %s", err))
@@ -434,7 +415,7 @@ function M.add_workspace_folder(folder_path)
 
   local client = M.get()
   if client and client.initialized then
-    client.notify("workspace/didChangeWorkspaceFolders", {
+    api.notify(client, "workspace/didChangeWorkspaceFolders", {
       event = {
         added = { workspace_folder },
         removed = {},

lua/copilot/config.lua

@@ -45,8 +45,6 @@ local default_config = {
     trace_lsp_progress = false,
     log_lsp_messages = false,
   },
-  ---@deprecated
-  ft_disable = nil,
   ---@type table<string, boolean>
   filetypes = {},
   ---@type string|nil

lua/copilot/handlers.lua

@@ -4,7 +4,6 @@ local highlight = require("copilot.highlight")
 local logger = require("copilot.logger")
 local client = require("copilot.client")
 local auth = require("copilot.auth")
-local lsp_binary = require("copilot.lsp_binary")
 
 local create_cmds = function()
   vim.api.nvim_create_user_command("CopilotDetach", function()

lua/copilot/init.lua

@@ -12,6 +12,7 @@ local marker_prefix = "[copilot] "
 local panel_uri_prefix = "copilot://"
 
 local panel = {
+  ---@type vim.lsp.Client
   client = nil,
   setup_done = false,
 
@@ -27,6 +28,7 @@ local panel = {
   filetype = nil,
 
   state = {
+    ---@type integer|nil
     req_id = nil,
     line = nil,
     status = nil,
@@ -414,7 +416,7 @@ function panel:refresh()
   end
 
   if self.state.req_id then
-    self.client.cancel_request(self.state.req_id)
+    self.client:cancel_request(self.state.req_id)
     self.state.req_id = nil
   end
 
@@ -430,7 +432,6 @@ function panel:refresh()
       end
 
       self.state.received_count = type(self.state.received_count) == "number" and self.state.received_count + 1 or 1
-
       self:unlock():refresh_header():add_entry(result):lock()
     end,
     ---@param result copilot_panel_solutions_done_data
@@ -466,31 +467,32 @@ function panel:refresh()
   if not auto_refreshing and self.state.was_insert then
     vim.cmd("stopinsert")
   else
+    local utf16_index
     -- assume cursor at end of line
-    local _, utf16_index = vim.str_utfindex(self.state.line)
+    if vim.has("nvim-0.11") then
+      utf16_index = vim.str_utfindex(self.state.line, "utf-16")
+    else
+      ---@diagnostic disable-next-line: missing-parameter
+      _, utf16_index = vim.str_utfindex(self.state.line)
+    end
     params.doc.position.character = utf16_index
     params.position.character = params.doc.position.character
   end
 
   -- on_solutions_done can be invoked before the api.get_panel_completions callback
   self.state.status = "loading"
 
-  local _, id = api.get_panel_completions(
-    self.client,
-    params,
-    ---@param result copilot_get_panel_completions_data
-    function(err, result)
-      if err then
-        self.state.status = "error"
-        self.state.error = err
-        logger.error(self.state.error)
-        return
-      end
-
-      self.state.expected_count = result.solutionCountTarget
-      panel:unlock():refresh_header():lock()
+  local _, id = api.get_panel_completions(self.client, params, function(err, result)
+    if err then
+      self.state.status = "error"
+      self.state.error = err
+      logger.error(self.state.error)
+      return
     end
-  )
+
+    self.state.expected_count = result.solutionCountTarget
+    panel:unlock():refresh_header():lock()
+  end)
 
   self.state.req_id = id
 end

lua/copilot/panel.lua

@@ -37,12 +37,6 @@ function M.get_copilot_lua_version()
   return copilot_lua_version
 end
 
--- use `require("copilot.client").get()`
----@deprecated
-M.get_copilot_client = function()
-  return require("copilot.client").get()
-end
-
 local internal_filetypes = {
   yaml = false,
   markdown = false,
@@ -106,12 +100,6 @@ function M.should_attach()
   return true
 end
 
--- use `require("copilot.client").buf_is_attached()`
----@deprecated
-function M.is_attached()
-  return require("copilot.client").buf_is_attached(0)
-end
-
 local language_normalization_map = {
   bash = "shellscript",
   bst = "bibtex",
@@ -179,12 +167,6 @@ function M.get_doc_params(overrides)
   return params
 end
 
--- use `require("copilot.util").get_doc_params()`
----@deprecated
-M.get_completion_params = function(opts)
-  return M.get_doc_params(opts)
-end
-
 ---@return copilot_workspace_configurations
 function M.get_workspace_configurations()
   local conf = config.get() --[[@as copilot_config]]
@@ -227,11 +209,6 @@ M.get_plugin_path = function()
   end
 end
 
----@deprecated
-M.auth = function()
-  require("copilot.auth").signin()
-end
-
 ---@param str string
 ---@return integer
 function M.strutf16len(str)