Files
neovim/runtime/lua/vim/lsp/health.lua
Lewis Russell 3f1d09bc94 feat(lsp): add vim.lsp.config and vim.lsp.enable
Design goals/requirements:
- Default configuration of a server can be distributed across multiple sources.
  - And via RTP discovery.
- Default configuration can be specified for all servers.
- Configuration _can_ be project specific.

Solution:

- Two new API's:
  - `vim.lsp.config(name, cfg)`:
    - Used to define default configurations for servers of name.
    - Can be used like a table or called as a function.
    - Use `vim.lsp.confg('*', cfg)` to specify default config for all
      servers.
  - `vim.lsp.enable(name)`
    - Used to enable servers of name. Uses configuration defined
    via `vim.lsp.config()`.
2024-12-10 17:16:01 +00:00

224 lines
7.0 KiB
Lua

local M = {}
local report_info = vim.health.info
local report_warn = vim.health.warn
local function check_log()
local log = vim.lsp.log
local current_log_level = log.get_level()
local log_level_string = log.levels[current_log_level] ---@type string
report_info(string.format('LSP log level : %s', log_level_string))
if current_log_level < log.levels.WARN then
report_warn(
string.format(
'Log level %s will cause degraded performance and high disk usage',
log_level_string
)
)
end
local log_path = vim.lsp.get_log_path()
report_info(string.format('Log path: %s', log_path))
local log_file = vim.uv.fs_stat(log_path)
local log_size = log_file and log_file.size or 0
local report_fn = (log_size / 1000000 > 100 and report_warn or report_info)
report_fn(string.format('Log size: %d KB', log_size / 1000))
end
--- @param f function
--- @return string
local function func_tostring(f)
local info = debug.getinfo(f, 'S')
return ('<function %s:%s>'):format(info.source, info.linedefined)
end
local function check_active_clients()
vim.health.start('vim.lsp: Active Clients')
local clients = vim.lsp.get_clients()
if next(clients) then
for _, client in pairs(clients) do
local cmd ---@type string
local ccmd = client.config.cmd
if type(ccmd) == 'table' then
cmd = vim.inspect(ccmd)
elseif type(ccmd) == 'function' then
cmd = func_tostring(ccmd)
end
local dirs_info ---@type string
if client.workspace_folders and #client.workspace_folders > 1 then
local wfolders = {} --- @type string[]
for _, dir in ipairs(client.workspace_folders) do
wfolders[#wfolders + 1] = dir.name
end
dirs_info = ('- Workspace folders:\n %s'):format(table.concat(wfolders, '\n '))
else
dirs_info = string.format(
'- Root directory: %s',
client.root_dir and vim.fn.fnamemodify(client.root_dir, ':~')
) or nil
end
report_info(table.concat({
string.format('%s (id: %d)', client.name, client.id),
dirs_info,
string.format('- Command: %s', cmd),
string.format('- Settings: %s', vim.inspect(client.settings, { newline = '\n ' })),
string.format(
'- Attached buffers: %s',
vim.iter(pairs(client.attached_buffers)):map(tostring):join(', ')
),
}, '\n'))
end
else
report_info('No active clients')
end
end
local function check_watcher()
vim.health.start('vim.lsp: File Watcher')
-- Only run the check if file watching has been enabled by a client.
local clients = vim.lsp.get_clients()
if
--- @param client vim.lsp.Client
vim.iter(clients):all(function(client)
local has_capability = vim.tbl_get(
client.capabilities,
'workspace',
'didChangeWatchedFiles',
'dynamicRegistration'
)
local has_dynamic_capability =
client.dynamic_capabilities:get(vim.lsp.protocol.Methods.workspace_didChangeWatchedFiles)
return has_capability == nil
or has_dynamic_capability == nil
or client.workspace_folders == nil
end)
then
report_info('file watching "(workspace/didChangeWatchedFiles)" disabled on all clients')
return
end
local watchfunc = vim.lsp._watchfiles._watchfunc
assert(watchfunc)
local watchfunc_name --- @type string
if watchfunc == vim._watch.watch then
watchfunc_name = 'libuv-watch'
elseif watchfunc == vim._watch.watchdirs then
watchfunc_name = 'libuv-watchdirs'
elseif watchfunc == vim._watch.inotifywait then
watchfunc_name = 'inotifywait'
else
local nm = debug.getinfo(watchfunc, 'S').source
watchfunc_name = string.format('Custom (%s)', nm)
end
report_info('File watch backend: ' .. watchfunc_name)
if watchfunc_name == 'libuv-watchdirs' then
report_warn('libuv-watchdirs has known performance issues. Consider installing inotify-tools.')
end
end
local function check_position_encodings()
vim.health.start('vim.lsp: Position Encodings')
local clients = vim.lsp.get_clients()
if next(clients) then
local position_encodings = {} ---@type table<integer, table<string, integer[]>>
for _, client in pairs(clients) do
for bufnr in pairs(client.attached_buffers) do
if not position_encodings[bufnr] then
position_encodings[bufnr] = {}
end
if not position_encodings[bufnr][client.offset_encoding] then
position_encodings[bufnr][client.offset_encoding] = {}
end
table.insert(position_encodings[bufnr][client.offset_encoding], client.id)
end
end
-- Check if any buffers are attached to multiple clients with different position encodings
local buffers = {} ---@type integer[]
for bufnr, encodings in pairs(position_encodings) do
local list = {} ---@type string[]
for k in pairs(encodings) do
list[#list + 1] = k
end
if #list > 1 then
buffers[#buffers + 1] = bufnr
end
end
if #buffers > 0 then
local lines =
{ 'Found buffers attached to multiple clients with different position encodings.' }
for _, bufnr in ipairs(buffers) do
local encodings = position_encodings[bufnr]
local parts = {}
for encoding, client_ids in pairs(encodings) do
table.insert(
parts,
string.format('%s (client id(s): %s)', encoding:upper(), table.concat(client_ids, ', '))
)
end
table.insert(lines, string.format('- Buffer %d: %s', bufnr, table.concat(parts, ', ')))
end
report_warn(
table.concat(lines, '\n'),
'Use the positionEncodings client capability to ensure all clients use the same position encoding'
)
else
report_info('No buffers contain mixed position encodings')
end
else
report_info('No active clients')
end
end
local function check_enabled_configs()
vim.health.start('vim.lsp: Enabled Configurations')
for name in vim.spairs(vim.lsp._enabled_configs) do
local config = vim.lsp._resolve_config(name)
local text = {} --- @type string[]
text[#text + 1] = ('%s:'):format(name)
for k, v in
vim.spairs(config --[[@as table<string,any>]])
do
local v_str --- @type string?
if k == 'name' then
v_str = nil
elseif k == 'filetypes' or k == 'root_markers' then
v_str = table.concat(v, ', ')
elseif type(v) == 'function' then
v_str = func_tostring(v)
else
v_str = vim.inspect(v, { newline = '\n ' })
end
if k == 'cmd' and type(v) == 'table' and vim.fn.executable(v[1]) == 0 then
report_warn(("'%s' is not executable. Configuration will not be used."):format(v[1]))
end
if v_str then
text[#text + 1] = ('- %s: %s'):format(k, v_str)
end
end
text[#text + 1] = ''
report_info(table.concat(text, '\n'))
end
end
--- Performs a healthcheck for LSP
function M.check()
check_log()
check_active_clients()
check_enabled_configs()
check_watcher()
check_position_encodings()
end
return M