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 <aliou@users.noreply.github.com>
Co-authored-by: Justin M. Keyes <justinkz@gmail.com>

1 files changed, 68 insertions, 0 deletions

diff --git a/lsp/lua_ls.lua b/lsp/lua_ls.lua
new file mode 100644
index 00000000..b3bdbd76
--- /dev/null
+++ b/lsp/lua_ls.lua
@@ -0,0 +1,68 @@
+---@brief
+---
+---https://github.com/luals/lua-language-server
+--
+-- Lua language server.
+--
+-- `lua-language-server` can be installed by following the instructions [here](https://luals.github.io/#neovim-install).
+--
+-- The default `cmd` assumes that the `lua-language-server` binary can be found in `$PATH`.
+--
+-- If you primarily use `lua-language-server` for Neovim, and want to provide completions,
+-- analysis, and location handling for plugins on runtime path, you can use the following
+-- settings.
+--
+-- ```lua
+-- vim.lsp.config('lua_ls', {
+--   on_init = function(client)
+--     if client.workspace_folders then
+--       local path = client.workspace_folders[1].name
+--       if path ~= vim.fn.stdpath('config') and (vim.uv.fs_stat(path..'/.luarc.json') or vim.uv.fs_stat(path..'/.luarc.jsonc')) then
+--         return
+--       end
+--     end
+--
+--     client.config.settings.Lua = vim.tbl_deep_extend('force', client.config.settings.Lua, {
+--       runtime = {
+--         -- Tell the language server which version of Lua you're using
+--         -- (most likely LuaJIT in the case of Neovim)
+--         version = 'LuaJIT'
+--       },
+--       -- Make the server aware of Neovim runtime files
+--       workspace = {
+--         checkThirdParty = false,
+--         library = {
+--           vim.env.VIMRUNTIME
+--           -- Depending on the usage, you might want to add additional paths here.
+--           -- "${3rd}/luv/library"
+--           -- "${3rd}/busted/library",
+--         }
+--         -- or pull in all of 'runtimepath'. NOTE: this is a lot slower and will cause issues when working on your own configuration (see https://github.com/neovim/nvim-lspconfig/issues/3189)
+--         -- library = vim.api.nvim_get_runtime_file("", true)
+--       }
+--     })
+--   end,
+--   settings = {
+--     Lua = {}
+--   }
+-- })
+-- ```
+--
+-- See `lua-language-server`'s [documentation](https://luals.github.io/wiki/settings/) for an explanation of the above fields:
+-- * [Lua.runtime.path](https://luals.github.io/wiki/settings/#runtimepath)
+-- * [Lua.workspace.library](https://luals.github.io/wiki/settings/#workspacelibrary)
+--
+return {
+  cmd = { 'lua-language-server' },
+  filetypes = { 'lua' },
+  root_markers = {
+    '.luarc.json',
+    '.luarc.jsonc',
+    '.luacheckrc',
+    '.stylua.toml',
+    'stylua.toml',
+    'selene.toml',
+    'selene.yml',
+    '.git',
+  },
+}