feat(lspinfo): replace :LspInfo with :checkhealth

[justinmk]

Problem:

:LspInfo has its own "inner platlform" of highlights, mappings etc. And it doesn't integrate with :checkhealth.

Solution:

• Move the lspinfo code to a healthcheck.
• LspInfo features such as highlights, "floating window" presentation, etc., should be added to :checkhealth in Nvim core, if they are really needed.
• Add a "q" mapping until Nvim stable that in :checkhealth.

Testing

Tested on Nvim HEAD and Nvim 0.10.

Todo (future)

• The "docs" section doesn't have syntax highlighting currently. That may involve a fix for the >markdown directive, or maybe just the formatting needs to be adjusted to satisfy vimdoc.
  • Different idea: provide .../lspconfig/doc/configs.lua#<linenum> URLs which the user can visit with gF.

[glepnir]

It is definitely the direction to move forward. But the timing is not quite right. Because core checkhealth needs some improve. avoid some noisy issues, it's better after core checkhealth improved.

[justinmk]

Because core checkhealth needs some improve. avoid some noisy issues, it's better after core checkhealth improved.

which issues exactly should block this?

[glepnir]

the configured servers list and depreceted servers list is missing in checkhealth. may need an integration.

[justinmk]

the configured servers list and depreceted servers list is missing in checkhealth. may need an integration

? The code in this PR is the same as the old LspInfo implementation. So configured & deprecated should display, or there's a bug.

[justinmk]

deprecated servers

[glepnir]

Oh yes. i didn't look at code carefully.

[justinmk]

I need help with confirming that these messages still work correctly and are displayed nicely. Probably they should be converted to health.error() calls.

[daviareias]

any tips to restore the highlights? It's really hard to read the buffer returned by LspInfo now

[justinmk]

what highlights specifically

[daviareias]

what highlights specifically

Sorry I didn't explain my situation correctly.

before when I used to type LspInfo, it would show a nice floating window,
after the last update it shows a buffer like this:

I find it a little hard to read, and couldn't find how to customize it to put it inside a floating window like this:

[glepnir]

This is how it works now. CheckHealth is displayed in the normal window.

[justinmk]

You still didn't mention which highlights.

The door is open for adding features to :checkhealth, that needs to be done in Nvim core.

[nvim-enjoyer]

removing the floating window option and moving to a checkhealth looks way worse.

i get the idea of moving to :che but could that not have been done AFTER floating window support in nvim core???

[glepnir]

Please be patient. I will try to add a floating window for checkhealth in core and hope it will be in time for 0.11.

Update: early draft it works.

[GrzegorzKozub]

I was using require('lspconfig.ui.windows') to set the border of the LSP information float that is displayed when I hit the K button like so:

require('lspconfig.ui.windows').default_options.border = 'rounded'

I prefer using the NormalFloat highlight the same as my Normal (editor background) highlight and just have a rounded border.

Anyone knows if there's another way to change this border? The default seems none.

I also noticed that some configs in this repo still use this API, for example:

nvim-lspconfig/lua/lspconfig/configs/clangd.lua

Line 44 in dafd61d

border = require('lspconfig.ui.windows').default_options.border or 'single',

[justinmk]

I also noticed that some configs in this repo still use this API, for example:

Thanks for mentioning that. Fixed in #3454

I was using require('lspconfig.ui.windows') to set the border of the LSP information float that is displayed when I hit the K button like so:

K is unrelated to this repo. This repo is just a collection of configs. K is a default mapping provided by Nvim core, which calls vim.lsp.buf.hover(). See also neovim/neovim#31074