1
mirror of https://github.com/neovim/neovim.git synced 2024-12-28 14:31:13 -07:00

feat(diagnostic): update quickfix list by title

Previously, there was a singleton diagnostics quickfix list. Now there's
effectively one per title (up to vim's internal limit on quickfix
lists).

Suggested by mfussenegger https://github.com/neovim/neovim/pull/30868#pullrequestreview-2385761374.
This commit is contained in:
Jeremy Fleischman 2024-12-11 17:29:54 -08:00 committed by GitHub
parent 442d338cb5
commit 21961967ff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 22 additions and 16 deletions

View File

@ -874,7 +874,8 @@ setqflist({opts}) *vim.diagnostic.setqflist()*
• {open}? (`boolean`, default: `true`) Open quickfix list
after setting.
• {title}? (`string`) Title of quickfix list. Defaults to
"Diagnostics".
"Diagnostics". If there's already a quickfix list with this
title, it's updated. If not, a new quickfix list is created.
• {severity}? (`vim.diagnostic.SeverityFilter`) See
|diagnostic-severity|.

View File

@ -315,8 +315,8 @@ UI
|hl-PmenuSel| and |hl-PmenuMatch| both inherit from |hl-Pmenu|, and
|hl-PmenuMatchSel| inherits highlights from both |hl-PmenuSel| and
|hl-PmenuMatch|.
• |vim.diagnostic.setqflist()| updates existing diagnostics quickfix list if one
exists.
• |vim.diagnostic.setqflist()| updates an existing quickfix list with the
given title if found
• |ui-messages| content chunks now also contain the highlight group ID.

View File

@ -2,7 +2,19 @@ local api, if_nil = vim.api, vim.F.if_nil
local M = {}
local _qf_id = nil
--- @param title string
--- @return integer?
local function get_qf_id_for_title(title)
local lastqflist = vim.fn.getqflist({ nr = '$' })
for i = 1, lastqflist.nr do
local qflist = vim.fn.getqflist({ nr = i, id = 0, title = 0 })
if qflist.title == title then
return qflist.id
end
end
return nil
end
--- [diagnostic-structure]()
---
@ -845,24 +857,16 @@ local function set_list(loclist, opts)
if loclist then
vim.fn.setloclist(winnr, {}, 'u', { title = title, items = items })
else
-- Check if the diagnostics quickfix list no longer exists.
if _qf_id and vim.fn.getqflist({ id = _qf_id }).id == 0 then
_qf_id = nil
end
local qf_id = get_qf_id_for_title(title)
-- If we already have a diagnostics quickfix, update it rather than creating a new one.
-- This avoids polluting the finite set of quickfix lists, and preserves the currently selected
-- entry.
vim.fn.setqflist({}, _qf_id and 'u' or ' ', {
vim.fn.setqflist({}, qf_id and 'u' or ' ', {
title = title,
items = items,
id = _qf_id,
id = qf_id,
})
-- Get the id of the newly created quickfix list.
if _qf_id == nil then
_qf_id = vim.fn.getqflist({ id = 0 }).id
end
end
if open then
api.nvim_command(loclist and 'lwindow' or 'botright cwindow')
@ -2037,7 +2041,8 @@ end
--- (default: `true`)
--- @field open? boolean
---
--- Title of quickfix list. Defaults to "Diagnostics".
--- Title of quickfix list. Defaults to "Diagnostics". If there's already a quickfix list with this
--- title, it's updated. If not, a new quickfix list is created.
--- @field title? string
---
--- See |diagnostic-severity|.