mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-26 12:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(diagnostic): fix typing on field |diagnostic-severity|

Browse Source 
Problem: vim.diagnostic.{underline,float,virtual_text...}.severity
will have a type warning on list-like or table (min-max) inputs,
e.g. `vim.diagnostic.config { float = { severity = { min = INFO } } }`.

Solution: Correct the typing as documented in |diagnostic-severity|.
This commit is contained in:
Jongwook Choi
2024-01-23 01:04:20 -05:00
committed by Lewis Russell
parent d9946006c9
commit 89ffdebd20
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
runtime/lua/vim/diagnostic.lua
View File

@@ -38,7 +38,7 @@ local M = {}
--- @field scope? 'line'|'buffer'|'cursor'|'c'|'l'|'b' --- @field scope? 'line'|'buffer'|'cursor'|'c'|'l'|'b'
--- @field pos? integer|{[1]:integer,[2]:integer} --- @field pos? integer|{[1]:integer,[2]:integer}
--- @field severity_sort? boolean|{reverse?:boolean} --- @field severity_sort? boolean|{reverse?:boolean}
--- @field severity? vim.diagnostic.Severity --- @field severity? vim.diagnostic.SeverityFilter
--- @field header? string|{[1]:string,[2]:any} --- @field header? string|{[1]:string,[2]:any}
--- @field source? boolean|string --- @field source? boolean|string
--- @field format? fun(diagnostic:vim.Diagnostic): string --- @field format? fun(diagnostic:vim.Diagnostic): string
@@ -47,10 +47,10 @@ local M = {}
--- @field focus_id? string --- @field focus_id? string
--- @class vim.diagnostic.Opts.Underline --- @class vim.diagnostic.Opts.Underline
--- @field severity? vim.diagnostic.Severity --- @field severity? vim.diagnostic.SeverityFilter
--- @class vim.diagnostic.Opts.VirtualText --- @class vim.diagnostic.Opts.VirtualText
--- @field severity? vim.diagnostic.Severity --- @field severity? vim.diagnostic.SeverityFilter
--- @field source? boolean|string --- @field source? boolean|string
--- @field prefix? string|function --- @field prefix? string|function
--- @field suffix? string|function --- @field suffix? string|function
@@ -63,7 +63,7 @@ local M = {}
--- @field virt_text_hide? boolean --- @field virt_text_hide? boolean
--- @class vim.diagnostic.Opts.Signs --- @class vim.diagnostic.Opts.Signs
--- @field severity? vim.diagnostic.Severity --- @field severity? vim.diagnostic.SeverityFilter
--- @field priority? integer --- @field priority? integer
--- @field text? table<vim.diagnostic.Severity,string> --- @field text? table<vim.diagnostic.Severity,string>
--- @field numhl? table<vim.diagnostic.Severity,string> --- @field numhl? table<vim.diagnostic.Severity,string>
@@ -84,6 +84,9 @@ M.severity = {
--- @alias vim.diagnostic.SeverityInt 1|2|3|4 --- @alias vim.diagnostic.SeverityInt 1|2|3|4
--- See |diagnostic-severity| and |vim.diagnostic.get()|
--- @alias vim.diagnostic.SeverityFilter vim.diagnostic.Severity|vim.diagnostic.Severity[]|{min:vim.diagnostic.Severity,max:vim.diagnostic.Severity}
-- Mappings from qflist/loclist error types to severities -- Mappings from qflist/loclist error types to severities
M.severity.E = M.severity.ERROR M.severity.E = M.severity.ERROR
M.severity.W = M.severity.WARN M.severity.W = M.severity.WARN
@@ -186,7 +189,7 @@ local function to_severity(severity)
return severity return severity
end end
--- @param severity vim.diagnostic.Severity|vim.diagnostic.Severity[]|{min:vim.diagnostic.Severity,max:vim.diagnostic.Severity} --- @param severity vim.diagnostic.SeverityFilter
--- @param diagnostics vim.Diagnostic[] --- @param diagnostics vim.Diagnostic[]
--- @return vim.Diagnostic[] --- @return vim.Diagnostic[]
local function filter_by_severity(severity, diagnostics) local function filter_by_severity(severity, diagnostics)
@@ -1016,7 +1019,7 @@ end
--- @class vim.diagnostic.GetOpts --- @class vim.diagnostic.GetOpts
--- @field namespace? integer --- @field namespace? integer
--- @field lnum? integer --- @field lnum? integer
--- @field severity? vim.diagnostic.Severity --- @field severity? vim.diagnostic.SeverityFilter
--- @class vim.diagnostic.GotoOpts : vim.diagnostic.GetOpts --- @class vim.diagnostic.GotoOpts : vim.diagnostic.GetOpts
--- @field cursor_position? {[1]:integer,[2]:integer} --- @field cursor_position? {[1]:integer,[2]:integer}
@@ -1258,7 +1261,7 @@ M.handlers.virtual_text = {
return return
end end
local severity --- @type vim.diagnostic.Severity? local severity --- @type vim.diagnostic.SeverityFilter?
if opts.virtual_text then if opts.virtual_text then
if opts.virtual_text.format then if opts.virtual_text.format then
diagnostics = reformat_diagnostics(opts.virtual_text.format, diagnostics) diagnostics = reformat_diagnostics(opts.virtual_text.format, diagnostics)