refactor(lsp)!: deprecate lvim.lsp.diagnostics

[cpea2506]

Description

• There is no need to maintain lvim.lsp.diagnostics anymore as vim.diagnostic.config is easier to point to with regards to documentation.
• Provide a more intuitive way for users to change or disable custom handlers.

fixes #3874, resolves #2344

How Has This Been Tested?

• lvim.lsp.float.xxx and lvim.lsp.diagnostics.xxx are deprecated
• User should now use lvim.lsp.handlers and vim.diagnostic.config respectively instead.
• An example for migrating can be found at here: lvim.lsp.diagnostics.virtual_text can be a table if has('nvim-0.7') (currently forced to boolean) #2568 (comment)

[LostNeophyte]

we can use lvim.lsp.float for this purpose, no need to deprecate it.

• lsp/config.lua

  +-- set to nil to disable overriding lsp handlers
   lvim.lsp.float = { ... }

• handlers.lua

  +if lvim.lsp.float then
     vim.lsp.handlers["textDocument/hover"] = vim.lsp.with(vim.lsp.handlers.hover, lvim.lsp.float)
     vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with(vim.lsp.handlers.signature_help, lvim.lsp.float)
  +end

[cpea2506]

we can use lvim.lsp.float for this purpose, no need to deprecate it.

• lsp/config.lua

  +-- set to nil to disable overriding lsp handlers
   lvim.lsp.float = { ... }

• handlers.lua

  +if lvim.lsp.float then
     vim.lsp.handlers["textDocument/hover"] = vim.lsp.with(vim.lsp.handlers.hover, lvim.lsp.float)
     vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with(vim.lsp.handlers.signature_help, lvim.lsp.float)
  +end

lvim.lsp.float seems hard for user to know what it does and where it was put unless they dive into lsp source code

[LostNeophyte]

lvim.lsp.float seems hard for user to know what it does and where it was put unless they dive into lsp source code

I agree, float isn't that descriptive

[mamaraddio]

Hi guys, as a user that faced this issue I can say it could be great if you could put a line in the Lunarvim docs explaining how to use it and make it settable from config.lua just like other options instead of changing lsp configuration code

[LostNeophyte]

Hi guys, as a user that faced this issue I can say it could be great if you could put a line in the Lunarvim docs explaining how to use it and make it settable from config.lua just like other options instead of changing lsp configuration code

that's what this pr is doing

[kylo252]

I agree that it's time to change this since it was limited, but I'm not sure if it's wise to introduce even more obscure variables. Please take a look at #2344

The ideal solution is to mimic how vim.lsp works:

• create a table that exactly matches the entries passed to vim.lsp.config
• override handlers using a public re-usable API, e.g. lvim.lsp.handlers

(Important!) make sure all of the above is set once at startup

[cpea2506]

The ideal solution is to mimic how vim.lsp works:

• create a table that exactly matches the entries passed to vim.lsp.config
• override handlers using a public re-usable API, e.g. lvim.lsp.handlers

(Important!) make sure all of the above is set once at startup

Sorry for the late response!

• Should I create a new lsp/diagnostics.lua file to load the default config for vim.diagnostics.config or handle it in handlers.lua as is?
• For the handler I think I should simply remove the override_config inside.

[kylo252]

@cpea2506, I made some minor changes to clean up a few things, and also make the deprecation message clearer with regards to how to handle it.

Just need you guys to test it, otherwise LGTM! 🚀