-
-
Notifications
You must be signed in to change notification settings - Fork 281
/
mason.txt
580 lines (476 loc) · 21.6 KB
/
mason.txt
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
*mason.nvim*
Minimum version of neovim: 0.7.0
Author: William Boman
*mason-help-guide*
Type |gO| to see the table of contents.
Press |K| on a helptag to jump to it: |mason-help-guide|
==============================================================================
INTRODUCTION *mason-introduction*
`mason.nvim` is a Neovim plugin that allows you to easily manage external
editor tooling such as LSP servers, DAP servers, linters, and formatters
through a single interface. It runs everywhere Neovim runs (across Linux,
macOS, Windows, etc.), with only a small set of external requirements needed.
Packages are installed in Neovim's data directory (`:h standard-path`) by
default. Executables are linked to a single `bin/` directory, which
`mason.nvim` will add to Neovim's PATH during setup, allowing seamless access
from Neovim builtins (shell, terminal, etc.) as well as other 3rd party
plugins.
-----------------
MASON.NVIM LUA API
*mason-api-reference*
Mason offers a public Lua API that allows you to further customize or
extend Mason. You may find documentation for it in the link below.
https://github.com/williamboman/mason.nvim/blob/main/doc/reference.md
Note ~
APIs not listed in the document are not considered public and are subject
to unannounced breaking changes.
-----------------
EXTENSION PLUGINS
*mason-extensions*
Extension plugins help fill gaps with the rest of the Neovim ecosystem.
mason-lspconfig ~
`mason-lspconfig` bridges Mason with the `lspconfig` plugin - making
it easier to use both plugins together.
https://github.com/williamboman/mason-lspconfig.nvim
3rd party extensions ~
https://github.com/williamboman/mason.nvim/wiki/Extensions
==============================================================================
REQUIREMENTS *mason-requirements*
`mason.nvim` relaxes the minimum requirements by attempting multiple different
utilities (for example, `wget`, `curl`, and `Invoke-WebRequest` are all
perfect substitutes). The _minimum_ recommended requirements are:
- neovim `>= 0.7.0`
- For Unix systems: `git(1)`, `curl(1)` or `wget(1)`, `unzip(1)`, `tar(1)`,
`gzip(1)`
- For Windows systems: pwsh or powershell, git, tar, and 7zip or peazip or
archiver or winzip or WinRAR
Note that Mason will regularly shell out to external package managers,
such as `cargo` and `npm`. Depending on your personal usage, some of these
will also need to be installed. Refer to `:checkhealth mason` for a full list.
==============================================================================
QUICK START *mason-quickstart*
-----------------
SETTING UP MASON.NVIM
First you'll need to set up Mason. This is done by calling the `setup()`
function:
>lua
require("mason").setup()
<
Mason will do the following during setup:
1) enhance the Neovim session's PATH environment
2) register commands (|mason-commands|)
Refer to |mason-settings| for all available settings.
-----------------
INSTALLING PACKAGES
Install a package via |:MasonInstall|, for example:
>vim
:MasonInstall stylua
<
You may also install multiple packages at a time:
>vim
:MasonInstall stylua lua-language-server
<
To install a specific version of a package, you may provide it as part of the
package name, like so:
>vim
:MasonInstall rust-analyzer@nightly
<
Please refer to each package's own release pages to find which versions are
available.
You may also install packages in headless mode. This will run the command in
blocking mode and the command won't yield back until all packages have
finished installing:
>sh
$ nvim --headless -c "MasonInstall lua-language-server rust-analyzer" -c qall
<
Note: ~
You may also use the Lua API |mason-api-reference| to programmatically
manage package installations. Through this interface you will also gain
access to more features to allow further customization.
-----------------
THE MASON WINDOW
To view the UI for mason, run: >vim
:Mason
<
Through this UI you may explore which packages that are available, see which
installed packages have new versions available, install, uninstall, or update
packages, expand package information, and more. The UI comes with a set of
keybinds which you may find in the help view by pressing `g?` when the Mason
window is open.
==============================================================================
REGISTRIES *mason-registries*
`mason.nvim` sources package definitions from the registries it has been
configured with (see |mason-settings|). `mason.nvim` uses the core registry,
governed by `mason.nvim`, by default. This may be extended, or even entirely
overridden, through additional registries, like so:
>lua
require("mason").setup {
registries = {
"lua:my-registry",
"github:mason-org/mason-registry",
},
}
<
Packages are loaded from registries in the order they've been configured,
with registries appearing first in the list having precedence.
==============================================================================
HOW TO INSTALL PACKAGES *mason-how-to-install-packages*
You may install packages either via the command interface or via Mason's Lua
APIs. See |:MasonInstall| or |mason-api-reference| for more details.
==============================================================================
HOW TO USE PACKAGES *mason-how-to-use-packages*
Although many packages are perfectly usable out of the box through Neovim
builtins, it is recommended to use other 3rd party plugins to further
integrate these. The following plugins are recommended:
- LSP: `lspconfig` & `mason-lspconfig.nvim`
- DAP: `nvim-dap` & `nvim-dap-ui`
- Linters: `null-ls.nvim` or `nvim-lint`
- Formatters: `null-ls.nvim` or `formatter.nvim`
formatter.nvim https://github.com/mhartington/formatter.nvim
lspconfig https://github.com/neovim/nvim-lspconfig
mason-lspconfig.nvim https://github.com/williamboman/mason-lspconfig.nvim
null-ls.nvim https://github.com/jose-elias-alvarez/null-ls.nvim
nvim-dap https://github.com/mfussenegger/nvim-dap
nvim-dap-ui https://github.com/rcarriga/nvim-dap-ui
nvim-lint https://github.com/mfussenegger/nvim-lint
See also ~
Execute external commands: |:!cmd|.
Launch an embedded terminal: |terminal|.
Launch background jobs: |jobstart| & |uv.spawn()| (via |vim.loop|)
==============================================================================
COMMANDS *mason-commands*
------------------------------------------------------------------------------
OPEN THE MASON WINDOW *:Mason*
:Mason
Opens the graphical status window.
Through this UI you may explore which packages that are available, see which
installed packages have new versions available, install, uninstall, or update
packages, expand package information, and more. The UI comes with a set of
keybinds which you may find in the help view by pressing `g?` when the Mason
window is open.
------------------------------------------------------------------------------
UPDATE REGISTRIES *:MasonUpdate*
>vim
:MasonUpdate
<
Updates all managed registries.
------------------------------------------------------------------------------
INSTALLING PACKAGES *:MasonInstall*
>vim
:MasonInstall <package> ...
<
Installs the provided packages. Packages may include a version specifier,
like so:
>vim
:MasonInstall [email protected]
<
Runs in blocking fashion if there are no UIs attached (i.e. running in
headless mode):
>sh
$ nvim --headless -c "MasonInstall stylua" -c "qall"
<
------------------------------------------------------------------------------
UNINSTALLING PACKAGES *:MasonUninstall*
>vim
:MasonUninstall <package> ...
<
Uninstalls the provided packages.
------------------------------------------------------------------------------
UNINSTALLING ALL PACKAGES *:MasonUninstallAll*
>vim
:MasonUninstallAll
<
Uninstalls all installed packages.
------------------------------------------------------------------------------
VIEW THE MASON LOG *:MasonLog*
>vim
:MasonLog
<
Opens the log file in a new tab window.
==============================================================================
SETTINGS *mason-settings*
You can configure certain behavior of mason when calling the `.setup()`
function.
Refer to the |mason-default-settings| for all available settings.
Example:
>lua
require("mason").setup({
ui = {
icons = {
package_installed = "✓",
package_pending = "➜",
package_uninstalled = "✗"
}
}
})
<
*mason-default-settings*
>lua
---@class MasonSettings
local DEFAULT_SETTINGS = {
---@since 1.0.0
-- The directory in which to install packages.
install_root_dir = path.concat { vim.fn.stdpath "data", "mason" },
---@since 1.0.0
-- Where Mason should put its bin location in your PATH. Can be one of:
-- - "prepend" (default, Mason's bin location is put first in PATH)
-- - "append" (Mason's bin location is put at the end of PATH)
-- - "skip" (doesn't modify PATH)
---@type '"prepend"' | '"append"' | '"skip"'
PATH = "prepend",
---@since 1.0.0
-- 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 package installations.
log_level = vim.log.levels.INFO,
---@since 1.0.0
-- Limit for the maximum amount of packages to be installed at the same time. Once this limit is reached, any further
-- packages that are requested to be installed will be put in a queue.
max_concurrent_installers = 4,
---@since 1.0.0
-- [Advanced setting]
-- The registries to source packages from. Accepts multiple entries. Should a package with the same name exist in
-- multiple registries, the registry listed first will be used.
registries = {
"github:mason-org/mason-registry",
},
---@since 1.0.0
-- The provider implementations to use for resolving supplementary package metadata (e.g., all available versions).
-- Accepts multiple entries, where later entries will be used as fallback should prior providers fail.
-- Builtin providers are:
-- - mason.providers.registry-api - uses the https://api.mason-registry.dev API
-- - mason.providers.client - uses only client-side tooling to resolve metadata
providers = {
"mason.providers.registry-api",
"mason.providers.client",
},
github = {
---@since 1.0.0
-- 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",
},
pip = {
---@since 1.0.0
-- Whether to upgrade pip to the latest version in the virtual environment before installing packages.
upgrade_pip = false,
---@since 1.0.0
-- 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 = {},
},
ui = {
---@since 1.0.0
-- Whether to automatically check for new versions when opening the :Mason window.
check_outdated_packages_on_open = true,
---@since 1.0.0
-- The border to use for the UI window. Accepts same border values as |nvim_open_win()|.
border = "none",
---@since 1.0.0
-- Width of the window. Accepts:
-- - Integer greater than 1 for fixed width.
-- - Float in the range of 0-1 for a percentage of screen width.
width = 0.8,
---@since 1.0.0
-- Height of the window. Accepts:
-- - Integer greater than 1 for fixed height.
-- - Float in the range of 0-1 for a percentage of screen height.
height = 0.9,
icons = {
---@since 1.0.0
-- The list icon to use for installed packages.
package_installed = "◍",
---@since 1.0.0
-- The list icon to use for packages that are installing, or queued for installation.
package_pending = "◍",
---@since 1.0.0
-- The list icon to use for packages that are not installed.
package_uninstalled = "◍",
},
keymaps = {
---@since 1.0.0
-- Keymap to expand a package
toggle_package_expand = "<CR>",
---@since 1.0.0
-- Keymap to install the package under the current cursor position
install_package = "i",
---@since 1.0.0
-- Keymap to reinstall/update the package under the current cursor position
update_package = "u",
---@since 1.0.0
-- Keymap to check for new version for the package under the current cursor position
check_package_version = "c",
---@since 1.0.0
-- Keymap to update all installed packages
update_all_packages = "U",
---@since 1.0.0
-- Keymap to check which installed packages are outdated
check_outdated_packages = "C",
---@since 1.0.0
-- Keymap to uninstall a package
uninstall_package = "X",
---@since 1.0.0
-- Keymap to cancel a package installation
cancel_installation = "<C-c>",
---@since 1.0.0
-- Keymap to apply language filter
apply_language_filter = "<C-f>",
---@since 1.1.0
-- Keymap to toggle viewing package installation log
toggle_package_install_log = "<CR>",
---@since 1.8.0
-- Keymap to toggle the help view
toggle_help = "g?",
},
},
}
<
==============================================================================
DOWNLOAD MIRRORS *mason-download-mirrors*
------------------------------------------------------------------------------
GITHUB MIRROR *mason-download-mirror-github*
It's possible to customize the download URL used when downloading assets
from GitHub releases by setting the `github.download_url_template`
settings during setup, like so:
>lua
require("mason").setup {
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://my.mirror.com/%s/releases/download/%s/%s",
},
}
<
==============================================================================
INSTALLATION ERRORS *mason-errors*
*mason-provider-errors*
By default, Mason uses the api.mason-registry.dev API to resolve package
metadata. Calling this service may result in network errors on some networks
(e.g., SSL issues on corporate VPNs). If resolving the SSL error is not an
option, you will have to change the provider implementation. Mason provides a
client provider which calls underlying 3rd party service APIs directly, which
you can enable like so:
>lua
require("mason").setup {
providers = {
"mason.providers.client",
"mason.providers.registry-api",
}
}
<
Note: ~
The client provider have less overall coverage and may come with
additional performance penalties (spawning slow commands, network &
parsing overheads, etc.).
==============================================================================
DEBUGGING *mason-debugging*
To help with debugging issues with installing/uninstalling packages, please
make sure to set mason's log level to DEBUG or TRACE, like so:
>lua
require("mason").setup {
log_level = vim.log.levels.DEBUG
}
<
You may find the logs by entering the command `:MasonLog`. Providing the
contents of this file when reporting an issue will help tremendously. Remember
to redo whatever is failing after changing the log level in order to capture
new log entries.
==============================================================================
Lua module: mason
*mason.setup()*
setup({config})
Sets up mason with the provided {config} (see |mason-settings|).
==============================================================================
Lua module: mason-registry
*mason-registry.is_installed()*
is_installed({package_name})
Checks whether the provided package name is installed. In many situations,
this is a more efficient option than the Package:is_installed() method due
to a smaller amount of modules required to load.
Parameters:
{package_name} - string
Returns:
boolean
*mason-registry.get_package()*
get_package({package_name})
Returns an instance of the Package class if the provided package name
exists.
This function errors if a package cannot be found.
Parameters:
{package_name} - string
Returns:
Package
*mason-registry.has_package()*
has_package({package_name})
Returns true if the provided package_name can be found in the registry.
Parameters:
{package_name} - string
Returns:
boolean
*mason-registry.get_installed_packages()*
get_installed_packages()
Returns all installed package instances. This is a slower function that
loads more modules.
Returns:
Package[]
*mason-registry.get_installed_package_names()*
get_installed_package_names()
Returns all installed package names. This is a fast function that doesn't
load any extra modules.
Returns:
string[]
*mason-registry.get_all_packages()*
get_all_packages()
Returns all package instances. This is a slower function that loads more
modules.
Returns:
Package[]
*mason-registry.get_all_package_names()*
get_all_package_names()
Returns all package names. This is a faster function than
|mason-registry.get_all_packages()| because it loads fewer modules.
Returns:
string[]
*mason-registry.get_all_package_specs()*
get_all_package_specs()
Returns all package specifications. This is a faster function than
|mason-registry.get_all_packages()| because it loads fewer modules.
Returns:
(PackageSpec | RegistryPackageSpec)[]
*mason-registry.update()*
update({callback})
Updates all managed registries.
Parameters:
{callback} - Callback of the signature `fun(success: boolean, updated_registries: RegistrySource[])`
*mason-registry.refresh()*
refresh({callback?})
Refreshes all registries if needed. This is a convenience wrapper around
|mason-registry.update()| that only updates registries if:
1) registries haven't been updated in a while
2) or, one or more registries are not installed
Runs in a blocking fashion if no {callback} is provided. Note that when
running in blocking fashion the entire editor is frozen, so prefer the
asynchronous variant unless absolutely needed.
Parameters:
{callback?} (optional) - Invoked when the registry has been refreshed.
Example:
>lua
local registry = require("mason-registry")
-- 1. synchronous
registry.refresh()
local packages = registry.get_all_packages()
...
-- 2. asynchronous
registry.refresh(function ()
local packages = registry.get_all_packages()
...
end)
<
vim:tw=78:ft=help:norl:expandtab:sw=4