mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-22 17:11:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

lsp: Add severity_limit for other diagnostics features (#13528)

Browse Source 
* lsp: Add severity_limit for other diagnostics

* docs and tests

* fix: lint

* Add to other types

* fix: lint
This commit is contained in:
TJ DeVries
2021-01-12 12:58:50 -05:00
committed by GitHub
parent e0a4399adc
commit 9f3b2a757b
3 changed files with 113 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
runtime/doc/lsp.txt
View File

@@ -1340,10 +1340,14 @@ set_underline({diagnostics}, {bufnr}, {client_id}, {diagnostic_ns}, {opts})
Parameters: ~
{diagnostics} Diagnostic []
{bufnr} number The buffer number
{client_id} number the client id
{diagnostic_ns} number|nil
{opts} table Currently unused.
{bufnr} number: The buffer number
{client_id} number: The client id
{diagnostic_ns} number|nil: The namespace
{opts} table: Configuration table:
• severity_limit (DiagnosticSeverity):
• Limit severity of diagnostics found.
E.g. "Warning" means { "Error",
"Warning" } will be valid.
*vim.lsp.diagnostic.set_virtual_text()*
set_virtual_text({diagnostics}, {bufnr}, {client_id}, {diagnostic_ns}, {opts})
@@ -1370,6 +1374,10 @@ set_virtual_text({diagnostics}, {bufnr}, {client_id}, {diagnostic_ns}, {opts})
before virtual text on line
• spacing (number): Number of spaces to
insert before virtual text
• severity_limit (DiagnosticSeverity):
• Limit severity of diagnostics found.
E.g. "Warning" means { "Error",
"Warning" } will be valid.
*vim.lsp.diagnostic.show_line_diagnostics()*
show_line_diagnostics({opts}, {bufnr}, {line_nr}, {client_id})

73
runtime/lua/vim/lsp/diagnostic.lua
View File

@@ -16,6 +16,24 @@ local to_severity = function(severity)
return type(severity) == 'string' and DiagnosticSeverity[severity] or severity
end
local filter_to_severity_limit = function(severity, diagnostics)
local filter_level = to_severity(severity)
if not filter_level then
return diagnostics
end
return vim.tbl_filter(function(t) return t.severity == filter_level end, diagnostics)
end
local filter_by_severity_limit = function(severity_limit, diagnostics)
local filter_level = to_severity(severity_limit)
if not filter_level then
return diagnostics
end
return vim.tbl_filter(function(t) return t.severity <= filter_level end, diagnostics)
end
local to_position = function(position, bufnr)
vim.validate { position = {position, 't'} }
@@ -377,11 +395,9 @@ function M.get_line_diagnostics(bufnr, line_nr, opts, client_id)
end
if opts.severity then
local filter_level = to_severity(opts.severity)
line_diagnostics = vim.tbl_filter(function(t) return t.severity == filter_level end, line_diagnostics)
line_diagnostics = filter_to_severity_limit(opts.severity, line_diagnostics)
elseif opts.severity_limit then
local filter_level = to_severity(opts.severity_limit)
line_diagnostics = vim.tbl_filter(function(t) return t.severity <= filter_level end, line_diagnostics)
line_diagnostics = filter_by_severity_limit(opts.severity_limit, line_diagnostics)
end
if opts.severity_sort then
@@ -542,7 +558,7 @@ function M.goto_prev(opts)
)
end
--- Get the previous diagnostic closest to the cursor_position
--- Get the next diagnostic closest to the cursor_position
---@param opts table See |vim.lsp.diagnostic.goto_next()|
---@return table Next diagnostic
function M.get_next(opts)
@@ -609,6 +625,8 @@ end
---@param sign_ns number|nil
---@param opts table Configuration for signs. Keys:
--- - priority: Set the priority of the signs.
--- - severity_limit (DiagnosticSeverity):
--- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid.
function M.set_signs(diagnostics, bufnr, client_id, sign_ns, opts)
opts = opts or {}
sign_ns = sign_ns or M._get_sign_namespace(client_id)
@@ -622,9 +640,11 @@ function M.set_signs(diagnostics, bufnr, client_id, sign_ns, opts)
end
bufnr = get_bufnr(bufnr)
diagnostics = filter_by_severity_limit(opts.severity_limit, diagnostics)
local ok = true
for _, diagnostic in ipairs(diagnostics) do
ok = ok and pcall(vim.fn.sign_place,
0,
sign_ns,
@@ -654,15 +674,17 @@ end
--- </pre>
---
---@param diagnostics Diagnostic[]
---@param bufnr number The buffer number
---@param client_id number the client id
---@param diagnostic_ns number|nil
---@param opts table Currently unused.
---@param bufnr number: The buffer number
---@param client_id number: The client id
---@param diagnostic_ns number|nil: The namespace
---@param opts table: Configuration table:
--- - severity_limit (DiagnosticSeverity):
--- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid.
function M.set_underline(diagnostics, bufnr, client_id, diagnostic_ns, opts)
opts = opts or {}
assert(opts) -- lint
diagnostic_ns = diagnostic_ns or M._get_diagnostic_namespace(client_id)
diagnostics = filter_by_severity_limit(opts.severity_limit, diagnostics)
for _, diagnostic in ipairs(diagnostics) do
local start = diagnostic.range["start"]
@@ -703,6 +725,8 @@ end
---@param opts table Options on how to display virtual text. Keys:
--- - prefix (string): Prefix to display before virtual text on line
--- - spacing (number): Number of spaces to insert before virtual text
--- - severity_limit (DiagnosticSeverity):
--- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid.
function M.set_virtual_text(diagnostics, bufnr, client_id, diagnostic_ns, opts)
opts = opts or {}
@@ -721,6 +745,7 @@ function M.set_virtual_text(diagnostics, bufnr, client_id, diagnostic_ns, opts)
end
for line, line_diagnostics in pairs(buffer_line_diagnostics) do
line_diagnostics = filter_by_severity_limit(opts.severity_limit, line_diagnostics)
local virt_texts = M.get_virtual_text_chunks_for_line(bufnr, line, line_diagnostics, opts)
if virt_texts then
@@ -1082,7 +1107,7 @@ end
---@param bufnr number The buffer number
---@param line_nr number The line number
---@param client_id number|nil the client id
---@return {popup_bufnr, win_id}
---@return table {popup_bufnr, win_id}
function M.show_line_diagnostics(opts, bufnr, line_nr, client_id)
opts = opts or {}
opts.severity_sort = if_nil(opts.severity_sort, true)
@@ -1151,30 +1176,14 @@ function M.set_loclist(opts)
local bufnr = vim.api.nvim_get_current_buf()
local buffer_diags = M.get(bufnr, opts.client_id)
local severity = to_severity(opts.severity)
local severity_limit = to_severity(opts.severity_limit)
if opts.severity then
buffer_diags = filter_to_severity_limit(opts.severity, buffer_diags)
elseif opts.severity_limit then
buffer_diags = filter_by_severity_limit(opts.severity_limit, buffer_diags)
end
local items = {}
local insert_diag = function(diag)
if severity then
-- Handle missing severities
if not diag.severity then
return
end
if severity ~= diag.severity then
return
end
elseif severity_limit then
if not diag.severity then
return
end
if severity_limit < diag.severity then
return
end
end
local pos = diag.range.start
local row = pos.line
local col = util.character_offset(bufnr, row, pos.character)

90
test/functional/plugin/lsp/diagnostic_spec.lua
View File

@@ -12,41 +12,41 @@ describe('vim.lsp.diagnostic', function()
clear()
exec_lua [[
require('vim.lsp')
require('vim.lsp')
make_range = function(x1, y1, x2, y2)
return { start = { line = x1, character = y1 }, ['end'] = { line = x2, character = y2 } }
end
make_range = function(x1, y1, x2, y2)
return { start = { line = x1, character = y1 }, ['end'] = { line = x2, character = y2 } }
end
make_error = function(msg, x1, y1, x2, y2)
return {
range = make_range(x1, y1, x2, y2),
message = msg,
severity = 1,
}
end
make_error = function(msg, x1, y1, x2, y2)
return {
range = make_range(x1, y1, x2, y2),
message = msg,
severity = 1,
}
end
make_warning = function(msg, x1, y1, x2, y2)
return {
range = make_range(x1, y1, x2, y2),
message = msg,
severity = 2,
}
end
make_warning = function(msg, x1, y1, x2, y2)
return {
range = make_range(x1, y1, x2, y2),
message = msg,
severity = 2,
}
end
make_information = function(msg, x1, y1, x2, y2)
return {
range = make_range(x1, y1, x2, y2),
message = msg,
severity = 3,
}
end
make_information = function(msg, x1, y1, x2, y2)
return {
range = make_range(x1, y1, x2, y2),
message = msg,
severity = 3,
}
end
count_of_extmarks_for_client = function(bufnr, client_id)
return #vim.api.nvim_buf_get_extmarks(
bufnr, vim.lsp.diagnostic._get_diagnostic_namespace(client_id), 0, -1, {}
)
end
count_of_extmarks_for_client = function(bufnr, client_id)
return #vim.api.nvim_buf_get_extmarks(
bufnr, vim.lsp.diagnostic._get_diagnostic_namespace(client_id), 0, -1, {}
)
end
]]
fake_uri = "file://fake/uri"
@@ -640,6 +640,36 @@ describe('vim.lsp.diagnostic', function()
eq(expected_spacing, #spacing)
end)
it('allows filtering via severity limit', function()
local get_extmark_count_with_severity = function(severity_limit)
return exec_lua([[
PublishDiagnostics = vim.lsp.with(vim.lsp.diagnostic.on_publish_diagnostics, {
underline = false,
virtual_text = {
severity_limit = ...
},
})
PublishDiagnostics(nil, nil, {
uri = fake_uri,
diagnostics = {
make_warning('Delayed Diagnostic', 4, 4, 4, 4),
}
}, 1
)
return count_of_extmarks_for_client(diagnostic_bufnr, 1)
]], severity_limit)
end
-- No messages with Error or higher
eq(0, get_extmark_count_with_severity("Error"))
-- But now we don't filter it
eq(1, get_extmark_count_with_severity("Warning"))
eq(1, get_extmark_count_with_severity("Hint"))
end)
end)
describe('lsp.util.show_line_diagnostics', function()