Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pocco81/auto-save.nvim
🧶 Automatically save your changes in NeoVim
https://github.com/pocco81/auto-save.nvim
lua neovim neovim-plugin save-editor save-files
Last synced: 14 days ago
JSON representation
🧶 Automatically save your changes in NeoVim
- Host: GitHub
- URL: https://github.com/pocco81/auto-save.nvim
- Owner: pocco81
- License: gpl-3.0
- Created: 2021-07-01T16:41:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T20:02:57.000Z (6 months ago)
- Last Synced: 2024-08-04T02:06:35.657Z (3 months ago)
- Topics: lua, neovim, neovim-plugin, save-editor, save-files
- Language: Lua
- Homepage:
- Size: 198 KB
- Stars: 622
- Watchers: 4
- Forks: 64
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-neovim - pocco81/auto-save.nvim - Save your work before the world collapses or you type :qa! (Editing Support / Scrollbar)
README
🧶 auto-save.nvim
Automatically save your changes in NeoVim
### 📢 Disclaimer: Breaking Change
This plugin has been renamed from `AutoSave` to `auto-save`, and this repository has accordingly moved from `pocco81/AutoSave.nvim` to `pocco81/auto-save.nvim`. To prevent errors with your configuration, make sure to update both the name and the repository url in your config!
### 📋 Features
- automatically save your changes so the world doesn't collapse
- highly customizable:
- conditionals to assert whether to save or not
- execution message (it can be dimmed and personalized)
- events that trigger auto-save
- debounce the save with a delay
- multiple callbacks
- automatically clean the message area
### 📚 Requirements
- Neovim >= 0.5.0
### 📦 Installation
Install the plugin with your favourite package manager:
```lua
use({
"Pocco81/auto-save.nvim",
config = function()
require("auto-save").setup {
-- your config goes here
-- or just leave it empty :)
}
end,
})
```
```vim
Plug 'Pocco81/auto-save.nvim'
lua << EOF
require("auto-save").setup {
-- your config goes here
-- or just leave it empty :)
}
EOF
```
### ⚙️ Configuration
**auto-save** comes with the following defaults:
```lua
{
enabled = true, -- start auto-save when the plugin is loaded (i.e. when your package manager loads it)
execution_message = {
message = function() -- message to print on save
return ("AutoSave: saved at " .. vim.fn.strftime("%H:%M:%S"))
end,
dim = 0.18, -- dim the color of `message`
cleaning_interval = 1250, -- (milliseconds) automatically clean MsgArea after displaying `message`. See :h MsgArea
},
trigger_events = {"InsertLeave", "TextChanged"}, -- vim events that trigger auto-save. See :h events
-- function that determines whether to save the current buffer or not
-- return true: if buffer is ok to be saved
-- return false: if it's not ok to be saved
condition = function(buf)
local fn = vim.fn
local utils = require("auto-save.utils.data")
if
fn.getbufvar(buf, "&modifiable") == 1 and
utils.not_in(fn.getbufvar(buf, "&filetype"), {}) then
return true -- met condition(s), can save
end
return false -- can't save
end,
write_all_buffers = false, -- write all buffers when the current one meets `condition`
debounce_delay = 135, -- saves the file at most every `debounce_delay` milliseconds
callbacks = { -- functions to be executed at different intervals
enabling = nil, -- ran when enabling auto-save
disabling = nil, -- ran when disabling auto-save
before_asserting_save = nil, -- ran before checking `condition`
before_saving = nil, -- ran before doing the actual save
after_saving = nil -- ran after doing the actual save
}
}
```
Additionally you may want to set up a key mapping to toggle auto-save:
```lua
vim.api.nvim_set_keymap("n", "n", ":ASToggle", {})
```
### 🪴 Usage
Besides running auto-save at startup (if you have `enabled = true` in your config), you may as well:
- `ASToggle`: toggle auto-save