From f4bb0c5641a0e6c9ac3675ddd794ca78099d8510 Mon Sep 17 00:00:00 2001
From: Iron-E <36409591+Iron-E@users.noreply.github.com>
Date: Tue, 28 Feb 2023 09:05:58 +0000
Subject: [PATCH] feat(persistence): `pre_save` option to call before saving
 (#22)

* 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
---
 README.md                  | 1 +
 doc/persistence.nvim.txt   | 1 +
 doc/persistence.txt        | 1 +
 lua/persistence/config.lua | 1 +
 lua/persistence/init.lua   | 4 ++++
 5 files changed, 8 insertions(+)

diff --git a/README.md b/README.md
index ef20707..0fa489b 100644
--- a/README.md
+++ b/README.md
@@ -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
 }
 ```
 
diff --git a/doc/persistence.nvim.txt b/doc/persistence.nvim.txt
index eace48b..44d3f67 100644
--- a/doc/persistence.nvim.txt
+++ b/doc/persistence.nvim.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
     }
 <
 
diff --git a/doc/persistence.txt b/doc/persistence.txt
index a6467ac..acbe0d8 100644
--- a/doc/persistence.txt
+++ b/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
     }
 <
 
diff --git a/lua/persistence/config.lua b/lua/persistence/config.lua
index 4c584c9..41eb06e 100644
--- a/lua/persistence/config.lua
+++ b/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
diff --git a/lua/persistence/init.lua b/lua/persistence/init.lua
index 2398f66..7d01808 100644
--- a/lua/persistence/init.lua
+++ b/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,
   })