diff options
| author | Jongwook Choi <wookayin@gmail.com> | 2024-01-23 01:04:20 -0500 |
|---|---|---|
| committer | Lewis Russell <me@lewisr.dev> | 2024-01-23 11:43:57 +0000 |
| commit | 89ffdebd20fd1d9c1ceff5fb005db11a0cf8c4d4 (patch) | |
| tree | 53e6cfbe753a616cc252ace0f4635b72bb3b9e3b | |
| parent | d9946006c96e65786dff8f8673912e01e2a1b714 (diff) | |
| download | rneovim-89ffdebd20fd1d9c1ceff5fb005db11a0cf8c4d4.tar.gz rneovim-89ffdebd20fd1d9c1ceff5fb005db11a0cf8c4d4.tar.bz2 rneovim-89ffdebd20fd1d9c1ceff5fb005db11a0cf8c4d4.zip | |
fix(diagnostic): fix typing on field |diagnostic-severity|
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|.
| -rw-r--r-- | runtime/lua/vim/diagnostic.lua | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua index 03a1fe9a2f..8845fb5b61 100644 --- a/runtime/lua/vim/diagnostic.lua +++ b/runtime/lua/vim/diagnostic.lua @@ -38,7 +38,7 @@ local M = {} --- @field scope? 'line'|'buffer'|'cursor'|'c'|'l'|'b' --- @field pos? integer|{[1]:integer,[2]:integer} --- @field severity_sort? boolean|{reverse?:boolean} ---- @field severity? vim.diagnostic.Severity +--- @field severity? vim.diagnostic.SeverityFilter --- @field header? string|{[1]:string,[2]:any} --- @field source? boolean|string --- @field format? fun(diagnostic:vim.Diagnostic): string @@ -47,10 +47,10 @@ local M = {} --- @field focus_id? string --- @class vim.diagnostic.Opts.Underline ---- @field severity? vim.diagnostic.Severity +--- @field severity? vim.diagnostic.SeverityFilter --- @class vim.diagnostic.Opts.VirtualText ---- @field severity? vim.diagnostic.Severity +--- @field severity? vim.diagnostic.SeverityFilter --- @field source? boolean|string --- @field prefix? string|function --- @field suffix? string|function @@ -63,7 +63,7 @@ local M = {} --- @field virt_text_hide? boolean --- @class vim.diagnostic.Opts.Signs ---- @field severity? vim.diagnostic.Severity +--- @field severity? vim.diagnostic.SeverityFilter --- @field priority? integer --- @field text? 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 +--- 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 M.severity.E = M.severity.ERROR M.severity.W = M.severity.WARN @@ -186,7 +189,7 @@ local function to_severity(severity) return severity 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[] --- @return vim.Diagnostic[] local function filter_by_severity(severity, diagnostics) @@ -1016,7 +1019,7 @@ end --- @class vim.diagnostic.GetOpts --- @field namespace? integer --- @field lnum? integer ---- @field severity? vim.diagnostic.Severity +--- @field severity? vim.diagnostic.SeverityFilter --- @class vim.diagnostic.GotoOpts : vim.diagnostic.GetOpts --- @field cursor_position? {[1]:integer,[2]:integer} @@ -1258,7 +1261,7 @@ M.handlers.virtual_text = { return end - local severity --- @type vim.diagnostic.Severity? + local severity --- @type vim.diagnostic.SeverityFilter? if opts.virtual_text then if opts.virtual_text.format then diagnostics = reformat_diagnostics(opts.virtual_text.format, diagnostics) |