IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

feat(lua): add support for multiple optional types in vim.validate (#16864)

Browse Source
This commit is contained in:
Shadman 2022-01-02 01:35:15 +06:00 committed by GitHub
parent f86039de1e
commit 55c4393e9f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 56 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
runtime/doc/lua.txt
View File

@ -1656,16 +1656,25 @@ validate({opt}) *vim.validate()*
=> error('arg1: expected even number, got 3')
<
If multiple types are valid they can be given as a list. >
vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
=> NOP (success)
vim.validate{arg1={1, {'string', table'}}}
=> error('arg1: expected string|table, got number')
<
Parameters: ~
{opt} Map of parameter names to validations. Each key is
a parameter name; each value is a tuple in one of
these forms:
{opt} table of parameter names to validations. Each key
is a parameter name; each value is a tuple in one
of these forms:
1. (arg_value, type_name, optional)
• arg_value: argument value
• type_name: string type name, one of: ("table",
"t", "string", "s", "number", "n", "boolean",
"b", "function", "f", "nil", "thread",
"userdata")
• type_name: string|table type name, one of:
("table", "t", "string", "s", "number", "n",
"boolean", "b", "function", "f", "nil",
"thread", "userdata") or list of them.
• optional: (optional) boolean, if true, `nil`
is valid

52
runtime/lua/vim/shared.lua
View File

@ -526,13 +526,23 @@ end
--- => error('arg1: expected even number, got 3')
--- </pre>
---
---@param opt Map of parameter names to validations. Each key is a parameter
--- If multiple types are valid they can be given as a list.
--- <pre>
--- vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
--- => NOP (success)
---
--- vim.validate{arg1={1, {'string', table'}}}
--- => error('arg1: expected string|table, got number')
---
--- </pre>
---
---@param opt table of parameter names to validations. Each key is a parameter
--- name; each value is a tuple in one of these forms:
--- 1. (arg_value, type_name, optional)
--- - arg_value: argument value
--- - type_name: string type name, one of: ("table", "t", "string",
--- - type_name: string|table type name, one of: ("table", "t", "string",
--- "s", "number", "n", "boolean", "b", "function", "f", "nil",
--- "thread", "userdata")
--- "thread", "userdata") or list of them.
--- - optional: (optional) boolean, if true, `nil` is valid
--- 2. (arg_value, fn, msg)
--- - arg_value: argument value
@ -571,21 +581,16 @@ do
end
local val = spec[1] -- Argument value.
local t = spec[2] -- Type name, or callable.
local types = spec[2] -- Type name, or callable.
local optional = (true == spec[3])
if type(t) == 'string' then
local t_name = type_names[t]
if not t_name then
return false, string.format('invalid type name: %s', t)
end
if type(types) == 'string' then
types = {types}
end
if (not optional or val ~= nil) and not _is_type(val, t_name) then
return false, string.format("%s: expected %s, got %s", param_name, t_name, type(val))
end
elseif vim.is_callable(t) then
if vim.is_callable(types) then
-- Check user-provided validation function.
local valid, optional_message = t(val)
local valid, optional_message = types(val)
if not valid then
local error_message = string.format("%s: expected %s, got %s", param_name, (spec[3] or '?'), val)
if optional_message ~= nil then
@ -594,8 +599,25 @@ do
return false, error_message
end
elseif type(types) == 'table' then
local success = false
for i, t in ipairs(types) do
local t_name = type_names[t]
if not t_name then
return false, string.format('invalid type name: %s', t)
end
types[i] = t_name
if (optional and val == nil) or _is_type(val, t_name) then
success = true
break
end
end
if not success then
return false, string.format("%s: expected %s, got %s", param_name, table.concat(types, '|'), type(val))
end
else
return false, string.format("invalid type name: %s", tostring(t))
return false, string.format("invalid type name: %s", tostring(types))
end
end

3
test/functional/lua/vim_spec.lua
View File

@ -906,6 +906,7 @@ describe('lua stdlib', function()
exec_lua("vim.validate{arg1={nil, 'thread', true }}")
exec_lua("vim.validate{arg1={{}, 't' }, arg2={ 'foo', 's' }}")
exec_lua("vim.validate{arg1={2, function(a) return (a % 2) == 0 end, 'even number' }}")
exec_lua("vim.validate{arg1={5, {'n', 's'} }, arg2={ 'foo', {'n', 's'} }}")
matches('expected table, got number',
pcall_err(exec_lua, "vim.validate{ 1, 'x' }"))
@ -935,6 +936,8 @@ describe('lua stdlib', function()
pcall_err(exec_lua, "vim.validate{arg1={3, function(a) return a == 1 end, 'even number'}}"))
matches('arg1: expected %?, got 3',
pcall_err(exec_lua, "vim.validate{arg1={3, function(a) return a == 1 end}}"))
matches('arg1: expected number|string, got nil',
pcall_err(exec_lua, "vim.validate{ arg1={ nil, {'n', 's'} }}"))
-- Pass an additional message back.
matches('arg1: expected %?, got 3. Info: TEST_MSG',