Skip to content

Commit

Permalink
chore!: fix cancel_deferred_save event typo (#58)
Browse files Browse the repository at this point in the history
Copied over from #48

---------

Co-authored-by: Sergey Kochetkov <skoch13@pm.me>
  • Loading branch information
primeapple and skoch13 authored Oct 9, 2024
1 parent 1747cf2 commit 95544f7
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ EOF
trigger_events = { -- See :h events
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`)
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
-- return true: if buffer is ok to be saved
Expand Down
2 changes: 1 addition & 1 deletion doc/auto-save.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ VIM-PLUG *auto-save.nvim-installation-vim-plug*
trigger_events = { -- See :h events
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`)
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
-- return true: if buffer is ok to be saved
Expand Down
13 changes: 11 additions & 2 deletions lua/auto-save/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Config = {
--- @type TriggerEvent[]?
defer_save = { "InsertLeave", "TextChanged" }, -- vim events that trigger a deferred save (saves after `debounce_delay`)
--- @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
-- return true: if buffer is ok to be saved
Expand All @@ -34,13 +34,22 @@ function Config:handle_deprecations(custom_opts)
custom_opts["execution_message"] = nil
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
end

function Config:set_options(custom_opts)
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)
end
Expand Down
2 changes: 1 addition & 1 deletion lua/auto-save/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ function M.on()
group = augroup,
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)
if should_be_saved(opts.buf) then
cancel_timer(opts.buf)
Expand Down

0 comments on commit 95544f7

Please sign in to comment.