From 81a570f58b2113cc2d538efae743ad38d6ab564f Mon Sep 17 00:00:00 2001 From: Lorenzo Bellina <59364991+TheRealLorenz@users.noreply.github.com> Date: Sun, 13 Apr 2025 00:15:43 +0200 Subject: feat: migrate to vim.lsp.config #3659 Problem: Nvim 0.11 has vim.lsp.config, which mostly replaces the legacy nvim-lspconfig "framework". Solution: Migrate all configs to `lsp/*` variants. The old configs in `lua/lspconfig/` are "frozen". The new configs include these changes: - `commands` field became raw calls to `vim.api.nvim_buf_create_user_command` inside `on_attach`. - `root_dir` became: - `root_markers` whenever the file list was simple didn't need to mach `*` - if the logic was complicated, or needed to match something like '\*.c', it was defined as a vim.lsp.Config `root_dir` callback. - `on_config_change` became `before_init`. I don't actually know if this is the correct approach, but looking around the documentation of `nvim-lspconfig` a saw that it was defined as the function that gets called as soon as the config have `root_dir`, and so I thought `before_init` might be the closest alternative. - `docs.description` became a luadoc `@brief` docstring. - `single_file_support = false`? Co-authored-by: Aliou Diallo Co-authored-by: Justin M. Keyes --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 48 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f6e11432..240645d5 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,14 @@ View the [documentation for all configs](doc/configs.md) or `:help lspconfig-all ``` 2. Add the language server setup to your init.lua. ```lua + -- neovim < 0.11 require'lspconfig'.pyright.setup{} + -- neovim >= 0.11 + vim.lsp.enable('pyright') ``` + + > For more information see [`vim.lsp` support](#vim.lsp-support). + 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. @@ -45,7 +51,7 @@ View the [documentation for all configs](doc/configs.md) or `:help lspconfig-all 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()`. +For servers not on your `$PATH` (e.g., `jdtls`, `elixirls`), you must manually set the `cmd` parameter, see [configuration](#Configuration). ## Configuration @@ -79,18 +85,51 @@ See [`:h lsp-buf`][lsp-buf] for details on other LSP functions. [LspDetach]: https://neovim.io/doc/user/lsp.html#LspDetach [lsp-buf]: https://neovim.io/doc/user/lsp.html#lsp-buf -Additional configuration options can be provided for each LSP server by passing arguments to the `setup` function. See `:h lspconfig-setup` for details. Example: +Additional configuration options can be provided for each LSP server: + +- `neovim < 0.11` + + ```lua + local lspconfig = require('lspconfig') + lspconfig.rust_analyzer.setup { + -- Server-specific settings. See `:help lspconfig-setup` + settings = { + ['rust-analyzer'] = {}, + }, + } + ``` + +- `neovim >= 0.11` + + ```lua + vim.lsp.config('rust_analyzer', { + -- Server-specific settings. See `:help lspconfig-setup` + settings = { + ['rust-analyzer'] = {}, + }, + }) + ``` + > For more information see [`vim.lsp` support](#vim.lsp-support). + +## `vim.lsp` support + +`nvim-lspconfig` includes configurations compatible with `vim.lsp` under [`lsp/`](./lsp/), so servers can be enabled with: ```lua -local lspconfig = require('lspconfig') -lspconfig.rust_analyzer.setup { - -- Server-specific settings. See `:help lspconfig-setup` - settings = { - ['rust-analyzer'] = {}, - }, -} +vim.lsp.enable('pyright') ``` +and configured with: + +```lua +vim.lsp.config('pyright', {}) +``` + +which extends the configuration under [`lsp/`](./lsp/). For further information see [`:help lsp-config`][lsp-config]. + +> [!WARNING] +> Some servers are currently NOT supported and should be configured the old way, see `:help lspconfig-setup` + ## Troubleshooting The most common reasons a language server does not start or attach are: -- cgit v1.2.3-70-g09d2