summaryrefslogtreecommitdiff
path: root/start/lspconfig-0.1.3/lua/lspconfig/server_configurations/arduino_language_server.lua
blob: 72f48a1d19518edcae6d336ca2964d18905cae92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
local util = require 'lspconfig.util'

return {
  default_config = {
    cmd = { 'arduino-language-server' },
    filetypes = { 'arduino' },
    root_dir = util.root_pattern '*.ino',
  },
  docs = {
    description = [[
https://github.com/arduino/arduino-language-server

Language server for Arduino

The `arduino-language-server` can be installed by running:
	go get -u github.com/arduino/arduino-language-server

The `arduino-cli` tools must also be installed. Follow these instructions for your distro:
	https://arduino.github.io/arduino-cli/latest/installation/

After installing the `arduino-cli` tools, follow these instructions for generating
a configuration file:
	https://arduino.github.io/arduino-cli/latest/getting-started/#create-a-configuration-file
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` be installed. It will look for `clangd` by default but
the binary path can be overridden if need be.

After all dependencies are installed you'll need to override the lspconfig command for the
language server in your setup function with the necessary configurations:

```lua
lspconfig.arduino_language_server.setup({
	cmd =  {
		-- Required
		"arduino-language-server",
		"-cli-config", "/path/to/arduino-cli.yaml",
		-- Optional
		"-cli", "/path/to/arduino-cli",
		"-clangd", "/path/to/clangd"
	}
})
```

For further instruction about configuration options, run `arduino-language-server --help`.

]],
  },
}