Skip to content

Commit 26e0618

Browse files
committed
docs(settings): de-rot dep-list comments and fix the palette type
palette_overwrite is a name -> palette map, not a list: fix the @type. Soften the nil_ls/nixd/shuck notes into provisioning-preference statements instead of Mason-registry claims that rot as the registry changes, drop the duplicated timeout literal and scheduled-notify rationale, and note the debug keymaps as a dap lazy-load trigger.
1 parent e181a23 commit 26e0618

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

lua/core/settings.lua

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ settings["disabled_plugins"] = {}
5757
-- These settings will override the defaults during initialization.
5858
-- Parameters will auto-complete as you type.
5959
-- Example: { sky = "#04A5E5" }
60-
---@type palette[]
60+
---@type palette
6161
settings["palette_overwrite"] = {}
6262

6363
-- Set the colorscheme here.
@@ -107,10 +107,10 @@ settings["lsp_deps"] = {
107107
"lua_ls",
108108
"marksman",
109109
"neocmake",
110-
"nil_ls", -- Nix LSP; prefer the $PATH binary (Nix), else Mason installs it (package `nil`)
111-
"nixd", -- Nix LSP (Rust); no Mason package, comes from Nix ($PATH)
110+
"nil_ls", -- Nix LSP; the Nix-provisioned $PATH binary is preferred
111+
"nixd", -- Nix LSP (Rust); provisioned from Nix ($PATH)
112112
"ruff",
113-
"shuck", -- shell linter/formatter/LSP (Rust); no Mason package, installed via mise
113+
"shuck", -- shell linter/formatter/LSP (Rust); installed via mise by choice ($PATH wins)
114114
"systemd_lsp",
115115
"terraformls",
116116
"tflint",
@@ -154,7 +154,7 @@ settings["linter_deps"] = {
154154
"golangcilint",
155155
"selene",
156156
"shellcheck",
157-
"shuck", -- shell linter for yaml.github `run:` blocks; no Mason package, installed via mise
157+
"shuck", -- shell linter for yaml.github `run:` blocks; installed via mise by choice
158158
"statix", -- Nix linter; prefer the $PATH binary (Nix)
159159
"systemdlint",
160160
"zsh", -- `zsh -n` syntax check via the system shell itself
@@ -163,12 +163,12 @@ settings["linter_deps"] = {
163163
-- Deadline (ms) for background Mason work before the aggregated missing-tool warning
164164
-- flushes anyway. Gates each tracked install (its own window) AND the registry refresh
165165
-- wait; late completions still recover. Missing or non-positive values fall back to
166-
-- the resolver's DEFAULT_TOOL_INSTALL_TIMEOUT_MS (300000) in `modules/utils/tools.lua`.
166+
-- the resolver's DEFAULT_TOOL_INSTALL_TIMEOUT_MS in `modules/utils/tools.lua`.
167167
---@type number
168168
settings["tool_install_timeout"] = 300000
169169

170170
-- DAP adapters to enable (mason-nvim-dap adapter names), resolved
171-
-- discovery-first when nvim-dap lazy-loads (first :Dap* command).
171+
-- discovery-first when nvim-dap lazy-loads (first :Dap* command or debug keymap).
172172
-- Supported DAPs: https://github.com/jay-babu/mason-nvim-dap.nvim/blob/main/lua/mason-nvim-dap/mappings/source.lua
173173
---@type string[]
174174
settings["dap_deps"] = {
@@ -262,8 +262,7 @@ local merged = require("modules.utils").extend_config(settings, "user.settings")
262262

263263
-- Migration guard: the discovery-first refactor removed this key; a stale
264264
-- user/settings.lua would merge it in and feed nothing — its servers would
265-
-- vanish without a word. (Scheduled: the notifier plugin isn't loaded this
266-
-- early; the default notify still lands in :messages.)
265+
-- vanish without a word.
267266
if merged.external_lsp_deps ~= nil then
268267
-- The removed setting was a MAP of server name -> executable name, but a
269268
-- stale override can survive in any shape: classify before advising so the

0 commit comments

Comments
 (0)