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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
|
<p align="center">
<img src="https://user-images.githubusercontent.com/6705160/118490159-f064bb00-b71d-11eb-883e-4affbd020074.png" alt="nvim-lsp-installer" width="50%" />
</p>
- [About](#about)
- [Screenshots](#screenshots)
- [Requirements](#requirements)
- [Minimum requirements](#minimum-requirements)
- [Additional requirements](#additional-requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Setup](#setup)
- [Commands](#commands)
- [Configuration](#configuration)
- [Available LSPs](#available-lsps)
- [Logo](#logo)
- [Default configuration](#default-configuration)
## About
Neovim plugin that allow you to manage LSP servers (servers are installed inside `:echo stdpath("data")` by default).
It works in tandem with [`lspconfig`](https://github.com/neovim/nvim-lspconfig)<sup>1</sup> by registering a hook that
enhances the `PATH` environment variable, allowing neovim's LSP client to locate the server executable installed by
nvim-lsp-installer.<sup>2</sup>
On top of just providing commands for installing & uninstalling LSP servers, it:
- provides a graphical UI
- provides the ability to check for, and upgrade to, new server versions through a single interface
- supports installing custom versions of LSP servers (for example `:LspInstall rust_analyzer@nightly`)
- relaxes the minimum requirements by attempting multiple different utilities (for example, only one of `wget`, `curl`, or `Invoke-WebRequest` is required for HTTP requests)
- hosts [a suite of system tests](https://github.com/williamboman/nvim-lspconfig-test) for all supported servers
- has full support for Windows <img src="https://user-images.githubusercontent.com/6705160/131256603-cacf7f66-dfa9-4515-8ae4-0e42d08cfc6a.png" height="20">
<sup>1 - while lspconfig is the main target, this plugin may also be used for other use cases</sup>
<br>
<sup>2 - some servers don't provide an executable, in which case the full command to spawn the server is provided instead</sup>
## Screenshots
| | | |
| :----------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: |
| <img src="https://user-images.githubusercontent.com/6705160/150685720-782e33ba-172c-44b6-8558-fb4e98495294.png" /> | <img src="https://user-images.githubusercontent.com/6705160/150685404-2cd34b25-166e-4c84-b9dd-1d5580dc2bdd.png" /> | <img src="https://user-images.githubusercontent.com/6705160/150685322-a537f021-5850-4bbc-8be2-1ece5678d205.png" /> |
| <img src="https://user-images.githubusercontent.com/6705160/150685324-1310ae7d-67bf-4053-872c-d27e8a4c4b80.png" /> | <img src="https://user-images.githubusercontent.com/6705160/150686052-fd5c4d54-b4da-4cb3-bb82-a094526ee5b5.png" /> | <img src="https://user-images.githubusercontent.com/6705160/150686059-f1be8131-1274-4f62-9aa8-345599cbd8bc.png" /> |
## Requirements
Requires neovim `>= 0.7.0` and [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
### Minimum requirements
The minimum recommended requirements are:
- For Unix systems: git(1), curl(1) or wget(1), unzip(1), tar(1), gzip(1)
- For Windows systems: powershell, git, tar, and [7zip][7zip] or [peazip][peazip] or [archiver][archiver] or [winzip][winzip] or [WinRAR][winrar]
### Additional requirements
Additional requirements to install & run all servers are (depending on usage):
- Node.js (LTS) & npm
- Python3 & pip3
- go >= 1.17
- cargo
- Ruby & gem
- PHP & Composer
- JDK
- Julia
- dotnet
- ghcup
- luarocks
- meson
- ninja
- pwsh
- rebar3
- valac
[7zip]: https://www.7-zip.org/
[archiver]: https://github.com/mholt/archiver
[peazip]: https://peazip.github.io/
[winzip]: https://www.winzip.com/
[winrar]: https://www.win-rar.com/
## Installation
### [Packer](https://github.com/wbthomason/packer.nvim)
```lua
use {
"williamboman/nvim-lsp-installer",
"neovim/nvim-lspconfig",
}
```
### vim-plug
```vim
Plug "williamboman/nvim-lsp-installer"
Plug "neovim/nvim-lspconfig"
```
## Usage
### Setup
In order for nvim-lsp-installer to register the necessary hooks at the right moment, **make sure you call the `.setup()`
function before you set up any servers with `lspconfig`**!
```lua
require("nvim-lsp-installer").setup {}
```
<details>
<summary>
ℹ️ Important if you use packer.nvim! (click to expand)
</summary>
<br />
> You need to make sure that the setup for nvim-lsp-installer executes _before_ your setup for lspconfig.
> There are different ways of achieving this, for example by using the `after` directive:
```lua
use {
{
"williamboman/nvim-lsp-installer",
config = function ()
require("nvim-lsp-installer").setup {}
end
},
{
"neovim/nvim-lspconfig",
after = "nvim-lsp-installer",
config = function()
local lspconfig = require("lspconfig")
lspconfig.sumneko_lua.setup {}
--- ...
end
}
}
```
</details>
Refer to the [Configuration](#configuration) section for information about which settings are available.
### Commands
- `:LspInstallInfo` - opens a graphical overview of your language servers
- `:LspInstall [--sync] [server] ...` - installs/reinstalls language servers. Runs in a blocking fashion if the `--sync` argument is passed (only recommended for scripting purposes).
- `:LspUninstall [--sync] <server> ...` - uninstalls language servers. Runs in a blocking fashion if the `--sync` argument is passed (only recommended for scripting purposes).
- `:LspUninstallAll [--no-confirm]` - uninstalls all language servers
- `:LspInstallLog` - opens the log file in a new tab window
- `:LspPrintInstalled` - prints all installed language servers
### Configuration
You may optionally configure certain behavior of nvim-lsp-installer when calling the `.setup()` function.
Refer to the [default configuration](#default-configuration) for all available settings.
Example:
```lua
require("nvim-lsp-installer").setup({
automatic_installation = true, -- automatically detect which servers to install (based on which servers are set up via lspconfig)
ui = {
icons = {
server_installed = "✓",
server_pending = "➜",
server_uninstalled = "✗"
}
}
})
```
## Available LSPs
| Language | Server name |
| ----------------------------------- | -------------------------- |
| AWK | `awk_ls` |
| Angular | `angularls` |
| Ansible | `ansiblels` |
| Apex | `apex_ls` |
| Arduino [(docs!!!)][arduino] | `arduino_language_server` |
| Assembly (GAS/NASM, GO) | `asm_lsp` |
| Astro | `astro` |
| Bash | `bashls` |
| Beancount | `beancount` |
| Bicep | `bicep` |
| C | `ccls` |
| C | `clangd` |
| C# | `csharp_ls` |
| C# [(docs)][omnisharp] | `omnisharp` |
| C++ | `ccls` |
| C++ | `clangd` |
| CMake | `cmake` |
| CSS | `cssls` |
| CSS | `cssmodules_ls` |
| Clarity | `clarity_lsp` |
| Clojure | `clojure_lsp` |
| CodeQL | `codeqlls` |
| Crystal | `crystalline` |
| Crystal | `scry` |
| Cucumber | `cucumber_language_server` |
| Dart | `dartls` |
| Deno | `denols` |
| Dhall | `dhall_lsp_server` |
| Diagnostic (general purpose server) | `diagnosticls` |
| Dlang | `serve_d` |
| Docker | `dockerls` |
| Dot | `dotls` |
| EFM (general purpose server) | `efm` |
| ESLint [(docs)][eslint] | `eslint` |
| Elixir | `elixirls` |
| Elm | `elmls` |
| Ember | `ember` |
| Emmet | `emmet_ls` |
| Erlang | `erlangls` |
| F# | `fsautocomplete` |
| Flux | `flux_lsp` |
| Foam (OpenFOAM) | `foam_ls` |
| Fortran | `fortls` |
| Go | `golangci_lint_ls` |
| Go | `gopls` |
| Grammarly | `grammarly` |
| GraphQL | `graphql` |
| Groovy | `groovyls` |
| HTML | `html` |
| Haskell | `hls` |
| Haxe | `haxe_language_server` |
| Hoon | `hoon_ls` |
| JSON | `jsonls` |
| Java | `jdtls` |
| JavaScript | `quick_lint_js` |
| JavaScript | `tsserver` |
| Jsonnet | `jsonnet_ls` |
| Julia [(docs)][julials] | `julials` |
| Kotlin | `kotlin_language_server` |
| LaTeX | `ltex` |
| LaTeX | `texlab` |
| Lelwel | `lelwel_ls` |
| Lua | `sumneko_lua` |
| Markdown | `marksman` |
| Markdown | `prosemd_lsp` |
| Markdown | `remark_ls` |
| Markdown | `zk` |
| Metamath Zero | `mm0_ls` |
| Nickel | `nickel_ls` |
| Nim | `nimls` |
| OCaml | `ocamlls` |
| OCaml | `ocamllsp` |
| Objective C | `ccls` |
| OneScript, 1C:Enterprise | `bsl_ls` |
| OpenCL | `opencl_ls` |
| PHP | `intelephense` |
| PHP | `phpactor` |
| PHP | `psalm` |
| Perl | `perlnavigator` |
| Powershell | `powershell_es` |
| Prisma | `prismals` |
| Puppet | `puppet` |
| PureScript | `purescriptls` |
| Python | `jedi_language_server` |
| Python | `pyright` |
| Python | `sourcery` |
| Python [(docs)][pylsp] | `pylsp` |
| R | `r_language_server` |
| ReScript | `rescriptls` |
| Reason | `reason_ls` |
| Robot Framework | `robotframework_ls` |
| Rome | `rome` |
| Ruby | `solargraph` |
| Rust | `rust_analyzer` |
| SQL | `sqlls` |
| SQL | `sqls` |
| Salt | `salt_ls` |
| Shopify Theme Check | `theme_check` |
| Slint | `slint_lsp` |
| Solidity | `solang` |
| Solidity | `solc` |
| Solidity (VSCode) | `solidity_ls` |
| Sorbet | `sorbet` |
| Sphinx | `esbonio` |
| Stylelint | `stylelint_lsp` |
| Svelte | `svelte` |
| Swift | `sourcekit` |
| SystemVerilog | `svls` |
| SystemVerilog | `verible` |
| TOML | `taplo` |
| Tailwind CSS | `tailwindcss` |
| Teal | `teal_ls` |
| Terraform | `terraformls` |
| Terraform [(docs)][tflint] | `tflint` |
| TypeScript | `tsserver` |
| V | `vls` |
| Vala | `vala_ls` |
| VimL | `vimls` |
| Visualforce | `visualforce` |
| Vue | `volar` |
| Vue | `vuels` |
| XML | `lemminx` |
| YAML | `yamlls` |
| Zig | `zls` |
[arduino]: ./lua/nvim-lsp-installer/servers/arduino_language_server/README.md
[eslint]: ./lua/nvim-lsp-installer/servers/eslint/README.md
[julials]: ./lua/nvim-lsp-installer/servers/julials/README.md
[omnisharp]: ./lua/nvim-lsp-installer/servers/omnisharp/README.md
[pylsp]: ./lua/nvim-lsp-installer/servers/pylsp/README.md
[tflint]: ./lua/nvim-lsp-installer/servers/tflint/README.md
## Logo
Illustrations in the logo are derived from [@Kaligule](https://schauderbasis.de/)'s "Robots" collection.
## Default configuration
```lua
local DEFAULT_SETTINGS = {
-- A list of servers to automatically install if they're not already installed. Example: { "rust_analyzer", "sumneko_lua" }
-- This setting has no relation with the `automatic_installation` setting.
ensure_installed = {},
-- Whether servers that are set up (via lspconfig) should be automatically installed if they're not already installed.
-- This setting has no relation with the `ensure_installed` setting.
-- Can either be:
-- - false: Servers are not automatically installed.
-- - true: All servers set up via lspconfig are automatically installed.
-- - { exclude: string[] }: All servers set up via lspconfig, except the ones provided in the list, are automatically installed.
-- Example: automatic_installation = { exclude = { "rust_analyzer", "solargraph" } }
automatic_installation = false,
ui = {
-- Whether to automatically check for outdated servers when opening the UI window.
check_outdated_servers_on_open = true,
-- The border to use for the UI window. Accepts same border values as |nvim_open_win()|.
border = "none",
icons = {
-- The list icon to use for installed servers.
server_installed = "◍",
-- The list icon to use for servers that are pending installation.
server_pending = "◍",
-- The list icon to use for servers that are not installed.
server_uninstalled = "◍",
},
keymaps = {
-- Keymap to expand a server in the UI
toggle_server_expand = "<CR>",
-- Keymap to install the server under the current cursor position
install_server = "i",
-- Keymap to reinstall/update the server under the current cursor position
update_server = "u",
-- Keymap to check for new version for the server under the current cursor position
check_server_version = "c",
-- Keymap to update all installed servers
update_all_servers = "U",
-- Keymap to check which installed servers are outdated
check_outdated_servers = "C",
-- Keymap to uninstall a server
uninstall_server = "X",
},
},
-- The directory in which to install all servers.
install_root_dir = path.concat { vim.fn.stdpath "data", "lsp_servers" },
pip = {
-- These args will be added to `pip install` calls. Note that setting extra args might impact intended behavior
-- and is not recommended.
--
-- Example: { "--proxy", "https://proxyserver" }
install_args = {},
},
-- Controls to which degree logs are written to the log file. It's useful to set this to vim.log.levels.DEBUG when
-- debugging issues with server installations.
log_level = vim.log.levels.INFO,
-- Limit for the maximum amount of servers to be installed at the same time. Once this limit is reached, any further
-- servers that are requested to be installed will be put in a queue.
max_concurrent_installers = 4,
github = {
-- The template URL to use when downloading assets from GitHub.
-- The placeholders are the following (in order):
-- 1. The repository (e.g. "rust-lang/rust-analyzer")
-- 2. The release version (e.g. "v0.3.0")
-- 3. The asset name (e.g. "rust-analyzer-v0.3.0-x86_64-unknown-linux-gnu.tar.gz")
download_url_template = "https://github.com/%s/releases/download/%s/%s",
},
}
```
|
