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, 49 insertions, 0 deletions

diff --git a/lsp/esbonio.lua b/lsp/esbonio.lua
new file mode 100644
index 00000000..55d428c2
--- /dev/null
+++ b/lsp/esbonio.lua
@@ -0,0 +1,49 @@
+---@brief
+---
+---https://github.com/swyddfa/esbonio
+--
+-- Esbonio is a language server for [Sphinx](https://www.sphinx-doc.org/en/master/) documentation projects.
+-- The language server can be installed via pip
+--
+-- ```
+-- pip install esbonio
+-- ```
+--
+-- Since Sphinx is highly extensible you will get best results if you install the language server in the same
+-- Python environment as the one used to build your documentation. To ensure that the correct Python environment
+-- is picked up, you can either launch `nvim` with the correct environment activated.
+--
+-- ```
+-- source env/bin/activate
+-- nvim
+-- ```
+--
+-- Or you can modify the default `cmd` to include the full path to the Python interpreter.
+--
+-- ```lua
+-- vim.lsp.config('esbonio', {
+--   cmd = { '/path/to/virtualenv/bin/python', '-m', 'esbonio' }
+-- })
+-- ```
+--
+-- Esbonio supports a number of config values passed as `init_options` on startup, for example.
+--
+-- ```lua
+-- vim.lsp.config('esbonio', {
+--   init_options = {
+--     server = {
+--       logLevel = "debug"
+--     },
+--     sphinx = {
+--       confDir = "/path/to/docs",
+--       srcDir = "${confDir}/../docs-src"
+--     }
+-- })
+-- ```
+--
+-- A full list and explanation of the available options can be found [here](https://docs.esbon.io/en/esbonio-language-server-v0.16.4/lsp/getting-started.html?editor=neovim-lspconfig#configuration)
+return {
+  cmd = { 'python3', '-m', 'esbonio' },
+  filetypes = { 'rst' },
+  root_markers = { '.git' },
+}