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

diff --git a/lsp/arduino_language_server.lua b/lsp/arduino_language_server.lua
new file mode 100644
index 00000000..a40a7afb
--- /dev/null
+++ b/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,
+    },
+  },
+}