A NeoVim plugin for saving your work before the world collapses or you type :qa!
Demo
- Automatically save current file(s).
- Set conditions that files must meet to be saved (e.g. filetype, existence, ...).
- Set events that will trigger the plugin.
- Add custom hooks (e.g. print a message when the plugin is turned off).
- Toggle the plugin on and off.
Checkout the CHANGELOG.md file for more information on the notices below:
- 15-07-21: Implemented debounce_delay setting thanks to #7 and "Preserve cursor marks" feature when saving thanks to #8.
- 04-07-21: Fixed #1.
- 01-07-21: Just released!
- NeoVim nightly (>=v0.5.0)
You can use your favorite plugin manager for this. Here are some examples with the most popular ones:
Plug 'Pocco81/AutoSave.nvim'use "Pocco81/AutoSave.nvim"Plugin 'Pocco81/AutoSave.nvim'NeoBundleFetch 'Pocco81/AutoSave.nvim'As it's stated in the TL;DR, there are already some sane defaults that you may like, however you can change them to match your taste. These are the defaults:
enabled = true,
execution_message = function ()
return "AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S")
end,
-- execution_message = "Saved",
events = {"InsertLeave", "TextChanged"},
conditions = {
exists = true,
filename_is_not = {},
filetype_is_not = {},
modifiable = true,
},
write_all_buffers = false,
on_off_commands = false,
clean_command_line_interval = 0,
debounce_delay = 135The way you setup the settings on your config varies on whether you are using vimL for this or Lua.
For init.lua
local autosave = require("autosave")
autosave.setup(
{
enabled = true,
execution_message = "AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S"),
events = {"InsertLeave", "TextChanged"},
conditions = {
exists = true,
filename_is_not = {},
filetype_is_not = {},
modifiable = true
},
write_all_buffers = false,
on_off_commands = true,
clean_command_line_interval = 0,
debounce_delay = 135
}
)For init.vim
lua << EOF
local autosave = require("autosave")
autosave.setup(
{
enabled = true,
execution_message = "AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S"),
events = {"InsertLeave", "TextChanged"},
conditions = {
exists = true,
filename_is_not = {},
filetype_is_not = {},
modifiable = true
},
write_all_buffers = false,
on_off_commands = true,
clean_command_line_interval = 0,
debounce_delay = 135
}
)
EOFFor instructions on how to configure the plugin, check out the configuration section.
This depends on your plugin manager. If, for example, you are using Packer.nvim, you can update it with this command:
:PackerUpdateAll the commands follow the camel casing naming convention and have the AS prefix so that it's easy to remember that they are part of this plugin. These are all of them:
:ASToggle: toggles AutoSave.nvim on and off.
:ASOn: turns AutoSave.nvim on.:ASOff: turns AutoSave.nvim off.
vim.g.autosave_state: use this to check whether AutoSave is on (true) or off (false).
Although settings already have self-explanatory names, here is where you can find info about each one of them and their classifications!
enabled:: (Boolean) if true, enables AutoSave.nvim at startup (Note: this is not for loading the plugin it self but rather the "auto-save" functionality. This is like running:ASOn).execution_message: (String) message to be displayed when saving [a] file[s].events: (Table): events that will trigger the plugin.write_all_buffers: (Boolean) if true, writes to all modifiable buffers that meet theconditions.on_off_commands: (Boolean) if true, enables extra commands for toggling the plugin on and off (:ASOnand:ASOff).clean_command_line_interval(Integer) if greater than 0, cleans the command line after x amount of milliseconds after printing theexecution_message.debounce_delay(Integer) if greater than 0, saves the file at most everydebounce_delaymilliseconds, vastly improving editing performance. If 0 then saves are performed immediately aftereventsoccur. It's recommend to leave the default value (135), which is just long enough to reduce unnecessary saves, but short enough that you don't notice the delay.
These are the conditions that every file must meet so that it can be saved. If every file to be auto-saved doesn't meet all of the conditions it won't be saved.
exists: (Boolean) if true, enables this condition. If the file doesn't exist it won't save it (e.g. if younvim stuff.txtand don't save the file then this condition won't be met)modifiable: (Boolean) if true, enables this condition. If the file isn't modifiable, then this condition isn't met.filename_is_not: (Table, Strings) if there is one or more filenames (should be strings) in the table, it enables this condition. Use this to exclude filenames that you don't want to automatically save.filetype_is_not: (Table, Strings) if there is one or more filetypes (should be strings) in the table, it enables this condition. Use this to exclude filetypes that you don't want to automatically save.
Use them to execute code at certain events [described by their names]. These are the ones available:
| Function | Description |
|---|---|
| hook_before_on() | Before toggling the plugin on |
| hook_after_on() | After toggling the plugin on |
| hook_before_off() | Before toggling the plugin off |
| hook_after_off() | After toggling the plugin off |
| hook_before_saving() | Before its even checked if the current file(s) meet the conditions |
| hook_after_saving | After saving the file(s) |
They can be used like so:
local autosave = require("autosave")
autosave.hook_after_off = function ()
print("I was toggled off!")
endThe hook_before_saving hook can be used to abort saving based on some condition:
local autosave = require("autosave")
autosave.hook_before_saving = function ()
if <condition> then
vim.g.auto_save_abort = true -- Save will be aborted
end
end- Many other plugins/stuff that you may use rely on using the same events as the ones AutoSave uses by default or may need to interact with the buffer before it's saved. Mainly being plugins for snippets support. If this is your case, consider increasing the
debounce_delaysetting to your needs.
- Q: "How can I view the doc from NeoVim?"
- A: Use
:help AutoSave.nvim
Pull Requests are welcomed as long as they are properly justified and there are no conflicts. If your PR has something to do with the README or in general related with the documentation, I'll gladly merge it! Also, when writing code for the project you must use the .editorconfig file on your editor so as to "maintain consistent coding styles". For instructions on how to use this file refer to EditorConfig's website.
The following projects inspired the creation of AutoSave.nvim. If possible, go check them out to see why they are so amazing :]
- 907th/vim-auto-save: Automatically save changes to disk in Vim.
AutoSave.nvim is released under the GPL v3.0 license. It grants open-source permissions for users including:
- The right to download and run the software freely
- The right to make changes to the software as desired
- The right to redistribute copies of the software
- The right to modify and distribute copies of new versions of the software
For more convoluted language, see the LICENSE file.
High Priority
- None
Low Priority
- None
Enjoy!