Skip to content

Commit 38612d3

Browse files
committed
docs: deprecation info
1 parent 107c245 commit 38612d3

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,37 @@ configurations for various LSP servers. View [all configs](doc/configs.md) or `:
55

66
## Important ⚠️
77

8-
* These configs are **best-effort and supported by the community (you).** See [contributions](#contributions).
9-
* The configs live in [`lsp/`](./lsp/).
10-
* Upgrade to Nvim 0.11+ and use `vim.lsp.enable('…')` (not `require'lspconfig'.….setup{}`) to enable a config.
11-
* The configs in `lua/lspconfig/` are *deprecated* and will be removed.
12-
* Upgrade to Nvim 0.11+ and use `vim.lsp.enable('…')` (not `require'lspconfig'.….setup{}`) to enable a config.
8+
* nvim-lspconfig is 100% "data". Its `require('lspconfig')` module (the "framework") [is **deprecated**](https://github.com/neovim/nvim-lspconfig/issues/3693) in favor of `vim.lsp.config` (Nvim 0.11+).
9+
* The [lspconfig.lua](./lua/lspconfig.lua) *module* will be dropped. Calls to `require('lspconfig')` will show a warning, which will later become an error.
10+
* nvim-lspconfig itself is **NOT deprecated**. It contains all of the default configs.
11+
* The configs live in the [lsp/](./lsp/) directory of nvim-lspconfig. `vim.lsp.config` automatically finds them and merges them with any local `lsp/*.lua` configs defined by you or a plugin.
12+
* The old configs in `[lua/lspconfig/](./lua/lspconfig/)` are **deprecated** and will be removed.
13+
14+
### Migration instructions
15+
16+
1. Upgrade to Nvim 0.11+
17+
2. (Optional) Use `vim.lsp.config('…')` (not `require'lspconfig'.….setup{}`) to *customize* or *define* a config.
18+
3. Use `vim.lsp.enable('…')` (not `require'lspconfig'.….setup{}`) to *enable* a config, so that it activates for its `filetypes`.
19+
20+
## Support
21+
22+
These configs are **best-effort and supported by the community (you).** See [contributions](#contributions).
23+
1324
* Ask questions on [GitHub Discussions](https://github.com/neovim/neovim/discussions), not the issue tracker.
1425
* If you found a bug in Nvim LSP (`:help lsp`), [report it to Neovim core](https://github.com/neovim/neovim/issues/new?assignees=&labels=bug%2Clsp&template=lsp_bug_report.yml).
1526
* **Do not** report it here. Only configuration data lives here.
16-
* This repo only provides self-contained *configurations*. The `require'lspconfig'` "framework" is deprecated and will be removed.
17-
* The "framework" parts (*not* the configs) of nvim-lspconfig were upstreamed to Nvim core (`vim.lsp.config`).
1827

1928
## Install
2029

2130
[![LuaRocks](https://img.shields.io/luarocks/v/neovim/nvim-lspconfig?logo=lua&color=purple)](https://luarocks.org/modules/neovim/nvim-lspconfig)
2231

2332
* Requires Nvim 0.11.3+.
24-
* Support for Nvim 0.10 will be removed. Upgrade Nvim and nvim-lspconfig before reporting an issue.
33+
* Support for Nvim 0.10 [will be removed](https://github.com/neovim/nvim-lspconfig/issues/3693). Upgrade Nvim and nvim-lspconfig before reporting an issue.
2534
* Install nvim-lspconfig using Vim's "packages" feature:
2635
```
2736
git clone https://github.com/neovim/nvim-lspconfig ~/.config/nvim/pack/nvim/start/nvim-lspconfig
2837
```
29-
* Or if you have Nvim 0.12 (nightly), you can use the builtin `vim.pack` plugin manager:
38+
* Or with Nvim 0.12 (nightly), you can use the builtin `vim.pack` plugin manager:
3039
```lua
3140
vim.pack.add{
3241
{ src = 'https://github.com/neovim/nvim-lspconfig' },

0 commit comments

Comments
 (0)