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
100 lines
3.3 KiB
Plaintext
100 lines
3.3 KiB
Plaintext
*persistence.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 January 23
|
|
|
|
==============================================================================
|
|
Table of Contents *persistence.nvim-table-of-contents*
|
|
|
|
1. Persistence |persistence.nvim-persistence|
|
|
- Features |persistence.nvim-features|
|
|
- Requirements |persistence.nvim-requirements|
|
|
- Installation |persistence.nvim-installation|
|
|
- Configuration |persistence.nvim-configuration|
|
|
- Usage |persistence.nvim-usage|
|
|
|
|
==============================================================================
|
|
1. Persistence *persistence.nvim-persistence*
|
|
|
|
**Persistence** is a simple lua plugin for automated session management.
|
|
|
|
FEATURES *persistence.nvim-features*
|
|
|
|
|
|
- automatically saves the active session under `~/.local/state/nvim/sessions` on exit
|
|
- simple API to restore the current or last session
|
|
|
|
|
|
REQUIREMENTS *persistence.nvim-requirements*
|
|
|
|
|
|
- Neovim >= 0.7.2
|
|
|
|
|
|
INSTALLATION *persistence.nvim-installation*
|
|
|
|
Install the plugin with your preferred package manager:
|
|
|
|
PACKER <HTTPS://GITHUB.COM/WBTHOMASON/PACKER.NVIM> ~
|
|
|
|
>lua
|
|
-- 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 <HTTPS://GITHUB.COM/JUNEGUNN/VIM-PLUG> ~
|
|
|
|
>vim
|
|
" 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.nvim-configuration*
|
|
|
|
Persistence comes with the following defaults:
|
|
|
|
>lua
|
|
{
|
|
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.nvim-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.
|
|
|
|
>lua
|
|
-- 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>]], {})
|
|
<
|
|
|
|
|
|
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|