fix(diagnostic)!: make virtual text handler opt-in (#32079)

Making this opt-out (on by default) was the wrong choice from the
beginning. It is too visually noisy to be enabled by default.

BREAKING CHANGE: Users must opt-in to the diagnostic virtual text
handler by adding

  vim.diagnostic.config({ virtual_text = true })

to their config.
This commit is contained in:
Gregory Anders
2025-01-18 07:43:21 -06:00
committed by GitHub
parent 954d4969c9
commit 51ccd12b3d
4 changed files with 30 additions and 6 deletions

View File

@ -70,7 +70,7 @@ end
--- Use virtual text for diagnostics. If multiple diagnostics are set for a
--- namespace, one prefix per diagnostic + the last diagnostic message are
--- shown.
--- (default: `true`)
--- (default: `false`)
--- @field virtual_text? boolean|vim.diagnostic.Opts.VirtualText|fun(namespace: integer, bufnr:integer): vim.diagnostic.Opts.VirtualText
---
--- Use signs for diagnostics |diagnostic-signs|.
@ -312,7 +312,7 @@ M.severity = {
local global_diagnostic_options = {
signs = true,
underline = true,
virtual_text = true,
virtual_text = false,
float = true,
update_in_insert = false,
severity_sort = false,