feat(mason)!: migrate to v2.x (#1502)

* feat(mason)!: migrate to v2.x

Just wrapped up going thru all the changes in mason 2.x (and nvim 0.11 too)!
This should be a follow up to #1466 and (hopefully) fix all the issues related
to the updated LSP API (like servers not spawning and other weirdness) and works
together w #1496.

Acc the main issue was that some mason package names don't match their names in
lspconfig, so just using `lsp_deps` directly works for most, but breaks a bunch
of others (tldr: that mismatch is what was causing all the edge cases and broken
behavior).

I also went ahead and enabled `automatic_installation` because why not lol means
we don't have to manually call `vim.lsp.enable()` for everything, which might
save a tiny bit of perf too.

Didn't test this super thoroughly yet so pls lmk if anything's still broken!

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

* fixup! feat(mason)!: migrate to v2.x

* fixup! feat(mason)!: migrate to v2.x

* fixup! feat(mason)!: migrate to v2.x

* fix: LSP start logic (#1496)

* Revert "fix: remove manual `LspStart`, close #1478. (#1479)"

This reverts commit 7dab4b9.

* Revert "fixup(#1466): load lsp config with proper event. (#1472)"

This reverts commit 53eeeec.

* fix: LSP start logic

This should acc fix #1472 and #1479 cuz iirc the root cause was that lspconfig
changed how `LspStart` works. Now it only starts one _specific_ server (passed
via the first argument), instead of starting all matching servers automatically.
So we gotta manually start all the servers that match the current filetype
instead.

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

---------

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

* fix: unresolved nvim_lsp

* feat(lsp): unify language server setup

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

---------

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

Author: Jint-lzxy

lua/modules/configs/completion/lsp.lua

@@ -1,20 +1,21 @@
 return function()
-	local nvim_lsp = require("lspconfig")
 	require("completion.neoconf").setup()
 	require("completion.mason").setup()
 	require("completion.mason-lspconfig").setup()
 
 	local opts = {
 		capabilities = require("cmp_nvim_lsp").default_capabilities(vim.lsp.protocol.make_client_capabilities()),
 	}
-	-- Setup lsps that are not supported by `mason.nvim` but supported by `nvim-lspconfig` here.
+	-- 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)
-		nvim_lsp.dartls.setup(final_opts)
+		require("modules.utils").register_server("dartls", final_opts)
 	end
 
 	pcall(require, "user.configs.lsp")

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

@@ -1,11 +1,17 @@
 local M = {}
 
 M.setup = function()
+	local is_windows = require("core.global").is_windows
+
 	local lsp_deps = require("core.settings").lsp_deps
+	local mason_registry = require("mason-registry")
+	local mason_lspconfig = require("mason-lspconfig")
 
 	require("lspconfig.ui.windows").default_options.border = "rounded"
 	require("modules.utils").load_plugin("mason-lspconfig", {
 		ensure_installed = lsp_deps,
+		-- Skip auto enable because we are loading language servers lazily
+		automatic_enable = false,
 	})
 
 	vim.diagnostic.config({
@@ -51,16 +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)
-			vim.lsp.enable(lsp_name)
+			require("modules.utils").register_server(lsp_name, opts)
 		elseif type(custom_handler) == "function" then
-			--- Case where language server requires its own setup
-			--- Make sure to call require("lspconfig")[lsp_name].setup() in the function
-			--- See `clangd.lua` for example.
+			-- 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",
@@ -69,7 +75,6 @@ please REMOVE your LSP configuration (rust_analyzer.lua) from the `servers` dire
 					custom_handler
 				)
 			)
-			vim.lsp.enable(lsp_name)
 		else
 			vim.notify(
 				string.format(
@@ -83,9 +88,98 @@ please REMOVE your LSP configuration (rust_analyzer.lua) from the `servers` dire
 		end
 	end
 
-	for _, lsp in ipairs(lsp_deps) do
-		mason_lsp_handler(lsp)
+	---A simplified mimic of <mason-lspconfig 1.x>'s `setup_handlers` callback.
+	---Invoked for each Mason package (name or `Package` object) to configure its language server.
+	---@param pkg string|{name: string} Either the package name (string) or a Package object
+	local function setup_lsp_for_package(pkg)
+		-- First try to grab the builtin mappings
+		local mappings = mason_lspconfig.get_mappings().package_to_lspconfig
+		-- If empty or nil, build it by hand
+		if not mappings or vim.tbl_isempty(mappings) then
+			mappings = {}
+			for _, spec in ipairs(mason_registry.get_all_package_specs()) do
+				local lspconfig = vim.tbl_get(spec, "neovim", "lspconfig")
+				if lspconfig then
+					mappings[spec.name] = lspconfig
+				end
+			end
+		end
+
+		-- Figure out the package name and lookup
+		local name = type(pkg) == "string" and pkg or pkg.name
+		local srv = mappings[name]
+		if not srv then
+			return
+		end
+
+		-- Invoke the handler
+		mason_lsp_handler(srv)
+	end
+
+	for _, pkg in ipairs(mason_registry.get_installed_package_names()) do
+		setup_lsp_for_package(pkg)
 	end
+
+	-- Hook into Mason's package install event to install extra plugins for pylsp (black, ruff, rope),
+	-- then configure the installed package's LSP using setup_lsp_for_package.
+	mason_registry:on(
+		"package:install:success",
+		vim.schedule_wrap(function(pkg)
+			if pkg.name == "python-lsp-server" then
+				local venv = vim.fn.stdpath("data") .. "/mason/packages/python-lsp-server/venv"
+				local python = is_windows and venv .. "/Scripts/python.exe" or venv .. "/bin/python"
+				local black = is_windows and venv .. "/Scripts/black.exe" or venv .. "/bin/black"
+				local ruff = is_windows and venv .. "/Scripts/ruff.exe" or venv .. "/bin/ruff"
+
+				require("plenary.job")
+					:new({
+						command = python,
+						args = {
+							"-m",
+							"pip",
+							"install",
+							"-U",
+							"--disable-pip-version-check",
+							"python-lsp-black",
+							"python-lsp-ruff",
+							"pylsp-rope",
+						},
+						cwd = venv,
+						env = { VIRTUAL_ENV = venv },
+						on_exit = function()
+							if vim.fn.executable(black) == 1 and vim.fn.executable(ruff) == 1 then
+								vim.notify(
+									"Finished installing pylsp plugins",
+									vim.log.levels.INFO,
+									{ title = "[lsp] Install Status" }
+								)
+							else
+								vim.notify(
+									"Failed to install pylsp plugins. [Executable not found]",
+									vim.log.levels.ERROR,
+									{ title = "[lsp] Install Failure" }
+								)
+							end
+						end,
+						on_start = function()
+							vim.notify(
+								"Now installing pylsp plugins...",
+								vim.log.levels.INFO,
+								{ title = "[lsp] Install Status", timeout = 6000 }
+							)
+						end,
+						on_stderr = function(_, msg_stream)
+							if msg_stream then
+								vim.notify(msg_stream, vim.log.levels.ERROR, { title = "[lsp] Install Failure" })
+							end
+						end,
+					})
+					:start()
+			end
+
+			setup_lsp_for_package(pkg)
+		end)
+	)
 end
 
 return M

lua/modules/configs/completion/mason.lua

@@ -1,11 +1,6 @@
 local M = {}
 
 M.setup = function()
-	local is_windows = require("core.global").is_windows
-
-	local mason_registry = require("mason-registry")
-	require("lspconfig.ui.windows").default_options.border = "rounded"
-
 	local icons = {
 		ui = require("modules.utils.icons").get("ui", true),
 		misc = require("modules.utils.icons").get("misc", true),
@@ -31,66 +26,6 @@ M.setup = function()
 			},
 		},
 	})
-
-	-- Additional plugins for pylsp
-	mason_registry:on(
-		"package:install:success",
-		vim.schedule_wrap(function(pkg)
-			if pkg.name ~= "python-lsp-server" then
-				return
-			end
-
-			local venv = vim.fn.stdpath("data") .. "/mason/packages/python-lsp-server/venv"
-			local python = is_windows and venv .. "/Scripts/python.exe" or venv .. "/bin/python"
-			local black = is_windows and venv .. "/Scripts/black.exe" or venv .. "/bin/black"
-			local ruff = is_windows and venv .. "/Scripts/ruff.exe" or venv .. "/bin/ruff"
-
-			require("plenary.job")
-				:new({
-					command = python,
-					args = {
-						"-m",
-						"pip",
-						"install",
-						"-U",
-						"--disable-pip-version-check",
-						"python-lsp-black",
-						"python-lsp-ruff",
-						"pylsp-rope",
-					},
-					cwd = venv,
-					env = { VIRTUAL_ENV = venv },
-					on_exit = function()
-						if vim.fn.executable(black) == 1 and vim.fn.executable(ruff) == 1 then
-							vim.notify(
-								"Finished installing pylsp plugins",
-								vim.log.levels.INFO,
-								{ title = "[lsp] Install Status" }
-							)
-						else
-							vim.notify(
-								"Failed to install pylsp plugins. [Executable not found]",
-								vim.log.levels.ERROR,
-								{ title = "[lsp] Install Failure" }
-							)
-						end
-					end,
-					on_start = function()
-						vim.notify(
-							"Now installing pylsp plugins...",
-							vim.log.levels.INFO,
-							{ title = "[lsp] Install Status", timeout = 6000 }
-						)
-					end,
-					on_stderr = function(_, msg_stream)
-						if msg_stream then
-							vim.notify(msg_stream, vim.log.levels.ERROR, { title = "[lsp] Install Failure" })
-						end
-					end,
-				})
-				:start()
-		end)
-	)
 end
 
 return M

lua/modules/configs/completion/servers/clangd.lua

@@ -35,7 +35,7 @@ end
 
 -- https://github.com/neovim/nvim-lspconfig/blob/master/lua/lspconfig/configs/clangd.lua
 return function(defaults)
-	require("lspconfig").clangd.setup({
+	vim.lsp.config("clangd", {
 		on_attach = defaults.on_attach,
 		capabilities = vim.tbl_deep_extend("keep", { offsetEncoding = { "utf-16", "utf-8" } }, defaults.capabilities),
 		single_file_support = true,

lua/modules/configs/tool/dap/clients/delve.lua

@@ -24,10 +24,7 @@ return function()
 
 	dap.adapters.go = {
 		type = "executable",
-		command = "node",
-		args = {
-			vim.fn.expand("$MASON") .. "/packages/go-debug-adapter" .. "/extension/dist/debugAdapter.js",
-		},
+		command = vim.fn.exepath("go-debug-adapter"), -- Find go-debug-adapter on $PATH
 	}
 	dap.configurations.go = {
 		{

lua/modules/configs/tool/dap/clients/python.lua

@@ -4,7 +4,7 @@ return function()
 	local dap = require("dap")
 	local utils = require("modules.utils.dap")
 	local is_windows = require("core.global").is_windows
-	local debugpy_root = vim.fn.expand("$MASON") .. "/packages/debugpy"
+	local debugpy_root = vim.fn.expand("$MASON/packages/debugpy")
 
 	dap.adapters.python = function(callback, config)
 		if config.request == "attach" then

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