diff --git a/README.md b/README.md index a1d0ac7..6f45cad 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc/auto-save.nvim.txt b/doc/auto-save.nvim.txt index 9ebb139..8fadb44 100644 --- a/doc/auto-save.nvim.txt +++ b/doc/auto-save.nvim.txt @@ -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 diff --git a/lua/auto-save/config.lua b/lua/auto-save/config.lua index e2bed50..6867980 100644 --- a/lua/auto-save/config.lua +++ b/lua/auto-save/config.lua @@ -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 @@ -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 diff --git a/lua/auto-save/init.lua b/lua/auto-save/init.lua index 97c0b55..300f696 100644 --- a/lua/auto-save/init.lua +++ b/lua/auto-save/init.lua @@ -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)