Skip to content

feat: validate all option types #2414

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 9 commits into from
Sep 23, 2023
Merged

feat: validate all option types #2414

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c8f93a9
refactor: follow config structure for `ACCEPTED_TYPES`
Akmadan23 Sep 11, 2023
94093cd
Merge branch 'master' into refactor-opts-validation
Akmadan23 Sep 16, 2023
a7f29cc
Bug fix
Akmadan23 Sep 16, 2023
2384f61
Merge branch 'master' into refactor-opts-validation
Akmadan23 Sep 17, 2023
aabbf1d
Fix check for default values
Akmadan23 Sep 17, 2023
6e9cfb6
Reduce error notifications verbosity
Akmadan23 Sep 18, 2023
0baf9d1
Address issues introduced previously
Akmadan23 Sep 18, 2023
492a529
Merge branch 'master' into refactor-opts-validation
alex-courtis Sep 23, 2023
c94a51a
stylua
alex-courtis Sep 23, 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
39 changes: 26 additions & 13 deletions lua/nvim-tree.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,14 +620,27 @@ local FIELD_SKIP_VALIDATE = {
open_win_config = true,
}

local FIELD_OVERRIDE_TYPECHECK = {
width = { string = true, ["function"] = true, number = true, ["table"] = true },
max = { string = true, ["function"] = true, number = true },
min = { string = true, ["function"] = true, number = true },
on_attach = { ["function"] = true, string = true },
sorter = { ["function"] = true, string = true },
root_folder_label = { ["function"] = true, string = true, boolean = true },
picker = { ["function"] = true, string = true },
local ACCEPTED_TYPES = {
on_attach = { "function", "string" },
sort = {
sorter = { "function", "string" },
},
view = {
width = { "string", "function", "number", "table",
min = { "string", "function", "number" },
max = { "string", "function", "number" },
},
},
renderer = {
root_folder_label = { "function", "string", "boolean" },
},
actions = {
open_file = {
window_picker = {
picker = { "function", "string" },
},
},
},
}

local ACCEPTED_STRINGS = {
Expand All @@ -652,7 +665,7 @@ local ACCEPTED_STRINGS = {
local function validate_options(conf)
local msg

local function validate(user, def, strs, prefix)
local function validate(user, def, strs, types, 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 @@ -661,11 +674,11 @@ local function validate_options(conf)
for k, v in pairs(user) do
if not FIELD_SKIP_VALIDATE[k] then
local invalid
local override_typecheck = FIELD_OVERRIDE_TYPECHECK[k] or {}

if def[k] == nil then
-- option does not exist
invalid = string.format("[NvimTree] unknown option: %s%s", prefix, k)
elseif type(v) ~= type(def[k]) and not override_typecheck[type(v)] then
elseif type(v) ~= type(def[k]) and types[k] and not vim.tbl_contains(types[k], type(v)) then
-- 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))
Expand All @@ -682,13 +695,13 @@ local function validate_options(conf)
end
user[k] = nil
else
validate(v, def[k], strs[k] or {}, prefix .. k .. ".")
validate(v, def[k], strs[k] or {}, types[k] or {}, prefix .. k .. ".")
end
end
end
end

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

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