bryan
/
persisted.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: clean up README.md and test spec

main
olimorris 2022-03-12 08:46:54 +00:00
parent 254663b3ce
commit 38cf66b8f8
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -28,6 +28,7 @@ Install the plugin with your preferred package manager:
-- Lua -- Lua
use({ use({
"olimorris/persisted.nvim", "olimorris/persisted.nvim",
--module = "persisted", -- Consider lazy loading if you use a dashboard or startup screen
config = function() config = function()
require("persisted").setup() require("persisted").setup()
end, end,
@ -88,10 +89,11 @@ To use the plugin, the commands below are available:
- `SessionToggle` - Determines whether to load, start or stop a session - `SessionToggle` - Determines whether to load, start or stop a session
> **Note:** The author only binds `SessionToggle` to a keymap for simplicity. > **Note:** The author only binds `SessionToggle` to a keymap for simplicity.
> **Remember:** These will not work out of the box if you're lazy loading.
### Callbacks ### Callbacks
The plugin allows for _before_ and _after_ callbacks to be executed relative to the session. This is achieved via the `before_save` and `after_save` configuration options. The plugin allows for _before_ and _after_ callbacks to be executed relative to the session being saved. This is achieved via the `before_save` and `after_save` configuration options.
> **Note:** The author uses a _before_ callback to ensure that [minimap.vim](https://github.com/wfxr/minimap.vim) is not written into the session. Its presence prevents the exact buffer and cursor position from being restored when loading a session. > **Note:** The author uses a _before_ callback to ensure that [minimap.vim](https://github.com/wfxr/minimap.vim) is not written into the session. Its presence prevents the exact buffer and cursor position from being restored when loading a session.

1
tests/default_settings_spec.lua
View File

@ -1,4 +1,3 @@
local e = vim.fn.fnameescape
local session_dir = vim.fn.getcwd() .. "/tests/data/" local session_dir = vim.fn.getcwd() .. "/tests/data/"
require("persisted").setup({ require("persisted").setup({
dir = session_dir dir = session_dir