warg/nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(lsp): refactor

Browse Source 
* Move configs into config subdirectory
 * Move LSP logic into classes
 * Make it possible to define mason package in lsp config,
   including nested dependency resolution and post install
   steps
 * replace jedi_language_server with pylsp
This commit is contained in:
Oscar Wallberg
2024-04-14 15:41:39 +02:00
parent 06898a5a31
commit 2bc21b248c
17 changed files with 671 additions and 376 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lua/lsp/bashls.lua → lua/lsp/config/bashls.lua
+3 -2
View File
@@ -2,11 +2,12 @@ return {
enable = true,
dependencies = {
"npm",
"shellcheck",
},
mason = {
name = "bash-language-server",
-- version = "",
dependencies = {
{ name = "shellcheck", },
},
},
lspconfig = {
filetypes = {
lua/lsp/clangd.lua → lua/lsp/config/clangd.lua
View File
lua/lsp/cmake.lua → lua/lsp/config/cmake.lua
View File
lua/lsp/diagnosticls.lua → lua/lsp/config/diagnosticls.lua
+7 -4
View File
@@ -10,12 +10,14 @@ return {
"npm",
},
mason = {
-- TODO: figure out if possible to install required formatters/linters
-- in this language server automatically through mason
name = "diagnostic-languageserver",
-- version = "",
},
lspconfig = {
filetypes = {
"python",
-- "python",
"sh",
"bash",
"zsh",
@@ -25,7 +27,7 @@ return {
single_file_support = true,
init_options = {
filetypes = {
python = "flake8",
-- python = "flake8",
php = "phpcs",
},
linters = {
@@ -112,7 +114,7 @@ return {
},
},
formatFiletypes = {
python = { "black", "isort", },
-- python = { "black", "isort", },
sh = { "shfmt", },
bash = { "shfmt", },
zsh = { "shfmt", },
@@ -137,7 +139,8 @@ return {
"--stdin-filename",
"%filename",
"--quiet",
"-",
"-code",
"%text",
},
rootPatterns = { "Pipfile", ".git", "tox.ini", },
isStdout = true,
lua/lsp/gopls.lua → lua/lsp/config/gopls.lua
View File
lua/lsp/groovyls.lua → lua/lsp/config/groovyls.lua
View File
lua/lsp/config/hls.lua
+18
View File
@@ -0,0 +1,18 @@
return {
enable = true,
mason = {
name = "haskell-language-server",
-- version = "",
},
lspconfig = {
filetypes = { "haskell", "lhaskell", "cabal", },
cmd = { "haskell-language-server-wrapper", "--lsp", },
single_file_support = true,
settings = {
haskell = {
cabalFormattingProvider = "cabalfmt",
formattingProvider = "ormolu",
},
},
},
}
lua/lsp/intelephense.lua → lua/lsp/config/intelephense.lua
View File
lua/lsp/jedi_language_server.lua → lua/lsp/config/jedi_language_server.lua
+1 -1
View File
@@ -1,5 +1,5 @@
return {
enable = true,
enable = false,
dependencies = {
"python3",
},
lua/lsp/lemminx.lua → lua/lsp/config/lemminx.lua
View File
lua/lsp/lua_ls.lua → lua/lsp/config/lua_ls.lua
+1
View File
@@ -1,5 +1,6 @@
-- spec: https://luals.github.io/wiki/settings/
---@type ServerConfig
return {
enable = true,
mason = {
lua/lsp/config/pylsp.lua
+85
View File
@@ -0,0 +1,85 @@
--- @type ServerConfig
return {
enable = true,
dependencies = {
"python3",
},
py_module_deps = {
"venv",
},
mason = {
name = "python-lsp-server",
post_install = {
{
command = "./venv/bin/pip",
args = {
"install",
"python-lsp-black",
"python-lsp-isort",
},
},
-- {
-- command = "./venv/bin/pip",
-- args = { "alsdkfjhaklsdfjhl", },
-- },
},
},
lspconfig = {
filetypes = {
"python",
},
cmd = { "pylsp", },
single_file_support = true,
settings = {
pylsp = {
configurationSources = { "flake8", },
plugins = {
autopep8 = {
enabled = false,
},
black = {
enabled = true,
line_length = 100,
},
flake8 = {
enabled = true,
exclude = { ".venv", "build/", },
filename = { "*.py", },
-- B - flake8-bugbear https://github.com/PyCQA/flake8-bugbear
-- C - only one violation, C901. mccabe https://github.com/PyCQA/mccabe
-- D - flake8-docstrings (pydocstyle) http://www.pydocstyle.org/en/stable/error_codes.html
-- E - pycodestyle https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes
-- F - flake8 https://flake8.pycqa.org/en/latest/user/error-codes.html
-- W - pycodestyle https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes
select = {
"B", "B902", "B903", "B904", "C", "E", "E999", "E501", "F", "W",
},
ignore = {
"B950", "D201", "D203", "D205", "D301", "D400", "E133", "E203", "W503",
},
max_line_length = 100,
max_doc_length = 100,
},
isort = {
enabled = true,
},
mccabe = {
enabled = false,
},
pycodestyle = {
enabled = false,
},
pydocstyle = {
enabled = false,
},
pyflakes = {
enabled = false,
},
yapf = {
enabled = false,
},
},
},
},
},
}
lua/lsp/rust_analyzer.lua → lua/lsp/config/rust_analyzer.lua
View File
lua/lsp/zls.lua → lua/lsp/config/zls.lua
View File
lua/lsp/package.lua
+171
View File
@@ -0,0 +1,171 @@
local module_name = "lsp.package"
local utils = require("utils")
---@class PostInstallStep
---@field command string
---@field args string[]
---@class MasonPackageConfig
---@field name string?
---@field version string?
---@field dependencies MasonPackageConfig[]?
---@field post_install PostInstallStep[]?
local M = {}
M.__index = M
--- Run post installation steps
---@param pkg Package
function M:run_post_install(pkg)
if self.post_install then
for _, step in ipairs(self.post_install) do
local job = require("plenary.job"):new({
command = step.command,
args = step.args,
cwd = pkg:get_install_path(),
enabled_recording = true,
on_exit = function (job, code, signal)
if code ~= 0 or signal ~= 0 then
local cmd = step.command
if step.args then
cmd = cmd .. " " .. table.concat(step.args, " ")
end
utils.err(
("Post installation step for %s:\n`%s`\nfailed with:\n%s"):format(
self.name,
cmd,
table.concat(job:stderr_result(), "\n")
),
module_name
)
end
end,
})
job:start()
end
end
end
--- Perform installation
---@param on_done fun(success: boolean)?
function M:mason_install(on_done)
local registry = require("mason-registry")
local ok, pkg = pcall(registry.get_package, self.name)
if not ok then
utils.err("Could not locate package " .. self.name, module_name)
if on_done then
on_done(false)
end
return
end
if pkg:is_installed() then
if on_done then
on_done(true)
end
return
end
utils.info(("Installing %s"):format(self.name), module_name)
local handle = pkg:install({ version = self.version, })
local err
handle:on("stderr", vim.schedule_wrap(function (msg)
err = (err or "") .. msg
end))
handle:once("closed", vim.schedule_wrap(function ()
local is_installed = pkg:is_installed()
if is_installed then
self:run_post_install(pkg)
utils.info(("Successfully installed %s"):format(self.name), module_name)
else
if err then
err = ":\n" .. err
else
err = ""
end
utils.err(
("Failed to install %s%s"):format(self.name, err),
module_name
)
end
if on_done then
on_done(is_installed)
end
end))
end
--- Install package dependencies
---@param on_done fun(success: boolean)?
function M:install_dependencies(on_done)
if not self.dependencies or #self.dependencies == 0 then
if on_done then
on_done(true)
end
return
end
local total = #self.dependencies
local completed = 0
local all_successful = true
--- Handle install result
---@param success boolean
local function handle_result(success)
completed = completed + 1
if not success then
all_successful = false
end
if completed == total and on_done then
on_done(all_successful)
end
end
for _, dep in ipairs(self.dependencies) do
dep:install(handle_result)
end
end
--- Install package and any defined dependencies
---@param on_done fun(success: boolean)?
function M:install(on_done)
--- Handle install result
---@param success boolean
local function handle_result(success)
if success then
self:mason_install(on_done)
elseif on_done then
on_done(success)
end
end
self:install_dependencies(handle_result)
end
--- Create a new instance
---@param config MasonPackageConfig
---@return MasonPackageConfig
function M:new(config)
config = config or {}
if config.dependencies then
for i, dep in ipairs(config.dependencies) do
config.dependencies[i] = M:new(dep)
end
end
setmetatable(config, self)
return config
end
return M
lua/lsp/server.lua
+367
View File
@@ -0,0 +1,367 @@
local module_name = "lsp.server"
local utils = require("utils")
---@class MasonPackageConfig
local Package = require("lsp.package")
-- override type, seems to be incorrect in either lspconfig or vim.lsp
---@class lspconfig.Config
---@field root_dir function
---@class ServerConfig
---@field name string?
---@field enable boolean?
---@field dependencies string[]
---@field py_module_deps string[]
---@field mason MasonPackageConfig?
---@field root_patterns string[]?
---@field lspconfig lspconfig.Config
local M = {}
M.__index = M
--- Reload all buffers attached by a server
function M:reload_buffers()
local ft_map = {}
for _, ft in ipairs(self.lspconfig.filetypes) do
ft_map[ft] = true
end
for _, bufnr in ipairs(vim.api.nvim_list_bufs()) do
if vim.api.nvim_buf_is_loaded(bufnr) then
local buf_ft = vim.api.nvim_get_option_value("filetype", { buf = bufnr, })
if ft_map[buf_ft] then
vim.api.nvim_buf_call(bufnr, vim.cmd.edit)
end
end
end
end
--- Rename Code Action
function M.ca_rename()
local ts_utils = utils.try_require("nvim-treesitter.ts_utils", module_name)
if not ts_utils then
return
end
local identifier_types = { "IDENTIFIER", "identifier", "variable_name", "word", }
local node = ts_utils.get_node_at_cursor()
if not node or not utils.has_value(identifier_types, node:type()) then
utils.info("Only identifiers may be renamed", module_name)
return
end
vim.lsp.buf.document_highlight()
local old = vim.fn.expand("<cword>")
local buf = vim.api.nvim_create_buf(false, true)
local min_width = 10
local max_width = 50
local default_width = math.min(
max_width,
math.max(min_width, vim.str_utfindex(old) + 1)
)
local row, col, _, _ = node:range()
local win = vim.api.nvim_open_win(
buf,
true,
{
relative = "win",
anchor = "NW",
width = default_width,
height = 1,
bufpos = { row, col - 1, },
focusable = true,
zindex = 50,
style = "minimal",
border = "rounded",
title = "Rename",
title_pos = "center",
}
)
vim.api.nvim_buf_set_lines(buf, 0, -1, false, { old, })
vim.api.nvim_create_autocmd(
{ "TextChanged", "TextChangedI", "TextChangedP", }, {
buffer = buf,
callback = function ()
local win_width = vim.api.nvim_win_get_width(win)
local content = vim.api.nvim_buf_get_lines(buf, 0, -1, false)
if #content > 0 then
local cwidth = vim.str_utfindex(content[1] or "") + 1
local new_width = math.min(
max_width,
math.max(min_width, cwidth)
)
if new_width ~= win_width then
vim.api.nvim_win_set_width(win, new_width)
end
end
end,
})
vim.keymap.set(
{ "n", "i", "x", },
"<cr>",
function ()
local content = vim.api.nvim_buf_get_lines(buf, 0, -1, false)
vim.api.nvim_win_close(win, true)
vim.cmd.stopinsert()
if #content > 0 then
local new_name = content[1]
vim.lsp.buf.rename(new_name)
end
end,
{ buffer = buf, }
)
vim.keymap.set(
{ "n", "i", "x", },
"<C-c>",
function ()
vim.api.nvim_win_close(win, true)
vim.cmd.stopinsert()
end,
{ buffer = buf, }
)
vim.keymap.set(
{ "n", "x", },
"<esc>",
function ()
vim.api.nvim_win_close(win, true)
end,
{ buffer = buf, }
)
vim.keymap.set(
{ "n", "x", },
"q",
function ()
vim.api.nvim_win_close(win, true)
end,
{ buffer = buf, }
)
vim.api.nvim_feedkeys(
vim.api.nvim_replace_termcodes("^v$<C-g>", true, false, true),
"n",
true
)
end
--- Called when language server attaches
---@param client vim.lsp.Client
---@param bufnr integer
function M:on_attach(client, bufnr)
-- Mappings.
-- See `:help vim.lsp.*` for documentation on any of the below functions
local opts = { buffer = bufnr, }
vim.keymap.set("n", "<leader>df", vim.diagnostic.open_float, opts)
vim.keymap.set("n", "[d", vim.diagnostic.goto_prev, opts)
vim.keymap.set("n", "]d", vim.diagnostic.goto_next, opts)
vim.keymap.set("n", "gD", vim.lsp.buf.declaration, opts)
vim.keymap.set({ "n", "i", }, "<C-k>", vim.lsp.buf.hover, opts)
vim.keymap.set({ "n", "i", }, "<C-j>", vim.lsp.buf.signature_help, opts)
vim.keymap.set({ "n", "i", }, "<C-h>", vim.lsp.buf.document_highlight, opts)
vim.keymap.set("n", "<leader>lr", self.ca_rename, opts)
vim.keymap.set("n", "<leader>la", vim.lsp.buf.code_action, opts)
vim.keymap.set({ "n", "x", }, "<leader>lf", vim.lsp.buf.format, opts)
---@module "telescope.builtin"
local telescope = utils.try_require("telescope.builtin", module_name)
if telescope then
vim.keymap.set("n", "<leader>dl", telescope.diagnostics, opts)
vim.keymap.set("n", "<leader>lD", telescope.lsp_type_definitions, opts)
vim.keymap.set("n", "gd", telescope.lsp_definitions, opts)
vim.keymap.set("n", "gi", telescope.lsp_implementations, opts)
vim.keymap.set("n", "gr", telescope.lsp_references, opts)
else
vim.keymap.set("n", "<leader>dl", vim.diagnostic.setloclist, opts)
vim.keymap.set("n", "<leader>ld", vim.lsp.buf.type_definition, opts)
vim.keymap.set("n", "gd", vim.lsp.buf.definition, opts)
vim.keymap.set("n", "gi", vim.lsp.buf.implementation, opts)
vim.keymap.set("n", "gr", vim.lsp.buf.references, opts)
end
-- For document highlight
vim.cmd.highlight({ "link LspReferenceRead Visual", bang = true, })
vim.cmd.highlight({ "link LspReferenceText Visual", bang = true, })
vim.cmd.highlight({ "link LspReferenceWrite Visual", bang = true, })
-- vim.api.nvim_create_autocmd({ "CursorHold", "CursorHoldI", }, {
-- buffer = bufnr,
-- callback = vim.lsp.buf.document_highlight,
-- })
vim.api.nvim_create_autocmd({ "CursorMoved", "CursorMovedI", }, {
buffer = bufnr,
callback = vim.lsp.buf.clear_references,
})
-- Auto show signature on insert in function parameters
-- if client.server_capabilities.signatureHelpProvider then
-- local chars = client.server_capabilities.signatureHelpProvider
-- .triggerCharacters
-- if chars and #chars > 0 then
-- vim.api.nvim_create_autocmd("CursorHoldI", {
-- buffer = bufnr,
-- callback = vim.lsp.buf.signature_help,
-- })
-- end
-- end
vim.opt.updatetime = 300
require("lsp-inlayhints").on_attach(client, bufnr, false)
vim.lsp.handlers["textDocument/hover"] = vim.lsp.with(
vim.lsp.handlers.hover, { border = "single", }
)
vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with(
vim.lsp.handlers.signature_help, { border = "single", }
)
end
--- Configure the LSP client
function M:configure_client()
local ok, ret = pcall(require, "lspconfig")
if not ok then
utils.err("Missing required plugin lspconfig", module_name)
return
end
local lspconfig = ret
if self.root_patterns then
self.lspconfig.root_dir = lspconfig.util.root_pattern(unpack(self.root_patterns))
else
self.lspconfig.root_dir = lspconfig.util.find_git_ancestor
end
local capabilities = vim.lsp.protocol.make_client_capabilities()
utils.try_require("cmp_nvim_lsp", module_name, function (cmp_nvim_lsp)
capabilities = vim.tbl_deep_extend(
"force",
capabilities,
cmp_nvim_lsp.default_capabilities()
)
end)
self.lspconfig.capabilities = capabilities
self.lspconfig.on_attach = function (...)
ok, ret = pcall(self.on_attach, self, ...)
if not ok then
utils.err(
("Failed to load on_attach for %s:\n%s"):format(self.name, ret),
module_name
)
end
end
ok, ret = pcall(lspconfig[self.name].setup, self.lspconfig)
if not ok then
utils.err(
("Failed to setup LSP server %s with lspconfig: %s"):format(self.name, ret),
module_name
)
return
end
self:reload_buffers()
end
--- Check for and return missing dependencies
---@return table<string>
function M:get_missing_unmanaged_deps()
local missing_deps = {}
if self.dependencies ~= nil then
for _, dep in ipairs(self.dependencies) do
if not utils.is_installed(dep) then
table.insert(missing_deps, dep)
end
end
end
if self.py_module_deps ~= nil then
for _, mod in ipairs(self.py_module_deps) do
if not utils.python3_module_is_installed(mod) then
table.insert(missing_deps, "python3-" .. mod)
end
end
end
return missing_deps
end
--- Install LSP server
---@param on_done fun(success: boolean)?
function M:install(on_done)
--- Handle install result
---@param success boolean
local function handle_result(success)
if not success then
self.enable = false
end
if on_done then
on_done(success)
end
end
self.mason:install(handle_result)
end
--- Setup LSP server
function M:setup()
local missing_deps = self:get_missing_unmanaged_deps()
if #missing_deps > 0 then
utils.warn(
("Disabling %s because the following package(s) are not installed: %s")
:format(self.name, table.concat(missing_deps, ", ")),
module_name
)
self.enable = false
return
end
if self.mason then
self:install(function (success)
if success then
self:configure_client()
end
end)
else
if vim.fn.executable(self.lspconfig.cmd[1]) == 1 then
self:configure_client()
else
utils.warn(self.name .. " not installed, disabling", module_name)
self.enable = false
end
end
end
--- Register autocmd for setting up LSP server upon entering a buffer of related filetype
function M:register()
local augroup = vim.api.nvim_create_augroup("LSP-" .. self.name, {})
vim.api.nvim_create_autocmd("FileType", {
once = true,
pattern = table.concat(self.lspconfig.filetypes, ","),
callback = vim.schedule_wrap(function ()
self:setup()
vim.api.nvim_del_augroup_by_id(augroup)
end),
group = augroup,
})
end
--- Create a new instance
---@param config ServerConfig
---@return ServerConfig
function M:new(config)
config = config or {}
if config.mason then
config.mason = Package:new(config.mason)
end
setmetatable(config, self)
return config
end
return M