Neovim 0.11 migration

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:

lsp/ada_ls.lua

@@ -0,0 +1,29 @@
+local util = require 'lspconfig.util'
+
+---@brief
+---
+---https://github.com/AdaCore/ada_language_server
+--
+-- Installation instructions can be found [here](https://github.com/AdaCore/ada_language_server#Install).
+--
+-- Workspace-specific [settings](https://github.com/AdaCore/ada_language_server/blob/master/doc/settings.md) such as `projectFile` can be provided in a `.als.json` file at the root of the workspace.
+-- Alternatively, configuration may be passed as a "settings" object to `vim.lsp.config('ada_ls', {})`:
+--
+-- ```lua
+-- vim.lsp.config('ada_ls', {
+--     settings = {
+--       ada = {
+--         projectFile = "project.gpr";
+--         scenarioVariables = { ... };
+--       }
+--     }
+-- })
+-- ```
+return {
+  cmd = { 'ada_language_server' },
+  filetypes = { 'ada' },
+  root_dir = function(bufnr, on_dir)
+    local fname = vim.api.nvim_buf_get_name(bufnr)
+    on_dir(util.root_pattern('Makefile', '.git', 'alire.toml', '*.gpr', '*.adc')(fname))
+  end,
+}

lsp/agda_ls.lua

@@ -0,0 +1,15 @@
+local util = require 'lspconfig.util'
+
+---@brief
+---
+---https://github.com/agda/agda-language-server
+--
+-- Language Server for Agda.
+return {
+  cmd = { 'als' },
+  filetypes = { 'agda' },
+  root_dir = function(bufnr, on_dir)
+    local fname = vim.api.nvim_buf_get_name(bufnr)
+    on_dir(util.root_pattern('.git', '*.agda-lib')(fname))
+  end,
+}

lsp/aiken.lua

@@ -0,0 +1,13 @@
+---@brief
+---
+---https://github.com/aiken-lang/aiken
+--
+-- A language server for Aiken Programming Language.
+-- [Installation](https://aiken-lang.org/installation-instructions)
+--
+-- It can be i
+return {
+  cmd = { 'aiken', 'lsp' },
+  filetypes = { 'aiken' },
+  root_markers = { 'aiken.toml', '.git' },
+}

lsp/air.lua

@@ -0,0 +1,12 @@
+---@brief
+---
+---https://github.com/posit-dev/air
+--
+-- Air is an R formatter and language server, written in Rust.
+--
+-- Refer to the [documentation](https://posit-dev.github.io/air/editors.html) for more details.
+return {
+  cmd = { 'air', 'language-server' },
+  filetypes = { 'r' },
+  root_markers = { 'air.toml', '.air.toml', '.git' },
+}

lsp/alloy_ls.lua

@@ -0,0 +1,28 @@
+---@brief
+---
+---https://github.com/AlloyTools/org.alloytools.alloy
+--
+-- Alloy is a formal specification language for describing structures and a tool for exploring them.
+--
+-- You may also need to configure the filetype for Alloy (*.als) files:
+--
+-- ```
+-- autocmd BufNewFile,BufRead *.als set filetype=alloy
+-- ```
+--
+-- or
+--
+-- ```lua
+-- vim.filetype.add({
+--   pattern = {
+--     ['.*/*.als'] = 'alloy',
+--   },
+-- })
+-- ```
+--
+-- Alternatively, you may use a syntax plugin like https://github.com/runoshun/vim-alloy.
+return {
+  cmd = { 'alloy', 'lsp' },
+  filetypes = { 'alloy' },
+  root_markers = { '.git' },
+}

lsp/anakin_language_server.lua

@@ -0,0 +1,69 @@
+---@brief
+---
+---https://pypi.org/project/anakin-language-server/
+--
+-- `anakin-language-server` is yet another Jedi Python language server.
+--
+-- Available options:
+--
+-- * Initialization: https://github.com/muffinmad/anakin-language-server#initialization-option
+-- * Configuration: https://github.com/muffinmad/anakin-language-server#configuration-options
+return {
+  cmd = { 'anakinls' },
+  filetypes = { 'python' },
+  root_markers = {
+    'pyproject.toml',
+    'setup.py',
+    'setup.cfg',
+    'requirements.txt',
+    'Pipfile',
+    '.git',
+  },
+  settings = {
+    anakinls = {
+      pyflakes_errors = {
+        -- Full list: https://github.com/PyCQA/pyflakes/blob/master/pyflakes/messages.py
+
+        'ImportStarNotPermitted',
+
+        'UndefinedExport',
+        'UndefinedLocal',
+        'UndefinedName',
+
+        'DuplicateArgument',
+        'MultiValueRepeatedKeyLiteral',
+        'MultiValueRepeatedKeyVariable',
+
+        'FutureFeatureNotDefined',
+        'LateFutureImport',
+
+        'ReturnOutsideFunction',
+        'YieldOutsideFunction',
+        'ContinueOutsideLoop',
+        'BreakOutsideLoop',
+
+        'TwoStarredExpressions',
+        'TooManyExpressionsInStarredAssignment',
+
+        'ForwardAnnotationSyntaxError',
+        'RaiseNotImplemented',
+
+        'StringDotFormatExtraPositionalArguments',
+        'StringDotFormatExtraNamedArguments',
+        'StringDotFormatMissingArgument',
+        'StringDotFormatMixingAutomatic',
+        'StringDotFormatInvalidFormat',
+
+        'PercentFormatInvalidFormat',
+        'PercentFormatMixedPositionalAndNamed',
+        'PercentFormatUnsupportedFormat',
+        'PercentFormatPositionalCountMismatch',
+        'PercentFormatExtraNamedArguments',
+        'PercentFormatMissingArgument',
+        'PercentFormatExpectedMapping',
+        'PercentFormatExpectedSequence',
+        'PercentFormatStarRequiresSequence',
+      },
+    },
+  },
+}

lsp/ansiblels.lua

@@ -0,0 +1,36 @@
+---@brief
+---
+---https://github.com/ansible/vscode-ansible
+--
+-- Language server for the ansible configuration management tool.
+--
+-- `ansible-language-server` can be installed via `npm`:
+--
+-- ```sh
+-- npm install -g @ansible/ansible-language-server
+-- ```
+return {
+  cmd = { 'ansible-language-server', '--stdio' },
+  settings = {
+    ansible = {
+      python = {
+        interpreterPath = 'python',
+      },
+      ansible = {
+        path = 'ansible',
+      },
+      executionEnvironment = {
+        enabled = false,
+      },
+      validation = {
+        enabled = true,
+        lint = {
+          enabled = true,
+          path = 'ansible-lint',
+        },
+      },
+    },
+  },
+  filetypes = { 'yaml.ansible' },
+  root_markers = { 'ansible.cfg', '.ansible-lint' },
+}

lsp/antlersls.lua

@@ -0,0 +1,13 @@
+---@brief
+---
+---https://www.npmjs.com/package/antlers-language-server
+--
+-- `antlersls` can be installed via `npm`:
+-- ```sh
+-- npm install -g antlers-language-server
+-- ```
+return {
+  cmd = { 'antlersls', '--stdio' },
+  filetypes = { 'html', 'antlers' },
+  root_markers = { 'composer.json' },
+}

lsp/arduino_language_server.lua

@@ -0,0 +1,89 @@
+local util = require 'lspconfig.util'
+
+---@brief
+---
+---https://github.com/arduino/arduino-language-server
+--
+-- Language server for Arduino
+--
+-- The `arduino-language-server` can be installed by running:
+--
+-- ```
+-- go install github.com/arduino/arduino-language-server@latest
+-- ```
+--
+-- The `arduino-cli` tool must also be installed. Follow [these
+-- installation instructions](https://arduino.github.io/arduino-cli/latest/installation/) for
+-- your platform.
+--
+-- After installing `arduino-cli`, follow [these
+-- instructions](https://arduino.github.io/arduino-cli/latest/getting-started/#create-a-configuration-file)
+-- for generating a configuration file if you haven't done so already, and make
+-- sure you [install any relevant platforms
+-- libraries](https://arduino.github.io/arduino-cli/latest/getting-started/#install-the-core-for-your-board).
+--
+-- The language server also requires `clangd` to be installed. Follow [these
+-- installation instructions](https://clangd.llvm.org/installation) for your
+-- platform.
+--
+-- If you don't have a sketch yet create one.
+--
+-- ```sh
+-- $ arduino-cli sketch new test
+-- $ cd test
+-- ```
+--
+-- You will need a `sketch.yaml` file in order for the language server to understand your project. It will also save you passing options to `arduino-cli` each time you compile or upload a file. You can generate the file by using the following commands.
+--
+--
+-- First gather some information about your board. Make sure your board is connected and run the following:
+--
+-- ```sh
+-- $ arduino-cli board list
+-- Port         Protocol Type              Board Name  FQBN            Core
+-- /dev/ttyACM0 serial   Serial Port (USB) Arduino Uno arduino:avr:uno arduino:avr
+-- ```
+--
+-- Then generate the file:
+--
+-- ```sh
+-- arduino-cli board attach -p /dev/ttyACM0 -b arduino:avr:uno test.ino
+-- ```
+--
+-- The resulting file should look like this:
+--
+-- ```yaml
+-- default_fqbn: arduino:avr:uno
+-- default_port: /dev/ttyACM0
+-- ```
+--
+-- Your folder structure should look like this:
+--
+-- ```
+-- .
+-- ├── test.ino
+-- └── sketch.yaml
+-- ```
+--
+-- For further instructions about configuration options, run `arduino-language-server --help`.
+--
+-- Note that an upstream bug makes keywords in some cases become undefined by the language server.
+-- Ref: https://github.com/arduino/arduino-ide/issues/159
+return {
+  filetypes = { 'arduino' },
+  root_dir = function(bufnr, on_dir)
+    local fname = vim.api.nvim_buf_get_name(bufnr)
+    on_dir(util.root_pattern('*.ino')(fname))
+  end,
+  cmd = {
+    'arduino-language-server',
+  },
+  capabilities = {
+    textDocument = {
+      semanticTokens = vim.NIL,
+    },
+    workspace = {
+      semanticTokens = vim.NIL,
+    },
+  },
+}