7f1e8ce997
🤖 I have created a release *beep* *boop* --- ## [3.0.0](https://github.com/folke/persistence.nvim/compare/v2.0.0...v3.0.0) (2024-07-06) ### ⚠ BREAKING CHANGES * opts.need specifieds how many buffers should be open for saving. Replaces save_empty. Closes #19 * removed load_pre/load_post/save_pre/save_post in favor of events. Check the readme * removed `opts.options`. Use `vim.o.sessionoptions` instead. ### Features * added `require("persistence").select()` to select a session to load ([5346b53](5346b5346a)) * opts.need specifieds how many buffers should be open for saving. Replaces save_empty. Closes [#19](https://github.com/folke/persistence.nvim/issues/19) ([7bb5755](7bb575517c)) * persistence.active. Check if a session saving is active ([f0ac0e9](f0ac0e981e)) * **persistence:** add `pre-` and `post-` load hooks ([#24](https://github.com/folke/persistence.nvim/issues/24)) ([3d443bd](3d443bd0a7)) * removed `opts.options`. Use `vim.o.sessionoptions` instead. ([eb5622e](eb5622edae)) * removed load_pre/load_post/save_pre/save_post in favor of events. Check the readme ([f58a838](f58a838282)) * sessions per branch. Closes [#9](https://github.com/folke/persistence.nvim/issues/9) ([cd0054e](cd0054e6a4)) ### Bug Fixes * don't save `gitrebase` session ([#44](https://github.com/folke/persistence.nvim/issues/44)) ([9dbe264](9dbe2648c6)) * opts.need ([9c0e522](9c0e5227fa)) * remove expand() as stdpath() expands itself ([#50](https://github.com/folke/persistence.nvim/issues/50)) ([a2fd3d9](a2fd3d9965)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
💾 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:
lazy.nvim
-- Lua
{
"folke/persistence.nvim",
event = "BufReadPre", -- this will only start session saving when an actual file was opened
opts = {
-- add any custom options here
}
}
⚙️ Configuration
Persistence comes with the following defaults:
{
dir = vim.fn.stdpath("state") .. "/sessions/", -- directory where session files are saved
-- minimum number of file buffers that need to be open to save
-- Set to 0 to always save
need = 1,
branch = true, -- use git branch to save session
}
Tip
To configure what should be saved in your session, check :h 'sessionoptions'
🚀 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.
-- load the session for the current directory
vim.keymap.set("n", "<leader>qs", function() require("persistence").load() end)
-- select a session to load
vim.keymap.set("n", "<leader>qS", function() require("persistence").select() end)
-- load the last session
vim.keymap.set("n", "<leader>ql", function() require("persistence").load({ last = true }) end)
-- stop Persistence => session won't be saved on exit
vim.keymap.set("n", "<leader>qd", function() require("persistence").stop() end)
📅 Events
- PersistenceLoadPre: before loading a session
- PersistenceLoadPost: after loading a session
- PersistenceSavePre: before saving a session
- PersistenceSavePost: after saving a session