diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2025-03-26 12:13:08 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-03-26 12:13:08 -0700 |
| commit | 401e50fae626c4707af12114b5ddb7bb9f4236a4 (patch) | |
| tree | 5a8aafda5664f3283d93d6f8a2ded3a5c292ab2d | |
| parent | docs: update configs.md (diff) | |
| download | nvim-lspconfig-401e50fae626c4707af12114b5ddb7bb9f4236a4.tar nvim-lspconfig-401e50fae626c4707af12114b5ddb7bb9f4236a4.tar.gz nvim-lspconfig-401e50fae626c4707af12114b5ddb7bb9f4236a4.tar.bz2 nvim-lspconfig-401e50fae626c4707af12114b5ddb7bb9f4236a4.tar.lz nvim-lspconfig-401e50fae626c4707af12114b5ddb7bb9f4236a4.tar.xz nvim-lspconfig-401e50fae626c4707af12114b5ddb7bb9f4236a4.tar.zst nvim-lspconfig-401e50fae626c4707af12114b5ddb7bb9f4236a4.zip | |
feat: alias :LspInfo to `:checkhealth vim.lsp` #3663
Problem:
`:checkhealth lspconfig` has no benefits vs `:checkhealth vim.lsp`.
Solution:
- on Nvim 0.11+, `:LspInfo` is an alias to `:checkhealth vim.lsp`
instead of `:checkhealth lspconfig`.
- `lua/lspconfig/health.lua` will be removed in a few months.
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | doc/lspconfig.txt | 15 | ||||
| -rw-r--r-- | lua/lspconfig/health.lua | 6 | ||||
| -rw-r--r-- | plugin/lspconfig.lua | 2 |
4 files changed, 12 insertions, 13 deletions
@@ -120,7 +120,7 @@ Most of the time, the reason for failure is present in the logs. ## Commands -* `:LspInfo` (deprecated alias to `:che lspconfig`) shows the status of active and configured language servers. +* `:LspInfo` (alias to `:checkhealth vim.lsp`) shows the status of active and configured language servers. * `:LspStart <config_name>` Start the requested server name. Will only successfully start if the command detects a root directory matching the current config. Pass `autostart = false` to your `.setup{}` call for a language server if you would like to launch clients solely with this command. Defaults to all servers matching current buffer filetype. * `:LspStop [<client_id_or_name> ...]` Stops the given server(s). Defaults to stopping all servers active on the current buffer. To force stop add `++force` diff --git a/doc/lspconfig.txt b/doc/lspconfig.txt index 971f11e1..c2f02a8b 100644 --- a/doc/lspconfig.txt +++ b/doc/lspconfig.txt @@ -392,14 +392,8 @@ standard for single-file mode, lspconfig will adopt that standard. COMMANDS *lspconfig-commands* :LspInfo *:LspInfo* -Deprecated alias to `:check lspconfig`. -Shows the status of all configured language servers. Note that client id -refers to the Nvim RPC channel connected to a given language server. Also -lists deprecated servers. - -The following commands support tab-completion for all arguments. All commands -that require a client id can either leverage tab-completion or the info -contained in `:LspInfo`: +Alias to `:checkhealth vim.lsp`. Shows the status of active LSP clients and +servers. :LspStart [config_name] *:LspStart* Launches the requested (configured) client, but only if it successfully @@ -474,8 +468,7 @@ For debugging nvim-lspconfig issues, the most common hurdles users face are: `handlers`. Ensure that you debug by using a stock configuration to ensure your customizations are not introducing issues. -|LspInfo| provides an overview of your active and configured language servers -which can be useful for debugging. +|:LspInfo| provides an overview which can be useful for debugging. Note that it will not report any configuration changes applied in `on_new_config`. @@ -511,7 +504,7 @@ Highlights *lspconfig-highlight* WARNING: The `require('lspconfig.ui.windows')` API was removed. LspInfo is provided by a healthcheck instead: >vim - :checkhealth lspconfig + :checkhealth vim.lsp < ============================================================================== diff --git a/lua/lspconfig/health.lua b/lua/lspconfig/health.lua index 7477dff7..02326c84 100644 --- a/lua/lspconfig/health.lua +++ b/lua/lspconfig/health.lua @@ -323,6 +323,12 @@ local function check_lspdocs(buf_clients, other_matching_configs) end function M.check() + if vim.fn.has('nvim-0.11') == 1 then + vim.deprecate(':checkhealth lspconfig', ':checkhealth vim.lsp', '0.12', 'nvim-lspconfig', false) + vim.cmd [[checkhealth vim.lsp]] + return + end + -- XXX: create "q" mapping until :checkhealth has this feature in Nvim stable. vim.cmd [[nnoremap <buffer> q <c-w>q]] diff --git a/plugin/lspconfig.lua b/plugin/lspconfig.lua index 92a8208b..47ba1731 100644 --- a/plugin/lspconfig.lua +++ b/plugin/lspconfig.lua @@ -65,7 +65,7 @@ end -- Called from plugin/lspconfig.vim because it requires knowing that the last -- script in scriptnames to be executed is lspconfig. -api.nvim_create_user_command('LspInfo', ':che lspconfig', { desc = 'Deprecated alias to `:che lspconfig`' }) +api.nvim_create_user_command('LspInfo', ':checkhealth vim.lsp', { desc = 'Alias to `:checkhealth vim.lsp`' }) api.nvim_create_user_command('LspStart', function(info) local server_name = string.len(info.args) > 0 and info.args or nil |
