feat: add setting to control PATH modification (#514)

Closes #509.

1 files changed, 35 insertions, 28 deletions

diff --git a/doc/mason.txt b/doc/mason.txt
index eaeac3cb..3d8b4674 100644
--- a/doc/mason.txt
+++ b/doc/mason.txt
@@ -168,6 +168,41 @@ Example:
                                                       *mason-default-settings*
 
     local DEFAULT_SETTINGS = {
+        -- The directory in which to install packages.
+        install_root_dir = path.concat { vim.fn.stdpath "data", "mason" },
+
+        -- 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",
+
+        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 package installations.
+        log_level = vim.log.levels.INFO,
+
+        -- 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,
+
+        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",
+        },
+
         ui = {
             -- Whether to automatically check for new versions when opening the :Mason window.
             check_outdated_packages_on_open = true,
@@ -205,34 +240,6 @@ Example:
                 apply_language_filter = "<C-f>",
             },
         },
-
-        -- The directory in which to install packages.
-        install_root_dir = path.concat { vim.fn.stdpath "data", "mason" },
-
-        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 package installations.
-        log_level = vim.log.levels.INFO,
-
-        -- 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,
-
-        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",
-        },
     }