GitHub - neovim/nvim-lspconfig: Quickstart configs for Nvim LSP (original) (raw)

nvim-lspconfig

nvim-lspconfig is a "data only" repo, providing basic, default Nvim LSP clientconfigurations for various LSP servers. View all configs or :help lspconfig-all from Nvim.

Important ⚠️

These configs are best-effort and supported by the community (you). See contributions.
Ask questions on GitHub Discussions, not the issue tracker.
If you found a bug in Nvim LSP (:help lsp), report it to Neovim core.
- Do not report it here. Only configuration data lives here.
This repo only provides configurations. Its programmatic API is deprecated and must not be used externally.
- The "framework" parts (not the configs) of nvim-lspconfig will be upstreamed to Nvim core.

Install

Requires Nvim 0.10 above. Update Nvim and nvim-lspconfig before reporting an issue.
Install nvim-lspconfig using Vim's "packages" feature:

git clone https://github.com/neovim/nvim-lspconfig ~/.config/nvim/pack/nvim/start/nvim-lspconfig

Or use a 3rd-party plugin manager (consult the documentation for your plugin manager).

Quickstart

Install a language server, e.g. pyright
Add the language server setup to your init.lua.
- Nvim 0.11+ (see vim.lsp.config)
  vim.lsp.enable('pyright')
- Nvim 0.10 (legacy, not supported)
  require'lspconfig'.pyright.setup{}
Ensure your project/workspace contains a root marker as specified in :help lspconfig-all.
Open a code file in Nvim. LSP will attach and provide diagnostics.
Run :checkhealth lsp to see the status or to troubleshoot.

Read :help lspconfig for details. Read :help lspconfig-all for the full list of server-specific details. For servers not on your $PATH (e.g., jdtls, elixirls), you must manually set the cmd parameter, see vim.lsp.config.

Configuration

Nvim sets some default options and mappings when a buffer attaches to LSP (see :help lsp-config). In particular:

'tagfunc'
- Enables "go to definition" capabilities using <C-]> and other tag commands.
'omnifunc'
- Enables (manual) omni mode completion with <C-X><C-O> in Insert mode. For _auto_completion, an autocompletion plugin is required.
'formatexpr'
- Enables LSP formatting with gq.
K maps to vim.lsp.buf.hover() in Normal mode.
[d and ]d map to vim.diagnostic.jump() with {count=-1} andvim.diagnostic.jump() with {count=1}, 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.

Extra settings can be specified for each LSP server:

Nvim 0.11+ (see vim.lsp.config)
vim.lsp.config('rust_analyzer', {
-- Server-specific settings. See :help lsp-quickstart
settings = {
['rust-analyzer'] = {},
},
})
Nvim 0.10 (legacy, not supported)
local lspconfig = require('lspconfig')
lspconfig.rust_analyzer.setup {
-- Server-specific settings. See :help lspconfig-setup
settings = {
['rust-analyzer'] = {},
},
}

vim.lsp.config

nvim-lspconfig includes configurations compatible with vim.lsp under lsp/, so servers can be enabled (auto-activated when a filetype is opened) with:

vim.lsp.enable('pyright')

and configured with:

vim.lsp.config('pyright', { cmd = { … }, })

which extends the configuration under lsp/. For further information see :help lsp-config.

Troubleshooting

The most common reasons a language server does not start or attach are:

Language server is not installed. nvim-lspconfig does not install language servers for you. You should be able to run the 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.
Missing filetype plugins. Certain languages are not detected by Vim/Nvim because they have not yet been added to the filetype detection system. Ensure :set filetype? shows the filetype and not an empty value.
Not triggering root detection. Some language servers require a "workspace", which is found by looking for an ancestor directory that contains a "root marker". The most common root marker is .git/, but each config defines other "root marker" names. Root markers/directories are listed in doc/configs.md.

Bug reports

If you found a bug with LSP functionality, report it to Neovim core.

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:

Most of the time, the reason for failure is present in the logs.

Commands

: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.
: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
:LspRestart [<client_id_or_name> ...] Restarts the given client(s), and attempts to reattach to all previously attached buffers.

Contributions

If a language server is missing from configs.md, contributing a new configuration for it helps others, especially if the server requires special setup. Follow these steps:

Read CONTRIBUTING.md.
Create a new file at lsp/SERVER_NAME.lua.
- Copy an existing configto get started. Most configs are simple. For an extensive example seetexlab.lua.
Ask questions on GitHub Discussions or in the Neovim Matrix room.

Release process

To publish a release:

Create and push a new tag.
After pushing the tag, a GitHub actionwill automatically package the plugin and publish the release to LuaRocks.

License

nvim-lspconfig is licensed under the terms of the Apache 2.0 license.

See LICENSE.md