Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willothy/savior.nvim
Customizable, event-based auto saving for Neovim
https://github.com/willothy/savior.nvim
auto-save lsp-server lua neovim neovim-lua neovim-plugin
Last synced: 26 days ago
JSON representation
Customizable, event-based auto saving for Neovim
- Host: GitHub
- URL: https://github.com/willothy/savior.nvim
- Owner: willothy
- License: mit
- Created: 2023-07-19T11:29:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-24T08:01:28.000Z (7 months ago)
- Last Synced: 2024-10-04T13:09:57.447Z (about 1 month ago)
- Topics: auto-save, lsp-server, lua, neovim, neovim-lua, neovim-plugin
- Language: Lua
- Homepage:
- Size: 46.9 KB
- Stars: 23
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Savior.nvim
Hassle-free autosaving plugin for Neovim. It just works, and it gives you nice notifications when things are being saved.
Saves are performed on a set interval as well as based on events, and can be immediate or deferred depending on the event.
Before saving, each buffer goes through a list of predicates that determine whether it is safe to save. If any of these conditions fails,
the buffer is not saved. The events, conditions and delays can all be easily customized.
Features:
- Event-based autosaving, both deferred and immediate
- Interval-based autosaving
- Condition stack to determine if it is safe to save
- Pretty notifications using `fidget.nvim`
- Written with performance in mind
Requires `fidget.nvim`.
## Installation
with `folke/lazy.nvim`:
```lua
local spec = {
"willothy/savior.nvim",
dependencies = { "j-hui/fidget.nvim" },
event = { "InsertEnter", "TextChanged" },
config = true
}
```
## Configuration
savior comes with the following defaults:
```lua
-- Note: the default config will be automatically applied,
-- you do not need to copy-paste this whole configuration.
-- Only include what you want to change, and the default and custom
-- tables will be recursively merged.
local savior = require("savior")
savior.setup({
events = {
immediate = {
"FocusLost",
"BufLeave",
},
deferred = {
"InsertLeave",
"TextChanged",
},
cancel = {
"InsertEnter",
"BufWritePost",
"TextChanged",
},
},
callbacks = {},
conditions = {
savior.conditions.is_file_buf,
savior.conditions.not_of_filetype({
"gitcommit",
"gitrebase",
}),
savior.conditions.is_named,
savior.conditions.file_exists,
savior.conditions.has_no_errors,
},
throttle_ms = 3000,
interval_ms = 30000,
defer_ms = 1000,
-- Set to false to disable fidget.nvim notifications
notify = true
})
```
## Builtin conditions
Conditions have the signature `fun(buf: bufnr): boolean`.
The builtin conditions are:
```lua
-- Ensures that `b:buftype == ""`
function conditions.is_file_buf(bufnr)
end
```
```lua
-- Ensures that a buffer is modified before saving
function conditions.is_modified(bufnr)
end
```
```lua
-- Ensures that a buffer is listed before saving
function conditions.is_listed(bufnr)
end
```
```lua
-- Ensures that the buffer is named (even though vim will do this anyways, we want to silence the warning)
function conditions.is_named(bufnr)
end
```
```lua
-- Ensures that the buffer has no diagnostic / LSP errors before saving
function conditions.has_no_errors(bufnr)
end
```
```lua
-- Checks if the buffer's underlying file exists before writing
function conditions.file_exists(bufnr)
end
```
```lua
-- This is a special condition that is created dynamically based on the filetypes provided.
-- It ensures that autosaves aren't run on files of the provided types.
-- Example shown in the default config.
--
---@type fun(filetypes: string[]): fun(buf: bufnr):boolean
function conditions.not_of_filetype(filetypes)
return function(bufnr)
-- ...
end
end
```