feat!: allow lsp_handlers to be configured in setup with fine grained control

Author: mehalter

README.md

@@ -54,7 +54,6 @@ local opts = {
     codelens = true, -- enable/disable codelens refresh on start
     diagnostics_mode = 3, -- diagnostic mode on start (0 = off, 1 = no signs/virtual text, 2 = no virtual text, 3 = off)
     inlay_hints = false, -- enable/disable inlay hints on start
-    lsp_handlers = true, -- enable/disable setting of lsp_handlers
     semantic_tokens = true, -- enable/disable semantic token highlighting
   },
   -- Configure buffer local auto commands to add when attaching a language server
@@ -154,6 +153,11 @@ local opts = {
     -- set to false to disable the setup of a language server
     rust_analyzer = false,
   },
+  -- Configure `vim.lsp.handlers`
+  lsp_handlers = {
+    ["textDocument/hover"] = vim.lsp.with(vim.lsp.handlers.hover, { border = "rounded", silent = true }),
+    ["textDocument/signatureHelp"] = false, -- set to false to disable any custom handlers
+  },
   -- Configuration of mappings added when attaching a language server during the core `on_attach` function
   -- The first key into the table is the vim map mode (`:h map-modes`), and the value is a table of entries to be passed to `vim.keymap.set` (`:h vim.keymap.set`):
   --   - The key is the first parameter or the vim mode (only a single mode supported) and the value is a table of keymaps within that mode:

lua/astrolsp/config.lua

@@ -29,7 +29,6 @@
 ---@field codelens boolean? enable/disable codelens refresh on start (boolean; default = true)
 ---@field diagnostics_mode integer? diagnostic mode on start (0 = off, 1 = no signs/virtual text, 2 = no virtual text, 3 = off; default = 3)
 ---@field inlay_hints boolean? enable/disable inlay hints on start (boolean; default = false)
----@field lsp_handlers boolean? enable/disable setting of lsp_handlers (boolean; default = true)
 ---@field semantic_tokens boolean? enable/disable semantic token highlighting (boolean; default = true)
 
 ---@class AstroLSPFormatOnSaveOpts
@@ -102,7 +101,6 @@
 ---  codelens = true,
 ---  diagnostics_mode = 3,
 ---  inlay_hints = false,
----  lsp_handlers = true,
 ---  semantic_tokens = true,
 ---}
 ---```
@@ -197,6 +195,21 @@
 ---}
 ---```
 ---@field handlers table<string|integer,fun(server:string,opts:_.lspconfig.options)|boolean?>?
+---Configure global LSP handlers, set a method to `false` to use the Neovim default
+---Example:
+--
+---```lua
+---handlers = {
+---  -- custom function handler for pyright
+---  ["textDocument/hover"] = vim.lsp.with(
+---    vim.lsphandlers.hover, {
+---      border = "single",
+---      title = "hover",
+---    }
+---  )
+---}
+---```
+---@field lsp_handlers table<string,fun(err:lsp.ResponseError?,server:string,result:any,ctx:lsp.HandlerContext,config:table?)|false>|false?
 ---Configuration of mappings added when attaching a language server during the core `on_attach` function
 ---The first key into the table is the vim map mode (`:h map-modes`), and the value is a table of entries to be passed to `vim.keymap.set` (`:h vim.keymap.set`):
 ---  - The key is the first parameter or the vim mode (only a single mode supported) and the value is a table of keymaps within that mode:
@@ -267,7 +280,6 @@ local M = {
     codelens = true,
     diagnostics_mode = 3,
     inlay_hints = false,
-    lsp_handlers = true,
     semantic_tokens = true,
   },
   capabilities = {},
@@ -277,6 +289,7 @@ local M = {
   flags = {},
   formatting = { format_on_save = { enabled = true }, disabled = {} },
   handlers = {},
+  lsp_handlers = {},
   mappings = {},
   servers = {},
   on_attach = nil,

lua/astrolsp/init.lua

@@ -266,17 +266,17 @@ function M.setup(opts)
   end
 
   local progress_handler = vim.lsp.handlers["$/progress"]
-  vim.lsp.handlers["$/progress"] = function(_, msg, info)
-    local progress, id = M.lsp_progress, ("%s.%s"):format(info.client_id, msg.token)
-    progress[id] = progress[id] and vim.tbl_deep_extend("force", progress[id], msg.value) or msg.value
+  vim.lsp.handlers["$/progress"] = function(err, res, ctx)
+    local progress, id = M.lsp_progress, ("%s.%s"):format(ctx.client_id, res.token)
+    progress[id] = progress[id] and vim.tbl_deep_extend("force", progress[id], res.value) or res.value
     if progress[id].kind == "end" then
       vim.defer_fn(function()
         progress[id] = nil
         lsp_event "Progress"
       end, 100)
     end
     lsp_event "Progress"
-    progress_handler(_, msg, info)
+    progress_handler(err, res, ctx)
   end
 
   local register_capability_handler = vim.lsp.handlers["client/registerCapability"]
@@ -286,10 +286,8 @@ function M.setup(opts)
     return ret
   end
 
-  if M.config.features.lsp_handlers then
-    vim.lsp.handlers["textDocument/hover"] = vim.lsp.with(vim.lsp.handlers.hover, { border = "rounded", silent = true })
-    vim.lsp.handlers["textDocument/signatureHelp"] =
-      vim.lsp.with(vim.lsp.handlers.signature_help, { border = "rounded", silent = true })
+  for method, handler in pairs(M.config.lsp_handlers or {}) do
+    if handler then vim.lsp.handlers[method] = handler end
   end
 end