feat: add configurable LSP features

Author: mehalter

lua/astrolsp/config/init.lua

@@ -1,6 +1,15 @@
 local schemastore_avail, schemastore = pcall(require, "schemastore")
 
 return {
+  features = {
+    autoformat_enabled = true,
+    codelens = true,
+    diagnostics_mode = 3,
+    inlay_hints = false,
+    lsp_handlers = true,
+    semantic_tokens = true,
+  },
+
   diagnostics = {
     virtual_text = true,
     signs = {

lua/astrolsp/config/mappings.lua

@@ -46,12 +46,12 @@ M.n["<leader>lf"] =
   { function() vim.lsp.buf.format(M.format_opts) end, desc = "Format buffer", cond = "textDocument/formatting" }
 M.v["<leader>lf"] = M.n["<leader>lf"]
 M.n["<leader>uf"] = {
-  function() require("astrolsp.utils").toggle_buffer_autoformat() end,
+  function() require("astrolsp.toggles").buffer_autoformat() end,
   desc = "Toggle autoformatting (buffer)",
   cond = "textDocument/formatting",
 }
 M.n["<leader>uF"] = {
-  function() require("astrolsp.utils").toggle_autoformat() end,
+  function() require("astrolsp.toggles").autoformat() end,
   desc = "Toggle autoformatting (global)",
   cond = "textDocument/formatting",
 }
@@ -65,14 +65,7 @@ M.n["gI"] = {
 }
 
 M.n["<leader>uH"] = {
-  function()
-    vim.b.inlay_hints_enabled = not vim.b.inlay_hints_enabled
-    -- TODO: remove check after dropping support for Neovim v0.9
-    if vim.lsp.inlay_hint then
-      vim.lsp.inlay_hint(0, vim.b.inlay_hints_enabled)
-      vim.notify(("Inlay hints %s"):format(vim.b.inlay_hints_enabled and "on" or "off"))
-    end
-  end,
+  function() require("astrolsp.toggles").buffer_inlay_hints() end,
   desc = "Toggle LSP inlay hints (buffer)",
   cond = vim.lsp.inlay_hint and "textDocument/inlayHint" or false,
 }
@@ -98,15 +91,7 @@ M.n["<leader>lG"] =
   { function() vim.lsp.buf.workspace_symbol() end, desc = "Search workspace symbols", cond = "workspace/symbol" }
 
 M.n["<leader>uY"] = {
-  function()
-    vim.b.semantic_tokens_enabled = not vim.b.semantic_tokens_enabled
-    for _, client in ipairs((vim.lsp.get_clients or vim.lsp.get_active_clients)()) do
-      if client.server_capabilities.semanticTokensProvider then
-        vim.lsp.semantic_tokens[vim.b.semantic_tokens_enabled and "start" or "stop"](0, client.id)
-        vim.notify(("Buffer lsp semantic highlighting %s"):format(vim.b.semantic_tokens_enabled and "on" or "off"))
-      end
-    end
-  end,
+  function() require("astrolsp.toggles").buffer_semantic_tokens() end,
   desc = "Toggle LSP semantic highlight (buffer)",
   cond = "textDocument/semanticTokens/full",
 }

lua/astrolsp/init.lua

@@ -1,11 +1,14 @@
 local M = {}
 
-local utils = require "astrolsp.utils"
 local tbl_contains = vim.tbl_contains
 local tbl_isempty = vim.tbl_isempty
 
 M.lsp_progress = {}
 
+local function event(name)
+  vim.schedule(function() vim.api.nvim_exec_autocmds("User", { pattern = "AstroLsp" .. name, modeline = false }) end)
+end
+
 function M.setup(opts)
   opts = opts or {}
   for section, default in pairs(require "astrolsp.config") do
@@ -44,12 +47,18 @@ function M.setup(opts)
     if progress[id].kind == "end" then
       vim.defer_fn(function()
         progress[id] = nil
-        utils.event "Progress"
+        event "Progress"
       end, 100)
     end
-    utils.event "Progress"
+    event "Progress"
     orig_handler(_, msg, info)
   end
+
+  if M.options.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 })
+  end
 end
 
 M.diagnostics = { [0] = {}, {}, {}, {} }
@@ -73,7 +82,7 @@ function M.setup_diagnostics()
     M.options.diagnostics,
   }
 
-  vim.diagnostic.config(M.diagnostics[vim.g.diagnostics_mode])
+  vim.diagnostic.config(M.diagnostics[M.options.features.diagnostics_mode])
 end
 
 --- Helper function to set up a given server with the Neovim LSP client
@@ -109,6 +118,18 @@ local function add_buffer_autocmd(augroup, bufnr, autocmds)
   end
 end
 
+local function del_buffer_autocmd(augroup, bufnr)
+  local cmds_found, cmds = pcall(vim.api.nvim_get_autocmds, { group = augroup, buffer = bufnr })
+  if cmds_found then vim.tbl_map(function(cmd) vim.api.nvim_del_autocmd(cmd.id) end, cmds) end
+end
+
+local function has_capability(capability, filter)
+  for _, client in ipairs((vim.lsp.get_clients or vim.lsp.get_active_clients)(filter)) do
+    if client.supports_method(capability) then return true end
+  end
+  return false
+end
+
 --- The `on_attach` function used by AstroNvim
 ---@param client table The LSP client details when attaching
 ---@param bufnr number The buffer that the LSP client is attaching to
@@ -118,14 +139,14 @@ M.on_attach = function(client, bufnr)
       events = { "InsertLeave", "BufEnter" },
       desc = "Refresh codelens",
       callback = function()
-        if not utils.has_capability("textDocument/codeLens", { bufnr = bufnr }) then
-          utils.del_buffer_autocmd("lsp_codelens_refresh", bufnr)
+        if not has_capability("textDocument/codeLens", { bufnr = bufnr }) then
+          del_buffer_autocmd("lsp_codelens_refresh", bufnr)
           return
         end
-        if vim.g.codelens_enabled then vim.lsp.codelens.refresh() end
+        if M.options.features.codelens then vim.lsp.codelens.refresh() end
       end,
     })
-    if vim.g.codelens_enabled then vim.lsp.codelens.refresh() end
+    if M.options.features.codelens then vim.lsp.codelens.refresh() end
   end
 
   if
@@ -148,8 +169,8 @@ M.on_attach = function(client, bufnr)
       events = "BufWritePre",
       desc = "autoformat on save",
       callback = function()
-        if not utils.has_capability("textDocument/formatting", { bufnr = bufnr }) then
-          utils.del_buffer_autocmd("lsp_auto_format", bufnr)
+        if not has_capability("textDocument/formatting", { bufnr = bufnr }) then
+          del_buffer_autocmd("lsp_auto_format", bufnr)
           return
         end
         local autoformat_enabled = vim.b[bufnr].autoformat_enabled
@@ -167,8 +188,8 @@ M.on_attach = function(client, bufnr)
         events = { "CursorHold", "CursorHoldI" },
         desc = "highlight references when cursor holds",
         callback = function()
-          if not utils.has_capability("textDocument/documentHighlight", { bufnr = bufnr }) then
-            utils.del_buffer_autocmd("lsp_document_highlight", bufnr)
+          if not has_capability("textDocument/documentHighlight", { bufnr = bufnr }) then
+            del_buffer_autocmd("lsp_document_highlight", bufnr)
             return
           end
           vim.lsp.buf.document_highlight()
@@ -183,16 +204,14 @@ M.on_attach = function(client, bufnr)
   end
 
   if client.supports_method "textDocument/inlayHint" then
-    if vim.b[bufnr].inlay_hints_enabled == nil then vim.b[bufnr].inlay_hints_enabled = vim.g.inlay_hints_enabled end
+    if vim.b[bufnr].inlay_hints == nil then vim.b[bufnr].inlay_hints = M.options.features.inlay_hints end
     -- TODO: remove check after dropping support for Neovim v0.9
-    if vim.lsp.inlay_hint and vim.b[bufnr].inlay_hints_enabled then vim.lsp.inlay_hint(bufnr, true) end
+    if vim.lsp.inlay_hint and vim.b[bufnr].inlay_hints then vim.lsp.inlay_hint(bufnr, true) end
   end
 
   if client.supports_method and vim.lsp.semantic_tokens then
-    if vim.b[bufnr].semantic_tokens_enabled == nil then
-      vim.b[bufnr].semantic_tokens_enabled = vim.g.semantic_tokens_enabled
-    end
-    if not vim.g.semantic_tokens_enabled then vim.lsp.semantic_tokens["stop"](bufnr, client.id) end
+    if vim.b[bufnr].semantic_tokens == nil then vim.b[bufnr].semantic_tokens = M.options.features.semantic_tokens end
+    if not vim.b[bufnr].semantic_tokens then vim.lsp.semantic_tokens["stop"](bufnr, client.id) end
   end
 
   for mode, maps in pairs(M.options.mappings) do
@@ -229,15 +248,15 @@ function M.config(server_name)
   local opts = vim.tbl_deep_extend(
     "force",
     vim.tbl_deep_extend("force", server.document_config.default_config, server),
-    { capabilities = M.capabilities, flags = M.flags }
+    { capabilities = M.options.capabilities, flags = M.options.flags }
   )
   -- HACK: add astronvim interoperability, remove after AstroNvim v4
   if type(astronvim) == "table" and type(astronvim.user_opts) == "function" then
     opts = astronvim.user_opts("lsp.config." .. server_name, opts)
   end
-  if M.options.config[server_name] then
-    opts = assert(vim.tbl_deep_extend("force", opts, M.options.config[server_name]))
-  end
+  if M.options.config[server_name] then opts = vim.tbl_deep_extend("force", opts, M.options.config[server_name]) end
+  assert(opts)
+
   local old_on_attach = require("lspconfig")[server_name].on_attach
   local user_on_attach = opts.on_attach
   opts.on_attach = function(client, bufnr)

lua/astrolsp/toggles.lua

@@ -0,0 +1,72 @@
+local M = {}
+
+local options = require("astrolsp").options
+local features = options.features
+
+local notify = vim.notify
+local function bool2str(bool) return bool and "on" or "off" end
+
+--- Toggle auto format
+function M.autoformat()
+  features.autoformat = not features.autoformat
+  vim.notify(string.format("Global autoformatting %s", bool2str(features.autoformat)))
+end
+
+--- Toggle buffer local auto format
+---@param bufnr? number The buffer to toggle the autoformatting of, default the current buffer
+function M.buffer_autoformat(bufnr)
+  bufnr = bufnr or 0
+  local old_val = vim.b[bufnr].autoformat
+  if old_val == nil then old_val = features.autoformat end
+  vim.b[bufnr].autoformat = not old_val
+  notify(string.format("Buffer autoformatting %s", bool2str(vim.b[bufnr].autoformat)))
+end
+
+--- Toggle buffer LSP inlay hints
+---@param bufnr? number the buffer to toggle the clients on
+function M.buffer_inlay_hints(bufnr)
+  bufnr = bufnr or 0
+  vim.b[bufnr].inlay_hints = not vim.b[bufnr].inlay_hints
+  -- TODO: remove check after dropping support for Neovim v0.9
+  if vim.lsp.inlay_hint then
+    vim.lsp.inlay_hint(bufnr, vim.b[bufnr].inlay_hints)
+    notify(string.format("Inlay hints %s", bool2str(vim.b[bufnr].inlay_hints)))
+  end
+end
+
+--- Toggle buffer semantic token highlighting for all language servers that support it
+---@param bufnr? number the buffer to toggle the clients on
+function M.buffer_semantic_tokens(bufnr)
+  bufnr = bufnr or 0
+  vim.b[bufnr].semantic_tokens = not vim.b[bufnr].semantic_tokens
+  for _, client in ipairs((vim.lsp.get_clients or vim.lsp.get_active_clients)()) do
+    if client.server_capabilities.semanticTokensProvider then
+      vim.lsp.semantic_tokens[vim.b[bufnr].semantic_tokens and "start" or "stop"](bufnr, client.id)
+      notify(string.format("Buffer lsp semantic highlighting %s", bool2str(vim.b[bufnr].semantic_tokens)))
+    end
+  end
+end
+
+--- Toggle codelens
+function M.codelens()
+  features.codelens = not features.codelens
+  if not features.codelens then vim.lsp.codelens.clear() end
+  notify(string.format("CodeLens %s", bool2str(features.codelens)))
+end
+
+--- Toggle diagnostics
+function M.diagnostics()
+  features.diagnostics_mode = (features.diagnostics_mode - 1) % 4
+  vim.diagnostic.config(require("astrolsp").diagnostics[features.diagnostics_mode])
+  if features.diagnostics_mode == 0 then
+    notify "diagnostics off"
+  elseif features.diagnostics_mode == 1 then
+    notify "only status diagnostics"
+  elseif features.diagnostics_mode == 2 then
+    notify "virtual text off"
+  else
+    notify "all diagnostics on"
+  end
+end
+
+return M