Skip to content

Latest commit

 

History

History
156 lines (117 loc) · 8.01 KB

README.md

File metadata and controls

156 lines (117 loc) · 8.01 KB
Raw

nvim-lspconfig

nvim-lspconfig is a "data only" repo, providing basic, default Nvim LSP client configurations for various LSP servers.

View the documentation for all configs or :help lspconfig-all from Nvim.

Important ⚠️

  • If you found a bug in the Nvim LSP functionality (:help lsp), report it to Neovim core.
    • Do not report it here. Only configuration data lives here.
  • These configs are best-effort and supported by the community. See contributions.
  • Note: This repo only provides configurations. Its programmatic API is deprecated and should not be used externally.
    • Work is planned to selectively upstream the "framework" parts (not the configs) of nvim-lspconfig, to Nvim core, and deprecate them in nvim-lspconfig.

Install

LuaRocks

  • Requires Nvim 0.9 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

  1. Install a language server, e.g. pyright 
    npm i -g pyright
  2. Add the language server setup to your init.lua. 
    require'lspconfig'.pyright.setup{}
  3. Ensure your project/workspace contains a root marker which matches the server requirements specified in :help lspconfig-all.
  4. Open a code file in Nvim. LSP will attach and provide diagnostics. 
    nvim main.py
  5. 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 when calling setup().

Configuration

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

  • 'tagfunc'
  • 'omnifunc'
    • Enables (manual) omni mode completion with <C-X><C-O> in Insert mode. For autocompletion, 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.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'] = {},
  },
}

Troubleshooting

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

  1. 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.
  2. Missing filetype plugins. Certain languages are not detecting by Vim/Nvim because they have not yet been added to the filetype detection system. Ensure :set ft? shows the filetype and not an empty value.
  3. Not triggering root detection. Some language servers will only start if it is opened in a directory, or child directory, containing a file which signals the root of the project. Most of the time, this is a .git folder, but each server defines the root config in the lua file. See doc/configs.md or the source for the list of root directories.
  4. You must pass capabilities for each setup {} if you want these to take effect.
  5. Do not call setup {} twice for the same server. The second call to setup {} will overwrite the first.

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:

:LspLog

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.
  • :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
  • :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:

  1. Read CONTRIBUTING.md.
  2. Create a new file at lua/lspconfig/configs/SERVER_NAME.lua.
  3. 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 action will automatically package the plugin and publish the release to LuaRocks.

License

Copyright Neovim contributors. All rights reserved.

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

See LICENSE.md