mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-07-30 20:38:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(api): relax contract, opts + rest params are optional #40581

Browse Source 
Problem:
|api-contract| allows adding an optional trailing `opts` parameter, but
the dispatch generator still requires every parameter, so `opts` cannot
be omitted.

Solution:
Treat a trailing `Dict(...) *opts` parameter as optional in the generated
RPC and Lua dispatch wrappers.

Co-authored-by: Judit Novak <judit.novak@gmail.com>
This commit is contained in:
Barrett Ruth
2026-07-13 09:28:24 -05:00
committed by GitHub
parent e18820007f
commit 25439dad7e
3 changed files with 164 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
test/functional/api/version_spec.lua
View File

@@ -3,6 +3,8 @@ local n = require('test.functional.testnvim')()
local clear, fn, eq = n.clear, n.fn, t.eq
local api = n.api
local matches = t.matches
local pcall_err = t.pcall_err
local function read_mpack_file(fname)
local fd = io.open(fname, 'rb')
@@ -280,3 +282,32 @@ describe('api metadata', function()
end
end)
end)
describe('api: optional trailing opts parameter', function()
before_each(clear)
it('may be omitted', function()
api.nvim_exec2('let g:x = 41')
eq(41, api.nvim_get_var('x'))
eq({ output = 'hi' }, api.nvim_exec2('echo "hi"', { output = true }))
end)
it('may be omitted when it is the only parameter', function()
eq('table', type(api.nvim_get_context()))
end)
it('errors on too many arguments', function()
matches(
'Wrong number of arguments: expecting 1 to 2 but got 3',
pcall_err(api.nvim_exec2, 'echo 1', {}, 'surplus')
)
matches(
'Wrong number of arguments: expecting at most 1 but got 2',
pcall_err(api.nvim_get_context, {}, 'surplus')
)
end)
it('errors on too few arguments', function()
matches('Wrong number of arguments: expecting 1 to 2 but got 0', pcall_err(api.nvim_exec2))
end)
end)