zoriya/auto-save.nvim
1
0
Fork 0
mirror of https://github.com/zoriya/auto-save.nvim.git synced 2025-12-06 06:36:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore!: fix cancel_deferred_save event typo (#58)

Browse Source 
Copied over from https://github.com/okuuva/auto-save.nvim/pull/48

---------

Co-authored-by: Sergey Kochetkov <skoch13@pm.me>
This commit is contained in:
Toni Müller
2024-10-09 13:06:36 +02:00
committed by GitHub
parent 1747cf21c6
commit 95544f7467
4 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -97,7 +97,7 @@ EOF
trigger_events = { -- See :h events trigger_events = { -- See :h events
immediate_save = { "BufLeave", "FocusLost" }, -- vim events that trigger an immediate save immediate_save = { "BufLeave", "FocusLost" }, -- vim events that trigger an immediate save
defer_save = { "InsertLeave", "TextChanged" }, -- vim events that trigger a deferred save (saves after `debounce_delay`) defer_save = { "InsertLeave", "TextChanged" }, -- vim events that trigger a deferred save (saves after `debounce_delay`)
cancel_defered_save = { "InsertEnter" }, -- vim events that cancel a pending deferred save cancel_deferred_save = { "InsertEnter" }, -- vim events that cancel a pending deferred save
}, },
-- function that takes the buffer handle and determines whether to save the current buffer or not -- function that takes the buffer handle and determines whether to save the current buffer or not
-- return true: if buffer is ok to be saved -- return true: if buffer is ok to be saved

2
doc/auto-save.nvim.txt
View File

@@ -104,7 +104,7 @@ VIM-PLUG *auto-save.nvim-installation-vim-plug*
trigger_events = { -- See :h events trigger_events = { -- See :h events
immediate_save = { "BufLeave", "FocusLost" }, -- vim events that trigger an immediate save immediate_save = { "BufLeave", "FocusLost" }, -- vim events that trigger an immediate save
defer_save = { "InsertLeave", "TextChanged" }, -- vim events that trigger a deferred save (saves after `debounce_delay`) defer_save = { "InsertLeave", "TextChanged" }, -- vim events that trigger a deferred save (saves after `debounce_delay`)
cancel_defered_save = { "InsertEnter" }, -- vim events that cancel a pending deferred save cancel_deferred_save = { "InsertEnter" }, -- vim events that cancel a pending deferred save
}, },
-- function that takes the buffer handle and determines whether to save the current buffer or not -- function that takes the buffer handle and determines whether to save the current buffer or not
-- return true: if buffer is ok to be saved -- return true: if buffer is ok to be saved

13
lua/auto-save/config.lua
View File

@@ -8,7 +8,7 @@ Config = {
--- @type TriggerEvent[]? --- @type TriggerEvent[]?
defer_save = { "InsertLeave", "TextChanged" }, -- vim events that trigger a deferred save (saves after `debounce_delay`) defer_save = { "InsertLeave", "TextChanged" }, -- vim events that trigger a deferred save (saves after `debounce_delay`)
--- @type TriggerEvent[]? --- @type TriggerEvent[]?
cancel_defered_save = { "InsertEnter" }, -- vim events that cancel a pending deferred save cancel_deferred_save = { "InsertEnter" }, -- vim events that cancel a pending deferred save
}, },
-- function that takes the buffer handle and determines whether to save the current buffer or not -- function that takes the buffer handle and determines whether to save the current buffer or not
-- return true: if buffer is ok to be saved -- return true: if buffer is ok to be saved
@@ -34,13 +34,22 @@ function Config:handle_deprecations(custom_opts)
custom_opts["execution_message"] = nil custom_opts["execution_message"] = nil
end end
if custom_opts["trigger_events"] and custom_opts["trigger_events"]["cancel_defered_save"] then
vim.notify(
"The `cancel_defered_save` config option in the auto-save.nvim plugin has been renamed to `cancel_deferred_save`.",
vim.log.levels.WARN
)
custom_opts["trigger_events"]["cancel_deferred_save"] = custom_opts["trigger_events"]["cancel_defered_save"]
custom_opts["trigger_events"]["cancel_defered_save"] = nil
end
return custom_opts return custom_opts
end end
function Config:set_options(custom_opts) function Config:set_options(custom_opts)
custom_opts = custom_opts or {} custom_opts = custom_opts or {}
custom_opts = self.handle_deprecations(custom_opts) custom_opts = self:handle_deprecations(custom_opts)
self.opts = vim.tbl_deep_extend("keep", custom_opts, self.opts) self.opts = vim.tbl_deep_extend("keep", custom_opts, self.opts)
end end

2
lua/auto-save/init.lua
View File

@@ -129,7 +129,7 @@ function M.on()
group = augroup, group = augroup,
desc = "Save a buffer after the `debounce_delay`", desc = "Save a buffer after the `debounce_delay`",
}) })
autocmds.create_autocmd_for_trigger_events(events.cancel_defered_save, { autocmds.create_autocmd_for_trigger_events(events.cancel_deferred_save, {
callback = function(opts) callback = function(opts)
if should_be_saved(opts.buf) then if should_be_saved(opts.buf) then
cancel_timer(opts.buf) cancel_timer(opts.buf)