Configs for the Nvim LSP client (:help lsp
).
See also :help lspconfig
.
Requires neovim version 0.8 above. Update Nvim and nvim-lspconfig before reporting an issue.
Install nvim-lspconfig using builtin packages:
git clone https://github.com/neovim/nvim-lspconfig ~/.config/nvim/pack/nvim/start/nvim-lspconfig
Alternatively, nvim-lspconfig can be installed using a 3rd party plugin manager (consult the documentation for your plugin manager for details).
npm i -g pyright
require'lspconfig'.pyright.setup{}
nvim main.py
:checkhealth lsp
to see the status or to troubleshoot.See server_configurations.md (:help lspconfig-all
from Nvim) for the full list of configs, including installation instructions and additional, optional, customization suggestions for each language server. For servers that are not on your system path (e.g., jdtls
, elixirls
), you must manually add cmd
to the setup
parameter. Most language servers can be installed in less than a minute.
Nvim sets some default options whenever a buffer attaches to an LSP client. See :h lsp-config
for more details. In particular, the following options are set:
'tagfunc'
<C-]>
and other tag commands.'omnifunc'
<C-X><C-O>
in Insert mode. For autocompletion, an autocompletion plugin is required.'formatexpr'
gq
.Nvim also maps K
to vim.lsp.buf.hover()
in Normal mode.
Nvim 0.10 and newer creates the following default maps unconditionally:
[d
and ]d
map to vim.diagnostic.goto_prev()
and vim.diagnostic.goto_next()
(respectively)<C-W>d
maps to vim.diagnostic.open_float()
Further customization can be achieved using the LspAttach
autocommand event.
The LspDetach
autocommand event can be used to "cleanup" mappings if a buffer becomes detached from an LSP server.
See :h LspAttach
and :h LspDetach
for details and examples.
See :h lsp-buf
for details on other LSP functions.
Additional configuration options can be provided for each LSP server by passing arguments to the setup
function. See :h lspconfig-setup
for details. Example:
local lspconfig = require('lspconfig')
lspconfig.rust_analyzer.setup {
-- Server-specific settings. See `:help lspconfig-setup`
settings = {
['rust-analyzer'] = {},
},
}
If you have an issue, the first step is to reproduce with a minimal configuration.
The most common reasons a language server does not start or attach are:
cmd
defined in each server's Lua module from the command line and see that the language server starts. If the cmd
is an executable name instead of an absolute path to the executable, ensure it is on your path.:set ft?
shows the filetype and not an empty value..git
folder, but each server defines the root config in the lua file. See server_configurations.md or the source for the list of root directories.capabilities
for each setup {}
if you want these to take effect.setup {}
twice for the same server. The second call to setup {}
will overwrite the first.Before reporting a bug, check your logs and the output of :LspInfo
. Add the following to your init.vim to enable logging:
vim.lsp.set_log_level("debug")
Attempt to run the language server, and open the log with:
:LspLog
Most of the time, the reason for failure is present in the logs.
:LspInfo
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>
Defaults to stopping all buffer clients.:LspRestart <client_id>
Defaults to restarting all buffer clients.See the wiki for additional topics, including:
If you are missing a language server on the list in server_configurations.md, contributing a new configuration for it helps others, especially if the server requires special setup. Follow these steps:
lua/lspconfig/server_configurations/SERVER_NAME.lua
.To publish a release:
Copyright Neovim contributors. All rights reserved.
nvim-lspconfig is licensed under the terms of the Apache 2.0 license.
See LICENSE.md