feat(api): nvim_exec2(), deprecate nvim_exec() #19032

Problem:
The signature of nvim_exec() is not extensible per ":help api-contract".

Solution:
Introduce nvim_exec2() and deprecate nvim_exec().

3 files changed, 14 insertions, 14 deletions

diff --git a/test/functional/ex_cmds/script_spec.lua b/test/functional/ex_cmds/script_spec.lua
index bf69ada820..d13268c97c 100644
--- a/test/functional/ex_cmds/script_spec.lua
+++ b/test/functional/ex_cmds/script_spec.lua
@@ -34,7 +34,7 @@ describe('script_get-based command', function()
             %s %s
           endif
         ]])):format(cmd, garbage)))
-        eq('', meths.exec('messages', true))
+        eq('', meths.exec2('messages', { output = true }).output)
         if check_neq then
           neq(0, exc_exec(dedent([[
             %s %s
@@ -49,7 +49,7 @@ describe('script_get-based command', function()
           EOF
           endif
         ]])):format(cmd, garbage)))
-        eq('', meths.exec('messages', true))
+        eq('', meths.exec2('messages', { output = true }).output)
         if check_neq then
           eq(true, pcall(source, (dedent([[
             let g:exc = 0
diff --git a/test/functional/ex_cmds/source_spec.lua b/test/functional/ex_cmds/source_spec.lua
index 64c3464be7..e12ead240d 100644
--- a/test/functional/ex_cmds/source_spec.lua
+++ b/test/functional/ex_cmds/source_spec.lua
@@ -96,12 +96,12 @@ describe(':source', function()
       let d = s:s]])
 
     command('source')
-    eq('2', meths.exec('echo a', true))
-    eq("{'k': 'v'}", meths.exec('echo b', true))
+    eq('2', meths.exec2('echo a', { output = true }).output)
+    eq("{'k': 'v'}", meths.exec2('echo b', { output = true }).output)
 
     -- Script items are created only on script var access
-    eq("1", meths.exec('echo c', true))
-    eq("0zBEEFCAFE", meths.exec('echo d', true))
+    eq("1", meths.exec2('echo c', { output = true }).output)
+    eq("0zBEEFCAFE", meths.exec2('echo d', { output = true }).output)
 
     exec('set cpoptions+=C')
     eq('Vim(let):E723: Missing end of Dictionary \'}\': ', exc_exec('source'))
@@ -124,14 +124,14 @@ describe(':source', function()
     -- Source the 2nd line only
     feed('ggjV')
     feed_command(':source')
-    eq('3', meths.exec('echo a', true))
+    eq('3', meths.exec2('echo a', { output = true }).output)
 
     -- Source from 2nd line to end of file
     feed('ggjVG')
     feed_command(':source')
-    eq('4', meths.exec('echo a', true))
-    eq("{'K': 'V'}", meths.exec('echo b', true))
-    eq("<SNR>1_C()", meths.exec('echo D()', true))
+    eq('4', meths.exec2('echo a', { output = true }).output)
+    eq("{'K': 'V'}", meths.exec2('echo b', { output = true }).output)
+    eq("<SNR>1_C()", meths.exec2('echo D()', { output = true }).output)
 
     -- Source last line only
     feed_command(':$source')
@@ -147,7 +147,7 @@ describe(':source', function()
       let a = 123
     ]]
     command('source')
-    eq('123', meths.exec('echo a', true))
+    eq('123', meths.exec2('echo a', { output = true }).output)
   end)
 
   it('multiline heredoc command', function()
@@ -157,7 +157,7 @@ describe(':source', function()
       EOF]])
 
     command('source')
-    eq('4', meths.exec('echo luaeval("y")', true))
+    eq('4', meths.exec2('echo luaeval("y")', { output = true }).output)
   end)
 
   it('can source lua files', function()
diff --git a/test/functional/ex_cmds/verbose_spec.lua b/test/functional/ex_cmds/verbose_spec.lua
index e55372e993..2482fd912f 100644
--- a/test/functional/ex_cmds/verbose_spec.lua
+++ b/test/functional/ex_cmds/verbose_spec.lua
@@ -24,11 +24,11 @@ vim.opt.number = true
 vim.api.nvim_set_keymap('n', '<leader>key1', ':echo "test"<cr>', {noremap = true})
 vim.keymap.set('n', '<leader>key2', ':echo "test"<cr>')
 
-vim.api.nvim_exec("augroup test_group\
+vim.api.nvim_exec2("augroup test_group\
                      autocmd!\
                      autocmd FileType c setl cindent\
                      augroup END\
-                  ", false)
+                  ", { output = false })
 
 vim.api.nvim_command("command Bdelete :bd")
 vim.api.nvim_create_user_command("TestCommand", ":echo 'Hello'", {})