mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-06 03:18:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(diagnostic): provide more control over virtual text display (#24724)

Browse Source 
Allow users to pass virtual text options to nvim_buf_set_extmark through
the "virtual_text" table in vim.diagnostic.config().

Fixes: https://github.com/neovim/neovim/issues/16545
This commit is contained in:
Gregory Anders
2023-08-16 08:21:32 -05:00
committed by GitHub
parent 54be7d6b45
commit 9cb7e00b97
3 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
runtime/doc/diagnostic.txt
View File

@@ -382,7 +382,10 @@ config({opts}, {namespace}) *vim.diagnostic.config()*
• virtual_text: (default true) Use virtual text for • virtual_text: (default true) Use virtual text for
diagnostics. If multiple diagnostics are set for a diagnostics. If multiple diagnostics are set for a
namespace, one prefix per diagnostic + the last namespace, one prefix per diagnostic + the last
diagnostic message are shown. Options: diagnostic message are shown. In addition to the
options listed below, the "virt_text" options of
|nvim_buf_set_extmark()| may also be used here (e.g.
"virt_text_pos" and "hl_mode"). Options:
• severity: Only show virtual text for diagnostics • severity: Only show virtual text for diagnostics
matching the given severity |diagnostic-severity| matching the given severity |diagnostic-severity|
• source: (boolean or string) Include the diagnostic • source: (boolean or string) Include the diagnostic

5
runtime/doc/news.txt
View File

@@ -194,6 +194,11 @@ The following changes to existing APIs or features add new behavior.
automatically if the job exited without error, eliminating the (often automatically if the job exited without error, eliminating the (often
unwanted) "[Process exited 0]" message. unwanted) "[Process exited 0]" message.
• |vim.diagnostic.config()| now accepts virtual text relevant options to
|nvim_buf_set_extmark()| (e.g. "virt_text_pos" and "hl_mode") in its
"virtual_text" table, which gives users more control over how diagnostic
virtual text is displayed.
============================================================================== ==============================================================================
REMOVED FEATURES *news-removed* REMOVED FEATURES *news-removed*

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

@@ -566,7 +566,9 @@ end
--- severity |diagnostic-severity| --- severity |diagnostic-severity|
--- - virtual_text: (default true) Use virtual text for diagnostics. If multiple diagnostics --- - virtual_text: (default true) Use virtual text for diagnostics. If multiple diagnostics
--- are set for a namespace, one prefix per diagnostic + the last diagnostic --- are set for a namespace, one prefix per diagnostic + the last diagnostic
--- message are shown. --- message are shown. In addition to the options listed below, the
--- "virt_text" options of |nvim_buf_set_extmark()| may also be used here
--- (e.g. "virt_text_pos" and "hl_mode").
--- Options: --- Options:
--- * severity: Only show virtual text for diagnostics matching the given --- * severity: Only show virtual text for diagnostics matching the given
--- severity |diagnostic-severity| --- severity |diagnostic-severity|
@@ -1008,8 +1010,11 @@ M.handlers.virtual_text = {
if virt_texts then if virt_texts then
api.nvim_buf_set_extmark(bufnr, virt_text_ns, line, 0, { api.nvim_buf_set_extmark(bufnr, virt_text_ns, line, 0, {
hl_mode = 'combine', hl_mode = opts.virtual_text.hl_mode or 'combine',
virt_text = virt_texts, virt_text = virt_texts,
virt_text_pos = opts.virtual_text.virt_text_pos,
virt_text_hide = opts.virtual_text.virt_text_hide,
virt_text_win_col = opts.virtual_text.virt_text_win_col,
}) })
end end
end end