f4bb0c5641
* feat(persistence): `pre_save` option to call before saving This commit adds the `pre_save` option, which is a `fun()|nil` that will be called (if present) before saving the current session. Use cases include filtering buffers, executing `User` autocmds, etc. * docs: `pre_save` option
💾 Persistence
Persistence is a simple lua plugin for automated session management.
✨ Features
- automatically saves the active session under
~/.local/state/nvim/sessionson exit - simple API to restore the current or last session
⚡️ Requirements
- Neovim >= 0.7.2
📦 Installation
Install the plugin with your preferred package manager:
packer
-- Lua
use({
"folke/persistence.nvim",
event = "BufReadPre", -- this will only start session saving when an actual file was opened
module = "persistence",
config = function()
require("persistence").setup()
end,
})
vim-plug
" Vim Script
Plug 'folke/persistence.nvim'
lua << EOF
require("persistence").setup {
-- your configuration comes here
-- or leave it empty to use the default settings
-- refer to the configuration section below
}
EOF
⚙️ Configuration
Persistence comes with the following defaults:
{
dir = vim.fn.expand(vim.fn.stdpath("state") .. "/sessions/"), -- directory where session files are saved
options = { "buffers", "curdir", "tabpages", "winsize" }, -- sessionoptions used for saving
pre_save = nil, -- a function to call before saving the session
}
🚀 Usage
Persistence works well with plugins like startify or dashboard. It will never restore a session automatically,
but you can of course write an autocmd that does exactly that if you want.
-- restore the session for the current directory
vim.api.nvim_set_keymap("n", "<leader>qs", [[<cmd>lua require("persistence").load()<cr>]], {})
-- restore the last session
vim.api.nvim_set_keymap("n", "<leader>ql", [[<cmd>lua require("persistence").load({ last = true })<cr>]], {})
-- stop Persistence => session won't be saved on exit
vim.api.nvim_set_keymap("n", "<leader>qd", [[<cmd>lua require("persistence").stop()<cr>]], {})