feat: ability to switch between js (default) and binary server type

Author: AntoineGS

README.md

@@ -110,7 +110,7 @@ require('copilot').setup({
     trace_lsp_progress = false,
     log_lsp_messages = false,
   },
-  copilot_node_command = 'node', -- Node.js version must be > 18.x
+  copilot_node_command = 'node', -- Node.js version must be > 20
   workspace_folders = {},
   copilot_model = "",  -- Current LSP default is gpt-35-turbo, supports gpt-4o-copilot
   root_dir = function()
@@ -129,7 +129,10 @@ require('copilot').setup({
 
     return true
   end,
-  lsp_binary = nil,
+  server = {
+    type = "nodejs", -- "nodejs" | "binary"
+    custom_server_filepath = nil,
+  },
   server_opts_overrides = {},
 })
 ```
@@ -280,6 +283,16 @@ When `log_lsp_messages` is true, LSP log messages (`window/logMessage`) events w
 
 Careful turning on all logging features as the log files may get very large over time, and are not pruned by the application.
 
+### copilot_node_command
+
+Use this field to provide the path to a specific node version such as one installed by nvm. Node.js version must be 20 or newer.
+
+Example:
+
+```lua
+copilot_node_command = vim.fn.expand("$HOME") .. "/.config/nvm/versions/node/v20.0.1/bin/node", -- Node.js version must be > 20
+```
+
 ### server_opts_overrides
 
 Override copilot lsp client settings. The `settings` field is where you can set the values of the options defined in [SettingsOpts.md](./SettingsOpts.md).
@@ -344,15 +357,22 @@ require("copilot").setup {
 }
 ```
 
-### lsp_binary
+### server
+
+> [!CAUTION] > `"binary"` mode is still very much experimental, please report any issues you encounter.
 
-This allows you to specify the path to the copilot lsp binary.
-This will disable the download of the binary and use the one specified.
+`type` can be either `"nodejs"` or `"binary"`. The binary version will be downloaded if used.
+
+`custom_server_filepath` is used to specify the path of either the path (filename included) of the `js` file if using `"nodejs"` or the path to the binary if using `"binary"`.
+When using `"binary"`, the download process will be disabled and the binary will be used directly.
 example:
 
 ```lua
 require("copilot").setup {
-  lsp_binary = "/home/user/.local/bin/copilot-language-server",
+  server = {
+    type = "nodejs",
+    custom_server_filepath = "/home/user/copilot-lsp/language-server.js",,
+  },
 }
 ```
 

lua/copilot/client.lua

@@ -3,6 +3,7 @@ local config = require("copilot.config")
 local util = require("copilot.util")
 local logger = require("copilot.logger")
 local lsp_binary = require("copilot.lsp_binary")
+local lsp_nodesj = require("copilot.lsp_nodejs")
 
 local is_disabled = false
 
@@ -18,6 +19,14 @@ local M = {
   initialized = false,
   ---@type copilot_should_attach
   should_attach = nil,
+  ---@type string<'nodejs', 'binary'>
+  ---@class copilot_config_server
+  server = {
+    ---@type string<'nodejs', 'binary'>
+    type = "nodejs",
+    ---@type string|nil
+    custom_server_filepath = nil,
+  },
 }
 
 ---@param id integer
@@ -195,14 +204,25 @@ end
 
 local function prepare_client_config(overrides)
   if lsp_binary.initialization_failed then
-    M.startup_error = "initializatino of copilot-language-server failed"
+    M.startup_error = "initialization of copilot-language-server failed"
     return
   end
 
-  local server_path = lsp_binary.get_copilot_server_info().absolute_filepath
-
   M.startup_error = nil
 
+  local server_path = nil
+  local node_cmd = ""
+  if M.server.type == "nodejs" then
+    node_cmd = lsp_nodesj.node_command
+    server_path = lsp_nodesj.get_server_path()
+  elseif M.server.type == "binary" then
+    server_path = lsp_binary.get_server_path()
+  end
+
+  if M.server.custom_server_filepath and vim.fn.filereadable(M.server.custom_server_filepath) then
+    server_path = M.server.custom_server_filepath
+  end
+
   local capabilities = vim.lsp.protocol.make_client_capabilities() --[[@as copilot_capabilities]]
   capabilities.window.showDocument.support = true
 
@@ -266,6 +286,7 @@ local function prepare_client_config(overrides)
   -- LSP config, not to be confused with config.lua
   return vim.tbl_deep_extend("force", {
     cmd = {
+      node_cmd,
       server_path,
       "--stdio",
     },
@@ -310,7 +331,6 @@ local function prepare_client_config(overrides)
     end,
     handlers = get_handlers(),
     init_options = {
-      copilotIntegrationId = "vscode-chat", -- can be safely removed with copilot v1.291
       editorInfo = editor_info.editorInfo,
       editorPluginInfo = editor_info.editorPluginInfo,
     },
@@ -321,8 +341,15 @@ local function prepare_client_config(overrides)
 end
 
 function M.setup()
-  M.config = prepare_client_config(config.get("server_opts_overrides"))
   M.should_attach = config.get("should_attach") --[[@as copilot_should_attach|nil]]
+  local server_config = config.get("server") --[[@as copilot_config_server]]
+  local node_command = config.get("copilot_node_command") --[[@as string|nil]]
+  M.server = vim.tbl_deep_extend("force", M.server, server_config)
+  if M.server.type == "nodejs" then
+    lsp_nodesj.setup(node_command, M.server.custom_server_filepath)
+  end
+
+  M.config = prepare_client_config(config.get("server_opts_overrides"))
 
   if not M.config then
     is_disabled = true

lua/copilot/config.lua

@@ -75,8 +75,14 @@ local default_config = {
 
     return true
   end,
-  ---@type string|nil
-  lsp_binary = nil,
+  copilot_node_command = "node",
+  ---@class copilot_config_server
+  server = {
+    ---@type string<'nodejs', 'binary'>
+    type = "nodejs",
+    ---@type string|nil
+    custom_server_filepath = nil,
+  },
 }
 
 local mod = {

lua/copilot/lsp_binary.lua

@@ -321,6 +321,12 @@ function M.get_copilot_server_info()
   return M.copilot_server_info
 end
 
+---@return string
+function M.get_server_path()
+  return M.get_copilot_server_info().absolute_filepath
+end
+
+---@param filepath string|nil
 function M.setup(filepath)
   if not filepath then
     return M

lua/copilot/lsp_nodejs.lua

@@ -0,0 +1,101 @@
+local logger = require("copilot.logger")
+
+local M = {
+  ---@class copilot_nodejs_server_info
+  ---@type string
+  node_command = nil,
+  ---@type string
+  server_path = nil,
+}
+
+---@return string node_version
+---@return nil|string node_version_error
+function M.get_node_version()
+  if not M.node_version then
+    local cmd = { M.node_command, "--version" }
+    local cmd_output_table = vim.fn.executable(M.node_command) == 1 and vim.fn.systemlist(cmd, nil, 0) or { "" }
+    local cmd_output = cmd_output_table[#cmd_output_table]
+    local cmd_exit_code = vim.v.shell_error
+
+    local node_version = string.match(cmd_output, "^v(%S+)") or ""
+    local node_version_major = tonumber(string.match(node_version, "^(%d+)%.")) or 0
+
+    if node_version_major == 0 then
+      M.node_version_error = table.concat({
+        "Could not determine Node.js version",
+        "-----------",
+        "(exit code) " .. tostring(cmd_exit_code),
+        "   (output) " .. cmd_output,
+        "-----------",
+      }, "\n")
+    elseif node_version_major < 20 then
+      M.node_version_error = string.format("Node.js version 20 or newer required but found %s", node_version)
+    end
+
+    M.node_version = node_version or ""
+  end
+
+  return M.node_version, M.node_version_error
+end
+
+---@return boolean
+function M.validate_node_version()
+  local _, node_version_error = M.get_node_version()
+
+  if node_version_error then
+    logger.error(node_version_error)
+    return false
+  end
+
+  return true
+end
+
+function M.node_exists()
+  local node_exists = vim.fn.executable(M.node_command) == 1
+
+  if not node_exists then
+    logger.error("node.js is not installed or not in PATH")
+    return false
+  end
+
+  return true
+end
+
+---@param server_path? string
+---@return boolean
+function M.init_agent_path(server_path)
+  local agent_path = server_path or vim.api.nvim_get_runtime_file("copilot/js/language-server.js", false)[1]
+
+  if not agent_path or vim.fn.filereadable(agent_path) == 0 then
+    logger.error(string.format("could not find server (bad install?) : %s", tostring(agent_path)))
+    return false
+  end
+
+  M.server_path = agent_path
+  return true
+end
+
+---@return string|nil
+function M.get_server_path()
+  if not M.server_path then
+    logger.error("server path is not set")
+    return nil
+  end
+
+  return M.server_path
+end
+
+---@param node_command? string
+---@param custom_server_path? string
+---@return boolean
+function M.setup(node_command, custom_server_path)
+  M.node_command = node_command or "node"
+
+  if not M.node_exists() or not M.validate_node_version() or not M.init_agent_path(custom_server_path) then
+    return false
+  end
+
+  return true
+end
+
+return M

lua/copilot/util.lua

@@ -19,7 +19,7 @@ function M.get_editor_info()
     editorPluginInfo = {
       name = "copilot.lua",
       -- reflects version of github/copilot-language-server-release
-      version = "1.292.0",
+      version = "1.294.0",
     },
   }
   return info