Toggle diagnostics

[georges-g]

Hello,

Thanks for the open source work!

I know I can turn on and off diagnostics with let g:lsp_diagnostics_enabled = 0 or 1. However, changing this variable requires to restart vim to become effective.

Is there any option to be able to toggle diagnostics on and off live?

[whenov]

I was wondering the same thing. Usually I don't want diagnostics for unfinished code.

[prabirshrestha]

You can use autocmd and function described here to accomplish this.

vim-lsp/doc/vim-lsp.txt

Lines 1396 to 1422 in c075e15

	lsp#enable_diagnostics_for_buffer() *lsp#enable_diagnostic_for_buffer()*
	Re-enable diagnostics for the specified buffer. By default diagnostics are
	enabled for all buffers.
	Example: >
	:call lsp#enable_diagnostics_for_buffer()
	:call lsp#enable_diagnostics_for_buffer(bufnr('%'))
	lsp#disable_diagnostics_for_buffer() *lsp#disable_diagnostics_for_buffer()*
	Diable diagnostics for the specified buffer. By default diagnostics are
	enabled for all buffers.
	Example: >
	:call lsp#enable_diagnostics_for_buffer()
	:call lsp#enable_diagnostics_for_buffer(bufnr('%'))
	Diagnostics can be disabled for buffer to temporarily avoid conflicts with
	other plugins.
	Example: >
	augroup LspEasyMotion
	autocmd!
	autocmd User EasyMotionPromptBegin call lsp#disable_diagnostics_for_buffer()<CR>
	autocmd User EasyMotionPromptEnd call lsp#enable_diagnostics_for_buffer()<CR>
	augroup END

[georges-g]

That is great, it is working fine.

If this can help, I created a shortcut using a custom global variable :

let g:my_lsp_diagnostics_enabled = 1

function s:MyToggleLSPDiagnostics()
    if g:my_lsp_diagnostics_enabled == 1
        call lsp#disable_diagnostics_for_buffer()
        let g:my_lsp_diagnostics_enabled = 0
        echo "LSP Diagnostics : off"
    else
        call lsp#enable_diagnostics_for_buffer()
        let g:my_lsp_diagnostics_enabled = 1
        echo "LSP Diagnostics : on"
    endif
endfunction

command MyToggleLSPDiagnostics call s:MyToggleLSPDiagnostics()

nnoremap <F12> :MyToggleLSPDiagnostics<CR>

However, be aware it requires let g:lsp_diagnostics_enabled = 1, you cannot start the diagnostics live otherwise.

A last question about that, I want to start vim with let g:lsp_diagnostics_enabled = 1, but automatically turn off the diagnostics calling call lsp#disable_diagnostics_for_buffer(), do you know how I can do that? I suppose it's an autocmd but I am not familiar with those.

EDIT: Forgot some code

[georges-g]

I eventually got some time to look at those autocommands in vim and found a way to disable the diagnostics at startup while being able to toggle them if needed.

First, you need to turn on diagnostics:

let g:lsp_diagnostics_enabled = 1

Then, you can turn if off using the s:on_lsp_buffer_enabled() function (see first page):

function! s:on_lsp_buffer_enabled() abort
    ...
    call lsp#disable_diagnostics_for_buffer()
    let g:my_lsp_diagnostics_enabled = 0

And tada, toggling works.

This is a workaround. Ideally, you could implement things so that you can have let g:lsp_diagnostics_enabled = 0 at startup and still be able to call lsp#enable_diagnostics_for_buffer(). I might look into that.

[prabirshrestha]

Closing since it is already possible but feel free to continue discussions here.

[georges-g]

A quick update on this matter, if you want to be able to toggle LSP Diagnostics globally and not just on the buffer you edit, you need to have this code :

function! s:on_lsp_buffer_enabled() abort
    ...
    if g:my_lsp_diagnostics_enabled == 0
        call lsp#disable_diagnostics_for_buffer()
    else
        call lsp#enable_diagnostics_for_buffer()
    endif

And you can start with let g:my_lsp_diagnostics_enabled = 0 to have no diagnostics at startup.

[dehidehidehi]

Adding to George's contribution I've adjusted it such that the variable handling the toggle state is per buffer:

" Toggling diagnostics and virtual text {{{
autocmd BufEnter * let b:my_lsp_diagnostics_enabled = 1
function! s:MyToggleLSPDiagnostics()
	" source: https://github.com/prabirshrestha/vim-lsp/issues/1312
    if !exists('b:my_lsp_diagnostics_enabled')
		" Ensure the buffer variable is defined
        let b:my_lsp_diagnostics_enabled = 1
    endif
    if b:my_lsp_diagnostics_enabled == 1
        call lsp#disable_diagnostics_for_buffer()
        let b:my_lsp_diagnostics_enabled = 0
        echo "LSP Diagnostics : OFF"
    else
        call lsp#enable_diagnostics_for_buffer()
        let b:my_lsp_diagnostics_enabled = 1
        echo "LSP Diagnostics : ON"
    endif
endfunction
command MyToggleLSPDiagnostics call s:MyToggleLSPDiagnostics()
nnoremap <leader><leader> :MyToggleLSPDiagnostics<CR>zz
" Toggling diagnostic and virtual text }}}