chore(main): release 1.1.0 (#23)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
         with:
           release-type: simple
           package-name: persistence.nvim
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: tag stable versions
         if: ${{ steps.release.outputs.release_created }}
         run: |

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.1.0](https://github.com/folke/persistence.nvim/compare/v1.0.1...v1.1.0) (2023-02-28)
+
+
+### Features
+
+* **persistence:** `pre_save` option to call before saving ([#22](https://github.com/folke/persistence.nvim/issues/22)) ([f4bb0c5](https://github.com/folke/persistence.nvim/commit/f4bb0c5641a0e6c9ac3675ddd794ca78099d8510))
+
 ## [1.0.1](https://github.com/folke/persistence.nvim/compare/v1.0.0...v1.0.1) (2023-01-06)
 
 

README.md

@@ -4,7 +4,7 @@
 
 ## ✨ Features
 
-- automatically saves the active session under `.config/nvim/sessions` on exit
+- automatically saves the active session under `~/.local/state/nvim/sessions` on exit
 - simple API to restore the current or last session
 
 ## ⚡️ Requirements
@@ -52,6 +52,7 @@ 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
 }
 ```
 

doc/persistence.nvim.txt

@@ -1,38 +1,40 @@
-*persistence.nvim.txt*     For Neovim >= 0.8.0    Last change: 2023 January 06
+*persistence.nvim.txt*    For Neovim >= 0.8.0    Last change: 2023 February 28
 
 ==============================================================================
 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|
+  - Features                           |persistence.nvim-persistence-features|
+  - Requirements                   |persistence.nvim-persistence-requirements|
+  - Installation                   |persistence.nvim-persistence-installation|
+  - Configuration                 |persistence.nvim-persistence-configuration|
+  - Usage                                 |persistence.nvim-persistence-usage|
 
 ==============================================================================
 1. Persistence                                  *persistence.nvim-persistence*
 
 **Persistence** is a simple lua plugin for automated session management.
 
-FEATURES                                           *persistence.nvim-features*
+
+FEATURES                               *persistence.nvim-persistence-features*
 
 
-- automatically saves the active session under `.config/nvim/sessions` on exit
+- 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*
+REQUIREMENTS                       *persistence.nvim-persistence-requirements*
 
 
 - Neovim >= 0.7.2
 
 
-INSTALLATION                                   *persistence.nvim-installation*
+INSTALLATION                       *persistence.nvim-persistence-installation*
 
 Install the plugin with your preferred package manager:
 
-PACKER <HTTPS://GITHUB.COM/WBTHOMASON/PACKER.NVIM> ~
+
+PACKER ~
 
 >lua
     -- Lua
@@ -47,7 +49,7 @@ PACKER <HTTPS://GITHUB.COM/WBTHOMASON/PACKER.NVIM> ~
 <
 
 
-VIM-PLUG <HTTPS://GITHUB.COM/JUNEGUNN/VIM-PLUG> ~
+VIM-PLUG ~
 
 >vim
     " Vim Script
@@ -63,7 +65,7 @@ VIM-PLUG <HTTPS://GITHUB.COM/JUNEGUNN/VIM-PLUG> ~
 <
 
 
-CONFIGURATION                                 *persistence.nvim-configuration*
+CONFIGURATION                     *persistence.nvim-persistence-configuration*
 
 Persistence comes with the following defaults:
 
@@ -71,11 +73,12 @@ 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.nvim-usage*
+USAGE                                     *persistence.nvim-persistence-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
@@ -92,7 +95,6 @@ that does exactly that if you want.
     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:

doc/persistence.txt

@@ -71,6 +71,7 @@ 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
     }
 <
 

lua/persistence/config.lua

@@ -1,6 +1,7 @@
 local M = {}
 
 ---@class PersistenceOptions
+---@field pre_save? fun()
 local 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

lua/persistence/init.lua

@@ -30,6 +30,10 @@ function M.start()
   vim.api.nvim_create_autocmd("VimLeavePre", {
     group = vim.api.nvim_create_augroup("persistence", { clear = true }),
     callback = function()
+      if Config.options.pre_save then
+        Config.options.pre_save()
+      end
+
       M.save()
     end,
   })