Migrate to vim.lsp.config (non-breaking)

[justinmk]

Description

With vim.lsp.config neovim/neovim#31031 , Nvim 0.11+ now has an interface for defining LSP configs. Previously, the config format was defined by nvim-lspconfig (this repo) and did not have core Nvim support.

Migration plan

✅ Phase 1: Nvim 0.11 users can use these configs via vim.lsp.config

1. Create lsp/*.lua configs (in this repo) that simply wrap the existing lua/lspconfig/configs/*.lua configs.
   • Ignore root_dir? Copy-paste filenames into root_markers?
2. Upstream relevant parts of the healthcheck.
   • On Nvim 0.11 lspconfig/health.lua should do nothing (or error). On Nvim 0.10 it will continue to work.
3. Nvim 0.11+ can use nvim-lspconfigs like this:

   vim.lsp.config('foo')

4. Nvim 0.11+ users no longer need to (directly) call require('lspconfig') for any reason.

✅ Phase 2: migrate the actual config code

1. Tag a v1.x release.
2. BREAKING: The master branch will require Nvim 0.11 and will throw an error if vim.lsp.config is not found (and point the user to the v1.x branch).
3. Keep the old configs on master, but document that they are frozen and won't be supported.
4. If Nvim 0.10 or older is detected, use the old frozen configs
5. Update the README to mention that old configs are frozen.
6. Copy all configs to lsp/*.lua and port them to vim.lsp.config
   • Port commands to on_attach (example).
   • Port docs to LuaLS docstrings?

[justinmk]

Alternative non-breaking approach:

1. keep the old configs on master, and use them for Nvim 0.10 or older
2. put all the new configs on lsp/* and use those for Nvim 0.11

[justinmk]

idea from @lewis6991 :

I'm pretty sure that lsp/clangd.lua just needs to contain:

vim.lsp.config('clangd', require('lspconfig.configs.clangd').default_config)

We might need some adapter in between for some places, but I think this method will be much less work than just freezing the whole thing.

E..g root_dir is provided as a function instead of root_markers, which tbh core should support.

counterpoint:

default_config in lspconfig contains the commands stuff that are user commands instead of lsp commands, so some kind of adapter will be needed

[PeterCardenas]

one thing that was nice about this repo was that it allowed me to get notifs on what cool new lsps were coming out. i'd definitely prefer removing another bulky plugin and some hacky logic in my config due to the nature of this plugin, but wondering if we can somehow keep this lsp list in some way

[justinmk]

@PeterCardenas this repo isn't going away. Only its "framework" or API was lifted into core. 80% of the configs (the less popular/important ones) likely will continue to live here.

But in any case, there are many other projects that do the same kind of thing, for emacs, "awesome", etc., if your goal is to find new lsps.

[PeterCardenas]

that's good to hear, the reason why i liked this repo as a source of info is because the setup was very clear (just needed to add any additional lsp settings). what would be nice is that this repo can exist for the purpose of importing default lsp configs to be used by vim.lsp.config

[justinmk]

Is there a vim.lsp.config equivalent of single_file_support?

@frangio see

• fix(lsp): reuse client if configs match and no root dir neovim#31565
• feat(lsp): add workspace_required to lsp.config neovim#31824