mirror of
https://github.com/neovim/neovim
synced 2025-07-16 01:01:49 +00:00
490 lines
14 KiB
Lua
490 lines
14 KiB
Lua
---@brief lsp-diagnostic
|
|
|
|
local util = require('vim.lsp.util')
|
|
local protocol = require('vim.lsp.protocol')
|
|
local log = require('vim.lsp.log')
|
|
local ms = protocol.Methods
|
|
|
|
local api = vim.api
|
|
|
|
local M = {}
|
|
|
|
local augroup = api.nvim_create_augroup('vim_lsp_diagnostic', {})
|
|
|
|
local DEFAULT_CLIENT_ID = -1
|
|
|
|
local function get_client_id(client_id)
|
|
if client_id == nil then
|
|
client_id = DEFAULT_CLIENT_ID
|
|
end
|
|
|
|
return client_id
|
|
end
|
|
|
|
---@param severity lsp.DiagnosticSeverity
|
|
local function severity_lsp_to_vim(severity)
|
|
if type(severity) == 'string' then
|
|
severity = protocol.DiagnosticSeverity[severity]
|
|
end
|
|
return severity
|
|
end
|
|
|
|
---@return lsp.DiagnosticSeverity
|
|
local function severity_vim_to_lsp(severity)
|
|
if type(severity) == 'string' then
|
|
severity = vim.diagnostic.severity[severity]
|
|
end
|
|
return severity
|
|
end
|
|
|
|
---@param lines string[]
|
|
---@param lnum integer
|
|
---@param col integer
|
|
---@param offset_encoding string
|
|
---@return integer
|
|
local function line_byte_from_position(lines, lnum, col, offset_encoding)
|
|
if not lines or offset_encoding == 'utf-8' then
|
|
return col
|
|
end
|
|
|
|
local line = lines[lnum + 1]
|
|
local ok, result = pcall(vim.str_byteindex, line, col, offset_encoding == 'utf-16')
|
|
if ok then
|
|
return result
|
|
end
|
|
|
|
return col
|
|
end
|
|
|
|
---@param bufnr integer
|
|
---@return string[]
|
|
local function get_buf_lines(bufnr)
|
|
if vim.api.nvim_buf_is_loaded(bufnr) then
|
|
return vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
|
|
end
|
|
|
|
local filename = vim.api.nvim_buf_get_name(bufnr)
|
|
local f = io.open(filename)
|
|
if not f then
|
|
return
|
|
end
|
|
|
|
local content = f:read('*a')
|
|
if not content then
|
|
-- Some LSP servers report diagnostics at a directory level, in which case
|
|
-- io.read() returns nil
|
|
f:close()
|
|
return
|
|
end
|
|
|
|
local lines = vim.split(content, '\n')
|
|
f:close()
|
|
return lines
|
|
end
|
|
|
|
--- @param diagnostic lsp.Diagnostic
|
|
--- @param client_id integer
|
|
--- @return table?
|
|
local function tags_lsp_to_vim(diagnostic, client_id)
|
|
local tags ---@type table?
|
|
for _, tag in ipairs(diagnostic.tags or {}) do
|
|
if tag == protocol.DiagnosticTag.Unnecessary then
|
|
tags = tags or {}
|
|
tags.unnecessary = true
|
|
elseif tag == protocol.DiagnosticTag.Deprecated then
|
|
tags = tags or {}
|
|
tags.deprecated = true
|
|
else
|
|
log.info(string.format('Unknown DiagnosticTag %d from LSP client %d', tag, client_id))
|
|
end
|
|
end
|
|
return tags
|
|
end
|
|
|
|
---@param diagnostics lsp.Diagnostic[]
|
|
---@param bufnr integer
|
|
---@param client_id integer
|
|
---@return Diagnostic[]
|
|
local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
|
|
local buf_lines = get_buf_lines(bufnr)
|
|
local client = vim.lsp.get_client_by_id(client_id)
|
|
local offset_encoding = client and client.offset_encoding or 'utf-16'
|
|
---@diagnostic disable-next-line:no-unknown
|
|
return vim.tbl_map(function(diagnostic)
|
|
---@cast diagnostic lsp.Diagnostic
|
|
local start = diagnostic.range.start
|
|
local _end = diagnostic.range['end']
|
|
return {
|
|
lnum = start.line,
|
|
col = line_byte_from_position(buf_lines, start.line, start.character, offset_encoding),
|
|
end_lnum = _end.line,
|
|
end_col = line_byte_from_position(buf_lines, _end.line, _end.character, offset_encoding),
|
|
severity = severity_lsp_to_vim(diagnostic.severity),
|
|
message = diagnostic.message,
|
|
source = diagnostic.source,
|
|
code = diagnostic.code,
|
|
_tags = tags_lsp_to_vim(diagnostic, client_id),
|
|
user_data = {
|
|
lsp = {
|
|
-- usage of user_data.lsp.code is deprecated in favor of the top-level code field
|
|
code = diagnostic.code,
|
|
codeDescription = diagnostic.codeDescription,
|
|
relatedInformation = diagnostic.relatedInformation,
|
|
data = diagnostic.data,
|
|
},
|
|
},
|
|
}
|
|
end, diagnostics)
|
|
end
|
|
|
|
--- @param diagnostics Diagnostic[]
|
|
--- @return lsp.Diagnostic[]
|
|
local function diagnostic_vim_to_lsp(diagnostics)
|
|
---@diagnostic disable-next-line:no-unknown
|
|
return vim.tbl_map(function(diagnostic)
|
|
---@cast diagnostic Diagnostic
|
|
return vim.tbl_extend('keep', {
|
|
-- "keep" the below fields over any duplicate fields in diagnostic.user_data.lsp
|
|
range = {
|
|
start = {
|
|
line = diagnostic.lnum,
|
|
character = diagnostic.col,
|
|
},
|
|
['end'] = {
|
|
line = diagnostic.end_lnum,
|
|
character = diagnostic.end_col,
|
|
},
|
|
},
|
|
severity = severity_vim_to_lsp(diagnostic.severity),
|
|
message = diagnostic.message,
|
|
source = diagnostic.source,
|
|
code = diagnostic.code,
|
|
}, diagnostic.user_data and (diagnostic.user_data.lsp or {}) or {})
|
|
end, diagnostics)
|
|
end
|
|
|
|
---@type table<integer, integer>
|
|
local _client_push_namespaces = {}
|
|
|
|
---@type table<string, integer>
|
|
local _client_pull_namespaces = {}
|
|
|
|
--- Get the diagnostic namespace associated with an LSP client |vim.diagnostic| for diagnostics
|
|
---
|
|
---@param client_id integer The id of the LSP client
|
|
---@param is_pull boolean? Whether the namespace is for a pull or push client. Defaults to push
|
|
function M.get_namespace(client_id, is_pull)
|
|
vim.validate({ client_id = { client_id, 'n' } })
|
|
|
|
local client = vim.lsp.get_client_by_id(client_id)
|
|
if is_pull then
|
|
local server_id =
|
|
vim.tbl_get((client or {}).server_capabilities, 'diagnosticProvider', 'identifier')
|
|
local key = string.format('%d:%s', client_id, server_id or 'nil')
|
|
local name = string.format(
|
|
'vim.lsp.%s.%d.%s',
|
|
client and client.name or 'unknown',
|
|
client_id,
|
|
server_id or 'nil'
|
|
)
|
|
local ns = _client_pull_namespaces[key]
|
|
if not ns then
|
|
ns = api.nvim_create_namespace(name)
|
|
_client_pull_namespaces[key] = ns
|
|
end
|
|
return ns
|
|
else
|
|
local name = string.format('vim.lsp.%s.%d', client and client.name or 'unknown', client_id)
|
|
local ns = _client_push_namespaces[client_id]
|
|
if not ns then
|
|
ns = api.nvim_create_namespace(name)
|
|
_client_push_namespaces[client_id] = ns
|
|
end
|
|
return ns
|
|
end
|
|
end
|
|
|
|
--- |lsp-handler| for the method "textDocument/publishDiagnostics"
|
|
---
|
|
--- See |vim.diagnostic.config()| for configuration options. Handler-specific
|
|
--- configuration can be set using |vim.lsp.with()|:
|
|
---
|
|
--- ```lua
|
|
--- vim.lsp.handlers["textDocument/publishDiagnostics"] = vim.lsp.with(
|
|
--- vim.lsp.diagnostic.on_publish_diagnostics, {
|
|
--- -- Enable underline, use default values
|
|
--- underline = true,
|
|
--- -- Enable virtual text, override spacing to 4
|
|
--- virtual_text = {
|
|
--- spacing = 4,
|
|
--- },
|
|
--- -- Use a function to dynamically turn signs off
|
|
--- -- and on, using buffer local variables
|
|
--- signs = function(namespace, bufnr)
|
|
--- return vim.b[bufnr].show_signs == true
|
|
--- end,
|
|
--- -- Disable a feature
|
|
--- update_in_insert = false,
|
|
--- }
|
|
--- )
|
|
--- ```
|
|
---
|
|
---@param ctx lsp.HandlerContext
|
|
---@param config table Configuration table (see |vim.diagnostic.config()|).
|
|
function M.on_publish_diagnostics(_, result, ctx, config)
|
|
local client_id = ctx.client_id
|
|
local uri = result.uri
|
|
local fname = vim.uri_to_fname(uri)
|
|
local diagnostics = result.diagnostics
|
|
if #diagnostics == 0 and vim.fn.bufexists(fname) == 0 then
|
|
return
|
|
end
|
|
local bufnr = vim.fn.bufadd(fname)
|
|
|
|
if not bufnr then
|
|
return
|
|
end
|
|
|
|
client_id = get_client_id(client_id)
|
|
local namespace = M.get_namespace(client_id, false)
|
|
|
|
if config then
|
|
for _, opt in pairs(config) do
|
|
if type(opt) == 'table' then
|
|
if not opt.severity and opt.severity_limit then
|
|
opt.severity = { min = severity_lsp_to_vim(opt.severity_limit) }
|
|
end
|
|
end
|
|
end
|
|
|
|
-- Persist configuration to ensure buffer reloads use the same
|
|
-- configuration. To make lsp.with configuration work (See :help
|
|
-- lsp-handler-configuration)
|
|
vim.diagnostic.config(config, namespace)
|
|
end
|
|
|
|
vim.diagnostic.set(namespace, bufnr, diagnostic_lsp_to_vim(diagnostics, bufnr, client_id))
|
|
end
|
|
|
|
--- |lsp-handler| for the method "textDocument/diagnostic"
|
|
---
|
|
--- See |vim.diagnostic.config()| for configuration options. Handler-specific
|
|
--- configuration can be set using |vim.lsp.with()|:
|
|
---
|
|
--- ```lua
|
|
--- vim.lsp.handlers["textDocument/diagnostic"] = vim.lsp.with(
|
|
--- vim.lsp.diagnostic.on_diagnostic, {
|
|
--- -- Enable underline, use default values
|
|
--- underline = true,
|
|
--- -- Enable virtual text, override spacing to 4
|
|
--- virtual_text = {
|
|
--- spacing = 4,
|
|
--- },
|
|
--- -- Use a function to dynamically turn signs off
|
|
--- -- and on, using buffer local variables
|
|
--- signs = function(namespace, bufnr)
|
|
--- return vim.b[bufnr].show_signs == true
|
|
--- end,
|
|
--- -- Disable a feature
|
|
--- update_in_insert = false,
|
|
--- }
|
|
--- )
|
|
--- ```
|
|
---
|
|
---@param ctx lsp.HandlerContext
|
|
---@param config table Configuration table (see |vim.diagnostic.config()|).
|
|
function M.on_diagnostic(_, result, ctx, config)
|
|
local client_id = ctx.client_id
|
|
local uri = ctx.params.textDocument.uri
|
|
local fname = vim.uri_to_fname(uri)
|
|
|
|
if result == nil then
|
|
return
|
|
end
|
|
|
|
if result.kind == 'unchanged' then
|
|
return
|
|
end
|
|
|
|
local diagnostics = result.items
|
|
if #diagnostics == 0 and vim.fn.bufexists(fname) == 0 then
|
|
return
|
|
end
|
|
local bufnr = vim.fn.bufadd(fname)
|
|
|
|
if not bufnr then
|
|
return
|
|
end
|
|
|
|
client_id = get_client_id(client_id)
|
|
|
|
local namespace = M.get_namespace(client_id, true)
|
|
|
|
if config then
|
|
for _, opt in pairs(config) do
|
|
if type(opt) == 'table' and not opt.severity and opt.severity_limit then
|
|
opt.severity = { min = severity_lsp_to_vim(opt.severity_limit) }
|
|
end
|
|
end
|
|
|
|
-- Persist configuration to ensure buffer reloads use the same
|
|
-- configuration. To make lsp.with configuration work (See :help
|
|
-- lsp-handler-configuration)
|
|
vim.diagnostic.config(config, namespace)
|
|
end
|
|
|
|
vim.diagnostic.set(namespace, bufnr, diagnostic_lsp_to_vim(diagnostics, bufnr, client_id))
|
|
end
|
|
|
|
--- Clear push diagnostics and diagnostic cache.
|
|
---
|
|
--- Diagnostic producers should prefer |vim.diagnostic.reset()|. However,
|
|
--- this method signature is still used internally in some parts of the LSP
|
|
--- implementation so it's simply marked @private rather than @deprecated.
|
|
---
|
|
---@param client_id integer
|
|
---@param buffer_client_map table map of buffers to active clients
|
|
---@private
|
|
function M.reset(client_id, buffer_client_map)
|
|
buffer_client_map = vim.deepcopy(buffer_client_map)
|
|
vim.schedule(function()
|
|
for bufnr, client_ids in pairs(buffer_client_map) do
|
|
if client_ids[client_id] then
|
|
local namespace = M.get_namespace(client_id, false)
|
|
vim.diagnostic.reset(namespace, bufnr)
|
|
end
|
|
end
|
|
end)
|
|
end
|
|
|
|
--- Get the diagnostics by line
|
|
---
|
|
--- Marked private as this is used internally by the LSP subsystem, but
|
|
--- most users should instead prefer |vim.diagnostic.get()|.
|
|
---
|
|
---@param bufnr integer|nil The buffer number
|
|
---@param line_nr integer|nil The line number
|
|
---@param opts table|nil Configuration keys
|
|
--- - severity: (DiagnosticSeverity, default nil)
|
|
--- - Only return diagnostics with this severity. Overrides severity_limit
|
|
--- - severity_limit: (DiagnosticSeverity, default nil)
|
|
--- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid.
|
|
---@param client_id integer|nil the client id
|
|
---@return table Table with map of line number to list of diagnostics.
|
|
--- Structured: { [1] = {...}, [5] = {.... } }
|
|
---@private
|
|
function M.get_line_diagnostics(bufnr, line_nr, opts, client_id)
|
|
opts = opts or {}
|
|
if opts.severity then
|
|
opts.severity = severity_lsp_to_vim(opts.severity)
|
|
elseif opts.severity_limit then
|
|
opts.severity = { min = severity_lsp_to_vim(opts.severity_limit) }
|
|
end
|
|
|
|
if client_id then
|
|
opts.namespace = M.get_namespace(client_id, false)
|
|
end
|
|
|
|
if not line_nr then
|
|
line_nr = vim.api.nvim_win_get_cursor(0)[1] - 1
|
|
end
|
|
|
|
opts.lnum = line_nr
|
|
|
|
return diagnostic_vim_to_lsp(vim.diagnostic.get(bufnr, opts))
|
|
end
|
|
|
|
--- Clear diagnostics from pull based clients
|
|
--- @private
|
|
local function clear(bufnr)
|
|
for _, namespace in pairs(_client_pull_namespaces) do
|
|
vim.diagnostic.reset(namespace, bufnr)
|
|
end
|
|
end
|
|
|
|
---@class lsp.diagnostic.bufstate
|
|
---@field enabled boolean Whether inlay hints are enabled for this buffer
|
|
---@type table<integer, lsp.diagnostic.bufstate>
|
|
local bufstates = {}
|
|
|
|
--- Disable pull diagnostics for a buffer
|
|
--- @param bufnr integer
|
|
--- @private
|
|
local function disable(bufnr)
|
|
local bufstate = bufstates[bufnr]
|
|
if bufstate then
|
|
bufstate.enabled = false
|
|
end
|
|
clear(bufnr)
|
|
end
|
|
|
|
--- Refresh diagnostics, only if we have attached clients that support it
|
|
---@param bufnr (integer) buffer number
|
|
---@param opts? table Additional options to pass to util._refresh
|
|
---@private
|
|
local function _refresh(bufnr, opts)
|
|
opts = opts or {}
|
|
opts['bufnr'] = bufnr
|
|
util._refresh(ms.textDocument_diagnostic, opts)
|
|
end
|
|
|
|
--- Enable pull diagnostics for a buffer
|
|
---@param bufnr (integer) Buffer handle, or 0 for current
|
|
---@private
|
|
function M._enable(bufnr)
|
|
if bufnr == nil or bufnr == 0 then
|
|
bufnr = api.nvim_get_current_buf()
|
|
end
|
|
|
|
if not bufstates[bufnr] then
|
|
bufstates[bufnr] = { enabled = true }
|
|
|
|
api.nvim_create_autocmd('LspNotify', {
|
|
buffer = bufnr,
|
|
callback = function(opts)
|
|
if
|
|
opts.data.method ~= ms.textDocument_didChange
|
|
and opts.data.method ~= ms.textDocument_didOpen
|
|
then
|
|
return
|
|
end
|
|
if bufstates[bufnr] and bufstates[bufnr].enabled then
|
|
_refresh(bufnr, { only_visible = true, client_id = opts.data.client_id })
|
|
end
|
|
end,
|
|
group = augroup,
|
|
})
|
|
|
|
api.nvim_buf_attach(bufnr, false, {
|
|
on_reload = function()
|
|
if bufstates[bufnr] and bufstates[bufnr].enabled then
|
|
_refresh(bufnr)
|
|
end
|
|
end,
|
|
on_detach = function()
|
|
disable(bufnr)
|
|
end,
|
|
})
|
|
|
|
api.nvim_create_autocmd('LspDetach', {
|
|
buffer = bufnr,
|
|
callback = function(args)
|
|
local clients = vim.lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_diagnostic })
|
|
|
|
if
|
|
not vim.iter(clients):any(function(c)
|
|
return c.id ~= args.data.client_id
|
|
end)
|
|
then
|
|
disable(bufnr)
|
|
end
|
|
end,
|
|
group = augroup,
|
|
})
|
|
else
|
|
bufstates[bufnr].enabled = true
|
|
end
|
|
end
|
|
|
|
return M
|