Skip to content

feat: validate some option string values #2404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 9, 2023
Merged

feat: validate some option string values #2404

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a51100
Add check for accepted strings in user opts
Akmadan23 Sep 6, 2023
3817248
option failures point to :help nvim-tree-opts
alex-courtis Sep 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions lua/nvim-tree.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,10 +630,29 @@ local FIELD_OVERRIDE_TYPECHECK = {
picker = { ["function"] = true, string = true },
}

local ACCEPTED_STRINGS = {
sort = {
sorter = { "name", "case_sensitive", "modification_time", "extension", "suffix", "filetype" },
},
view = {
side = { "left", "right" },
signcolumn = { "yes", "no", "auto" },
},
renderer = {
highlight_opened_files = { "none", "icon", "name", "all" },
highlight_modified = { "none", "icon", "name", "all" },
icons = {
git_placement = { "before", "after", "signcolumn" },
diagnostics_placement = { "before", "after", "signcolumn" },
modified_placement = { "before", "after", "signcolumn" },
},
},
}

local function validate_options(conf)
local msg

local function validate(user, def, prefix)
local function validate(user, def, strs, prefix)
-- only compare tables with contents that are not integer indexed
if type(user) ~= "table" or type(def) ~= "table" or not next(def) or type(next(def)) == "number" then
return
Expand All @@ -650,6 +669,9 @@ local function validate_options(conf)
-- option is of the wrong type and is not a function
invalid =
string.format("[NvimTree] invalid option: %s%s expected: %s actual: %s", prefix, k, type(def[k]), type(v))
elseif type(v) == "string" and strs[k] and not vim.tbl_contains(strs[k], v) then
-- option has type `string` but value is not accepted
invalid = string.format("[NvimTree] invalid value for field %s%s: '%s'", prefix, k, v)
end

if invalid then
Expand All @@ -660,16 +682,16 @@ local function validate_options(conf)
end
user[k] = nil
else
validate(v, def[k], prefix .. k .. ".")
validate(v, def[k], strs[k] or {}, prefix .. k .. ".")
end
end
end
end

validate(conf, DEFAULT_OPTS, "")
validate(conf, DEFAULT_OPTS, ACCEPTED_STRINGS, "")

if msg then
vim.notify_once(msg .. " | see :help nvim-tree-setup for available configuration options\n", vim.log.levels.WARN)
vim.notify_once(msg .. " | see :help nvim-tree-opts for available configuration options\n", vim.log.levels.WARN)
end
end

Expand Down