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
|
[](https://github.com/williamboman/mason-lspconfig.nvim/actions?query=workflow%3ATests+branch%3Amain+event%3Apush)
[](https://github.com/sponsors/williamboman)
# mason-lspconfig.nvim
<p align="center">
<code>mason-lspconfig</code> bridges <a
href="https://github.com/williamboman/mason.nvim"><code>mason.nvim</code></a> with the <a
href="https://github.com/neovim/nvim-lspconfig"><code>lspconfig</code></a> plugin - making it easier to use both
plugins together.
</p>
<p align="center">
<code>:help mason-lspconfig.nvim</code>
</p>
<p align="center">
<sup>Latest version: v1.28.0</sup> <!-- x-release-please-version -->
</p>
# Table of Contents
- [Introduction](#introduction)
- [Requirements](#requirements)
- [Installation](#installation)
- [Setup](#setup)
- [Automatic server setup (advanced feature)](#automatic-server-setup-advanced-feature)
- [Commands](#commands)
- [Configuration](#configuration)
- [Default configuration](#default-configuration)
- [Available LSP servers](#available-lsp-servers)
# Introduction
> `:h mason-lspconfig-introduction`
`mason-lspconfig.nvim` closes some gaps that exist between `mason.nvim` and `lspconfig`. Its main responsibilities are to:
- register a setup hook with `lspconfig` that ensures servers installed with `mason.nvim` are set up with the necessary
configuration
- provide extra convenience APIs such as the `:LspInstall` command
- allow you to (i) automatically install, and (ii) automatically set up a predefined list of servers
- translate between `lspconfig` server names and `mason.nvim` package names (e.g. `lua_ls <-> lua-language-server`)
It is recommended to use this extension if you use `mason.nvim` and `lspconfig` (it's strongly recommended for Windows
users).
**Note: this plugin uses the `lspconfig` server names in the APIs it exposes - not `mason.nvim` package names. [See this
table for a complete mapping.](./doc/server-mapping.md)**
# Requirements
> `:h mason-lspconfig-requirements`
- neovim `>= 0.7.0`
- `mason.nvim`
- `lspconfig`
# Installation
## [Packer](https://github.com/wbthomason/packer.nvim)
```lua
use {
"williamboman/mason.nvim",
"williamboman/mason-lspconfig.nvim",
"neovim/nvim-lspconfig",
}
```
## [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"williamboman/mason.nvim",
"williamboman/mason-lspconfig.nvim",
"neovim/nvim-lspconfig",
}
```
## vim-plug
```vim
Plug 'williamboman/mason.nvim'
Plug 'williamboman/mason-lspconfig.nvim'
Plug 'neovim/nvim-lspconfig'
```
# Setup
> `:h mason-lspconfig-quickstart`
It's important that you set up the plugins in the following order:
1. `mason.nvim`
2. `mason-lspconfig.nvim`
3. Setup servers via `lspconfig`
Pay extra attention to this if you lazy-load plugins, or somehow "chain" the loading of plugins via your plugin manager.
```lua
require("mason").setup()
require("mason-lspconfig").setup()
-- After setting up mason-lspconfig you may set up servers via lspconfig
-- require("lspconfig").lua_ls.setup {}
-- require("lspconfig").rust_analyzer.setup {}
-- ...
```
Refer to the [Configuration](#configuration) section for information about which settings are available.
## Automatic server setup (advanced feature)
> `:h mason-lspconfig-automatic-server-setup`
`mason-lspconfig` provides extra, opt-in, functionality that allows you to automatically set up LSP servers installed
via `mason.nvim` without having to manually add each server setup to your Neovim configuration.
Refer to `:h mason-lspconfig-automatic-server-setup` for more details.
# Commands
> `:h mason-lspconfig-commands`
- `:LspInstall [<server>...]` - installs the provided servers
- `:LspUninstall <server> ...` - uninstalls the provided servers
# Configuration
> `:h mason-lspconfig-settings`
You may optionally configure certain behavior of `mason-lspconfig.nvim` when calling the `.setup()` function. Refer to
the [default configuration](#default-configuration) for a list of all available settings.
Example:
```lua
require("mason-lspconfig").setup {
ensure_installed = { "lua_ls", "rust_analyzer" },
}
```
## Default configuration
```lua
local DEFAULT_SETTINGS = {
-- A list of servers to automatically install if they're not already installed. Example: { "rust_analyzer@nightly", "lua_ls" }
-- This setting has no relation with the `automatic_installation` setting.
---@type string[]
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" } }
---@type boolean
automatic_installation = false,
-- See `:h mason-lspconfig.setup_handlers()`
---@type table<string, fun(server_name: string)>?
handlers = nil,
}
```
# Available LSP servers
| Language | Server name |
| ----------------------------------- | --------------------------------- |
| All | `snyk_ls` |
| All | `typos_lsp` |
| ast-grep | `ast_grep` |
| Autoconf | `autotools_ls` |
| AWK | `awk_ls` |
| Ada | `als` |
| Angular | `angularls` |
| Ansible | `ansiblels` |
| Antlers | `antlersls` |
| Apex | `apex_ls` |
| Arduino | `arduino_language_server` |
| Assembly (GAS/NASM, GO) | `asm_lsp` |
| Astro | `astro` |
| Automake | `autotools_ls` |
| Azure Pipelines | `azure_pipelines_ls` |
| Bash | `bashls` |
| Bash | `pkgbuild_language_server` |
| Beancount | `beancount` |
| Bicep | `bicep` |
| BrighterScript | `bright_script` |
| Buf | `bufls` |
| C | `clangd` |
| C# | `csharp_ls` |
| C# [(docs)][omnisharp] | `omnisharp_mono` |
| C# [(docs)][omnisharp] | `omnisharp` |
| C++ | `clangd` |
| Cairo | `cairo_ls` |
| CMake | `cmake` |
| CMake | `neocmake` |
| CSS | `cssls` |
| CSS | `cssmodules_ls` |
| CSS | `unocss` |
| Clarity | `clarity_lsp` |
| Clojure | `clojure_lsp` |
| CodeQL | `codeqlls` |
| Coq | `coq_lsp` |
| Crystal | `crystalline` |
| Cucumber | `cucumber_language_server` |
| Custom Elements Language Server | `custom_elements_ls` |
| Cue | `dagger` |
| Cypher | `cypher_ls` |
| Deno | `denols` |
| Dhall | `dhall_lsp_server` |
| Diagnostic (general purpose server) | `diagnosticls` |
| Dlang | `serve_d` |
| Docker | `dockerls` |
| Docker Compose | `docker_compose_language_service` |
| Dot | `dotls` |
| Drools | `drools_lsp` |
| Earthly | `earthlyls` |
| EFM (general purpose server) | `efm` |
| ESLint | `eslint` |
| Elixir | `elixirls` |
| Elixir | `lexical` |
| dprint | `dprint` |
| Elm | `elmls` |
| Ember | `ember` |
| Emmet | `emmet_language_server` |
| Emmet | `emmet_ls` |
| Erg | `erg_language_server` |
| Erlang | `elp` |
| Erlang | `erlangls` |
| F# | `fsautocomplete` |
| Facility Service Definition | `facility_language_server` |
| Fennel | `fennel_language_server` |
| Fennel | `fennel_ls` |
| Flux | `flux_lsp` |
| Foam (OpenFOAM) | `foam_ls` |
| Fortran | `fortls` |
| Glint | `glint` |
| GLSL | `glsl_analyzer` |
| GLSL | `glslls` |
| Go | `golangci_lint_ls` |
| Go | `gopls` |
| Gradle | `gradle_ls` |
| Grammarly | `grammarly` |
| GraphQL | `graphql` |
| Groovy | `groovyls` |
| HDL | `hdl_checker` |
| HTML | `html` |
| HTMX | `htmx` |
| Haskell | `hls` |
| Haxe | `haxe_language_server` |
| Helm | `helm_ls` |
| Hoon | `hoon_ls` |
| JSON | `jsonls` |
| JSON | `biome` |
| Java | `jdtls` |
| Java | `java_language_server` |
| JavaScript | `quick_lint_js` |
| JavaScript | `tsserver` |
| JavaScript | `vtsls` |
| JavaScript | `biome` |
| Jinja | `jinja_lsp` |
| Jsonnet | `jsonnet_ls` |
| Julia [(docs)][julials] | `julials` |
| jq | `jqls` |
| Kotlin | `kotlin_language_server` |
| LaTeX | `ltex` |
| LaTeX | `texlab` |
| Lelwel | `lelwel_ls` |
| Lua | `lua_ls` |
| Luau | `luau_lsp` |
| LWC | `lwc_ls` |
| Make | `autotools_ls` |
| Markdown | `markdown_oxide` |
| Markdown | `marksman` |
| Markdown | `prosemd_lsp` |
| Markdown | `remark_ls` |
| Markdown | `vale_ls` |
| Markdown | `zk` |
| Matlab | `matlab_ls` |
| MDX | `mdx_analyzer` |
| Meson | `mesonlsp` |
| Meson (deprecated) | `swift_mesonls` |
| Metamath Zero | `mm0_ls` |
| Move | `move_analyzer` |
| Mutt | `mutt_ls` |
| Nickel | `nickel_ls` |
| Nim | `nim_langserver` |
| Nim | `nimls` |
| Nix | `nil_ls` |
| Nix | `rnix` |
| OCaml | `ocamllsp` |
| Odin | `ols` |
| OneScript, 1C:Enterprise | `bsl_ls` |
| OpenAPI | `spectral` |
| OpenAPI | `vacuum` |
| OpenCL | `opencl_ls` |
| OpenSCAD | `openscad_lsp` |
| PHP | `intelephense` |
| PHP | `phpactor` |
| PHP | `psalm` |
| Perl | `perlnavigator` |
| Pest | `pest_ls` |
| Pico8 | `pico8_ls` |
| Powershell | `powershell_es` |
| Prisma | `prismals` |
| Puppet | `puppet` |
| PureScript | `purescriptls` |
| Python | `basedpyright` |
| Python | `jedi_language_server` |
| Python | `pyre` |
| Python | `pyright` |
| Python | `pylyzer` |
| Python | `sourcery` |
| Python [(docs)][pylsp] | `pylsp` |
| Python | `ruff` |
| Python | `ruff_lsp` |
| R | `r_language_server` |
| Raku | `raku_navigator` |
| ReScript | `rescriptls` |
| Reason | `reason_ls` |
| Robot Framework | `robotframework_ls` |
| Rome | `rome` |
| Ruby | `ruby_lsp` |
| Ruby | `solargraph` |
| Ruby | `sorbet` |
| Ruby | `standardrb` |
| Ruby | `rubocop` |
| Rust | `rust_analyzer` |
| SQL | `sqlls` |
| SQL | `sqls` |
| Salt | `salt_ls` |
| Sass | `somesass_ls` |
| Shopify Theme Check | `theme_check` |
| Slint | `slint_lsp` |
| Smithy | `smithy_ls` |
| Solidity | `solang` |
| Solidity | `solc` |
| Solidity | `solidity` |
| Solidity | `solidity_ls` |
| Solidity | `solidity_ls_nomicfoundation` |
| Sphinx | `esbonio` |
| Standard ML | `millet` |
| Starlark | `bzl` |
| Stylelint | `stylelint_lsp` |
| Svelte | `svelte` |
| Stimulus | `stimulus_ls` |
| SystemVerilog | `svlangserver` |
| SystemVerilog | `svls` |
| SystemVerilog | `verible` |
| TOML | `taplo` |
| Tailwind CSS | `tailwindcss` |
| Teal | `teal_ls` |
| Templ | `templ` |
| Terraform | `terraformls` |
| Terraform | `tflint` |
| Thrift | `thriftls` |
| Twiggy | `twiggy_language_server` |
| TypeScript | `biome` |
| TypeScript | `tsserver` |
| TypeScript | `vtsls` |
| Typst | `typst_lsp` |
| V | `v_analyzer` |
| V | `vls` |
| Vala | `vala_ls` |
| Veryl | `veryl_ls` |
| VimL | `vimls` |
| Visualforce | `visualforce_ls` |
| Vue | `volar` |
| Vue | `vuels` |
| WGSL | `wgsl_analyzer` |
| XML | `lemminx` |
| YAML | `gitlab_ci_ls` |
| YAML | `hydra_lsp` |
| YAML | `yamlls` |
| Zig | `zls` |
[julials]: ./lua/mason-lspconfig/server_configurations/julials/README.md
[omnisharp]: ./lua/mason-lspconfig/server_configurations/omnisharp/README.md
[pylsp]: ./lua/mason-lspconfig/server_configurations/pylsp/README.md
|
