diff options
author | Javier Lopez <graulopezjavier@gmail.com> | 2022-03-26 09:34:56 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-03-26 15:34:56 +0100 |
commit | a490db5ba819218e9188cbb51d885dbf3a194000 (patch) | |
tree | 947d6967add6a7fb9599bb78846ca57d95277feb | |
parent | 111dd6c3228c594562d151d6ebc929ff7c889324 (diff) | |
download | rneovim-a490db5ba819218e9188cbb51d885dbf3a194000.tar.gz rneovim-a490db5ba819218e9188cbb51d885dbf3a194000.tar.bz2 rneovim-a490db5ba819218e9188cbb51d885dbf3a194000.zip |
refactor!: rename nvim_do_autocmd to nvim_exec_autocmd (#17854)
according to established code standards (`:h dev-api`)
-rw-r--r-- | runtime/doc/api.txt | 2 | ||||
-rw-r--r-- | src/nvim/api/autocmd.c | 2 | ||||
-rw-r--r-- | src/nvim/api/keysets.lua | 2 | ||||
-rw-r--r-- | test/functional/api/autocmd_spec.lua | 30 |
4 files changed, 18 insertions, 18 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 02a27e15f8..0a8a3e9a2c 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -3282,7 +3282,7 @@ nvim_del_autocmd({id}) *nvim_del_autocmd()* See also: ~ |nvim_create_autocmd()| -nvim_do_autocmd({event}, {*opts}) *nvim_do_autocmd()* +nvim_exec_autocmd({event}, {*opts}) *nvim_exec_autocmd()* Execute an autocommand |autocmd-execute|. Parameters: ~ diff --git a/src/nvim/api/autocmd.c b/src/nvim/api/autocmd.c index 9aaa0418dc..49f6f98ba4 100644 --- a/src/nvim/api/autocmd.c +++ b/src/nvim/api/autocmd.c @@ -695,7 +695,7 @@ void nvim_del_augroup_by_name(String name) /// - modeline (bool) optional: defaults to true. Process the /// modeline after the autocommands |<nomodeline>|. /// @see |:doautocmd| -void nvim_do_autocmd(Object event, Dict(do_autocmd) *opts, Error *err) +void nvim_exec_autocmd(Object event, Dict(exec_autocmd) *opts, Error *err) FUNC_API_SINCE(9) { int au_group = AUGROUP_ALL; diff --git a/src/nvim/api/keysets.lua b/src/nvim/api/keysets.lua index b6264cdfab..6a29b0fb59 100644 --- a/src/nvim/api/keysets.lua +++ b/src/nvim/api/keysets.lua @@ -133,7 +133,7 @@ return { "nested"; "pattern"; }; - do_autocmd = { + exec_autocmd = { "buffer"; "group"; "modeline"; diff --git a/test/functional/api/autocmd_spec.lua b/test/functional/api/autocmd_spec.lua index a58ca00a75..3b14ae9bf7 100644 --- a/test/functional/api/autocmd_spec.lua +++ b/test/functional/api/autocmd_spec.lua @@ -168,7 +168,7 @@ describe('autocmd api', function() }) ]] - meths.do_autocmd("User", {pattern = "Test"}) + meths.exec_autocmd("User", {pattern = "Test"}) eq({{ buflocal = false, command = 'A test autocommand', @@ -179,7 +179,7 @@ describe('autocmd api', function() pattern = 'Test', }}, meths.get_autocmds({event = "User", pattern = "Test"})) meths.set_var("some_condition", true) - meths.do_autocmd("User", {pattern = "Test"}) + meths.exec_autocmd("User", {pattern = "Test"}) eq({}, meths.get_autocmds({event = "User", pattern = "Test"})) end) end) @@ -490,7 +490,7 @@ describe('autocmd api', function() end) end) - describe('nvim_do_autocmd', function() + describe('nvim_exec_autocmd', function() it("can trigger builtin autocmds", function() meths.set_var("autocmd_executed", false) @@ -500,7 +500,7 @@ describe('autocmd api', function() }) eq(false, meths.get_var("autocmd_executed")) - meths.do_autocmd("BufReadPost", {}) + meths.exec_autocmd("BufReadPost", {}) eq(true, meths.get_var("autocmd_executed")) end) @@ -514,10 +514,10 @@ describe('autocmd api', function() }) -- Doesn't execute for other non-matching events - meths.do_autocmd("CursorHold", { buffer = 1 }) + meths.exec_autocmd("CursorHold", { buffer = 1 }) eq(-1, meths.get_var("buffer_executed")) - meths.do_autocmd("BufLeave", { buffer = 1 }) + meths.exec_autocmd("BufLeave", { buffer = 1 }) eq(1, meths.get_var("buffer_executed")) end) @@ -531,7 +531,7 @@ describe('autocmd api', function() }) -- Doesn't execute for other non-matching events - meths.do_autocmd("CursorHold", { buffer = 1 }) + meths.exec_autocmd("CursorHold", { buffer = 1 }) eq('none', meths.get_var("filename_executed")) meths.command('edit __init__.py') @@ -539,7 +539,7 @@ describe('autocmd api', function() end) it('cannot pass buf and fname', function() - local ok = pcall(meths.do_autocmd, "BufReadPre", { pattern = "literally_cannot_error.rs", buffer = 1 }) + local ok = pcall(meths.exec_autocmd, "BufReadPre", { pattern = "literally_cannot_error.rs", buffer = 1 }) eq(false, ok) end) @@ -557,16 +557,16 @@ describe('autocmd api', function() }) -- Doesn't execute for other non-matching events - meths.do_autocmd("CursorHoldI", { buffer = 1 }) + meths.exec_autocmd("CursorHoldI", { buffer = 1 }) eq('none', meths.get_var("filename_executed")) - meths.do_autocmd("CursorHoldI", { buffer = tonumber(meths.get_current_buf()) }) + meths.exec_autocmd("CursorHoldI", { buffer = tonumber(meths.get_current_buf()) }) eq('__init__.py', meths.get_var("filename_executed")) -- Reset filename meths.set_var("filename_executed", 'none') - meths.do_autocmd("CursorHoldI", { pattern = '__init__.py' }) + meths.exec_autocmd("CursorHoldI", { pattern = '__init__.py' }) eq('__init__.py', meths.get_var("filename_executed")) end) @@ -578,9 +578,9 @@ describe('autocmd api', function() command = 'let g:matched = "matched"' }) - meths.do_autocmd("User", { pattern = "OtherCommand" }) + meths.exec_autocmd("User", { pattern = "OtherCommand" }) eq('none', meths.get_var('matched')) - meths.do_autocmd("User", { pattern = "TestCommand" }) + meths.exec_autocmd("User", { pattern = "TestCommand" }) eq('matched', meths.get_var('matched')) end) @@ -594,7 +594,7 @@ describe('autocmd api', function() }) eq(false, meths.get_var("group_executed")) - meths.do_autocmd("FileType", { group = auid }) + meths.exec_autocmd("FileType", { group = auid }) eq(true, meths.get_var("group_executed")) end) @@ -609,7 +609,7 @@ describe('autocmd api', function() }) eq(false, meths.get_var("group_executed")) - meths.do_autocmd("FileType", { group = auname }) + meths.exec_autocmd("FileType", { group = auname }) eq(true, meths.get_var("group_executed")) end) end) |