feat(lsp): unify language server setup

Signed-off-by: Jint-lzxy <[email protected]>

Author: Jint-lzxy

lua/modules/configs/completion/lsp.lua

@@ -6,25 +6,20 @@ return function()
 	local opts = {
 		capabilities = require("cmp_nvim_lsp").default_capabilities(vim.lsp.protocol.make_client_capabilities()),
 	}
-	-- Configure LSPs that are not supported by `mason.nvim` but are available in `nvim-lspconfig` here.
-	-- Call |vim.lsp.config()| FOLLOWED BY |vim.lsp.enable()| to ensure the server starts automatically.
+	-- Configure LSPs that are not supported by `mason.nvim` but are available in `nvim-lspconfig`.
+	-- First call |vim.lsp.config()|, then |vim.lsp.enable()| (or use `register_server`, see below)
+	-- to ensure the language server is properly configured and starts automatically.
 	if vim.fn.executable("dart") == 1 then
 		local ok, _opts = pcall(require, "user.configs.lsp-servers.dartls")
 		if not ok then
 			_opts = require("completion.servers.dartls")
 		end
 		local final_opts = vim.tbl_deep_extend("keep", _opts, opts)
-		vim.lsp.config("dartls", final_opts)
-		vim.lsp.enable("dartls")
+		require("modules.utils").register_server("dartls", final_opts)
 	end
 
 	pcall(require, "user.configs.lsp")
 
 	-- Start LSPs
-	pcall(function()
-		local matching_configs = require("lspconfig").util.get_config_by_ft(vim.bo.filetype)
-		for _, config in ipairs(matching_configs) do
-			config.launch()
-		end
-	end)
+	pcall(vim.cmd.LspStart)
 end

lua/modules/configs/completion/mason-lspconfig.lua

@@ -10,7 +10,8 @@ M.setup = function()
 	require("lspconfig.ui.windows").default_options.border = "rounded"
 	require("modules.utils").load_plugin("mason-lspconfig", {
 		ensure_installed = lsp_deps,
-		automatic_enable = true,
+		-- Skip auto enable because we are loading language servers lazily
+		automatic_enable = false,
 	})
 
 	vim.diagnostic.config({
@@ -56,15 +57,16 @@ please REMOVE your LSP configuration (rust_analyzer.lua) from the `servers` dire
 
 		if not ok then
 			-- Default to use factory config for server(s) that doesn't include a spec
-			vim.lsp.config(lsp_name, opts)
+			require("modules.utils").register_server(lsp_name, opts)
 		elseif type(custom_handler) == "function" then
 			-- Case where language server requires its own setup
 			-- Be sure to call `vim.lsp.config()` within the setup function.
 			-- Refer to |vim.lsp.config()| for documentation.
 			-- For an example, see `clangd.lua`.
 			custom_handler(opts)
+			vim.lsp.enable(lsp_name)
 		elseif type(custom_handler) == "table" then
-			vim.lsp.config(
+			require("modules.utils").register_server(
 				lsp_name,
 				vim.tbl_deep_extend(
 					"force",
@@ -84,7 +86,6 @@ please REMOVE your LSP configuration (rust_analyzer.lua) from the `servers` dire
 				{ title = "nvim-lspconfig" }
 			)
 		end
-		return
 	end
 
 	---A simplified mimic of <mason-lspconfig 1.x>'s `setup_handlers` callback.

lua/modules/utils/init.lua

@@ -263,6 +263,19 @@ function M.gen_cursorword_hl()
 	set_global_hl("MiniCursorwordCurrent", nil)
 end
 
+---Setup and enable a language server in one call.
+---@param server string @Name of the language server
+---@param config? vim.lsp.Config @Optional config to apply
+function M.register_server(server, config)
+	vim.validate("server", server, "string", false)
+	vim.validate("config", config, "table", true)
+
+	if config then
+		vim.lsp.config(server, config)
+	end
+	vim.lsp.enable(server)
+end
+
 ---Convert number (0/1) to boolean
 ---@param value number @The value to check
 ---@return boolean|nil @Returns nil if failed