aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilliam Boman <william@redwill.se>2023-08-26 15:57:53 +0200
committerGitHub <noreply@github.com>2023-08-26 15:57:53 +0200
commit34b3d0d01dfeba0b869bedf32ae846ef63ad4bd1 (patch)
tree0aa2eaf363c0178c6346e8b75b3171ccca8178f4
parentfeat(ui): add setting to toggle help view (#1468) (diff)
downloadmason-34b3d0d01dfeba0b869bedf32ae846ef63ad4bd1.tar
mason-34b3d0d01dfeba0b869bedf32ae846ef63ad4bd1.tar.gz
mason-34b3d0d01dfeba0b869bedf32ae846ef63ad4bd1.tar.bz2
mason-34b3d0d01dfeba0b869bedf32ae846ef63ad4bd1.tar.lz
mason-34b3d0d01dfeba0b869bedf32ae846ef63ad4bd1.tar.xz
mason-34b3d0d01dfeba0b869bedf32ae846ef63ad4bd1.tar.zst
mason-34b3d0d01dfeba0b869bedf32ae846ef63ad4bd1.zip
docs: update default settings docs (#1470)
-rw-r--r--README.md4
-rw-r--r--doc/mason.txt32
2 files changed, 34 insertions, 2 deletions
diff --git a/README.md b/README.md
index c1000fa9..6303db9d 100644
--- a/README.md
+++ b/README.md
@@ -310,8 +310,8 @@ local DEFAULT_SETTINGS = {
[help-mason-how-to-use-packages]: ./doc/mason.txt#L153
[help-mason-introduction]: ./doc/mason.txt#L11
[help-mason-quickstart]: ./doc/mason.txt#L67
-[help-mason-registry-refresh]: ./doc/mason.txt#L517
-[help-mason-registry-update]: ./doc/mason.txt#L510
+[help-mason-registry-refresh]: ./doc/mason.txt#L549
+[help-mason-registry-update]: ./doc/mason.txt#L542
[help-mason-requirements]: ./doc/mason.txt#L50
[help-mason-settings]: ./doc/mason.txt#L238
[help-standard-path]: https://neovim.io/doc/user/starting.html#standard-path
diff --git a/doc/mason.txt b/doc/mason.txt
index 93c98b79..e7a2d3bf 100644
--- a/doc/mason.txt
+++ b/doc/mason.txt
@@ -256,10 +256,13 @@ Example:
<
*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)
@@ -267,14 +270,17 @@ Example:
---@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.
@@ -282,6 +288,7 @@ Example:
"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:
@@ -293,6 +300,7 @@ Example:
},
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")
@@ -302,9 +310,11 @@ Example:
},
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.
--
@@ -313,50 +323,72 @@ Example:
},
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?",
},
},
}