feat(events): add SelectPre and SelectPost events (#172)

Author: olimorris

.github/workflows/ci.yml

@@ -17,13 +17,13 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - os: ubuntu-20.04
+          - os: ubuntu-latest
             url: https://github.com/neovim/neovim/releases/download/nightly/nvim-linux-x86_64.tar.gz
-          - os: ubuntu-20.04
+          - os: ubuntu-latest
             url: https://github.com/neovim/neovim/releases/download/v0.10.0/nvim-linux64.tar.gz
-          - os: ubuntu-20.04
+          - os: ubuntu-latest
             url: https://github.com/neovim/neovim/releases/download/v0.9.0/nvim-linux64.tar.gz
-          - os: ubuntu-20.04
+          - os: ubuntu-latest
             url: https://github.com/neovim/neovim/releases/download/v0.8.0/nvim-linux64.tar.gz
 
     steps:

README.md

@@ -326,17 +326,19 @@ In this setup, `~/.config` and `~/.local/nvim` are still going to behave in thei
 
 The plugin fires events at various points during its lifecycle:
 
+- `PersistedDeletePre` - For _before_ a session is deleted
+- `PersistedDeletePost` - For _after_ a session is deleted
 - `PersistedLoadPre` - For _before_ a session is loaded
 - `PersistedLoadPost` - For _after_ a session is loaded
-- `PersistedTelescopeLoadPre` - For _before_ a session is loaded via Telescope
-- `PersistedTelescopeLoadPost` - For _after_ a session is loaded via Telescope
 - `PersistedSavePre` - For _before_ a session is saved
 - `PersistedSavePost` - For _after_ a session is saved
-- `PersistedDeletePre` - For _before_ a session is deleted
-- `PersistedDeletePost` - For _after_ a session is deleted
+- `PersistedSelectPre` - For _before_ a session is selected (via `:SessionSelect`)
+- `PersistedSelectPost` - For _after_ a session is selected
 - `PersistedStart` - For when a session has _started_
 - `PersistedStop` - For when a session has _stopped_
 - `PersistedToggle` - For when a session is toggled
+- `PersistedTelescopeLoadPre` - For _before_ a session is loaded via Telescope
+- `PersistedTelescopeLoadPost` - For _after_ a session is loaded via Telescope
 
 These events can be consumed anywhere within your configuration by utilising the `vim.api.nvim_create_autocmd` function.
 
@@ -346,7 +348,7 @@ A commonly requested example is to use the Telescope extension to load a session
 vim.api.nvim_create_autocmd("User", {
   pattern = "PersistedTelescopeLoadPre",
   callback = function(session)
-    -- Save the currently loaded session using the global variable
+    -- Save the currently loaded session passing in the path to the current session
     require("persisted").save({ session = vim.g.persisted_loaded_session })
 
     -- Delete all of the open buffers

lua/persisted/init.lua

@@ -10,6 +10,7 @@ local uv = vim.uv or vim.loop
 
 ---Fire an event
 ---@param event string
+---@return nil
 function M.fire(event)
   vim.api.nvim_exec_autocmds("User", { pattern = "Persisted" .. event })
 end
@@ -34,6 +35,7 @@ end
 
 ---Automatically load the session for the current dir
 ---@param opts? { force?: boolean }
+---@return nil
 function M.autoload(opts)
   opts = opts or {}
 
@@ -48,6 +50,7 @@ end
 
 ---Load a session
 ---@param opts? { last?: boolean, autoload?: boolean, session?: string }
+---@return nil
 function M.load(opts)
   opts = opts or {}
 
@@ -80,6 +83,7 @@ function M.load(opts)
 end
 
 ---Start a session
+---@return nil
 function M.start()
   vim.api.nvim_create_autocmd("VimLeavePre", {
     group = vim.api.nvim_create_augroup("Persisted", { clear = true }),
@@ -93,6 +97,7 @@ function M.start()
 end
 
 ---Stop a session
+---@return nil
 function M.stop()
   vim.g.persisting = false
   pcall(vim.api.nvim_del_augroup_by_name, "Persisted")
@@ -101,6 +106,7 @@ end
 
 ---Save the session
 ---@param opts? { force?: boolean, session?: string }
+---@return nil
 function M.save(opts)
   opts = opts or {}
 
@@ -115,11 +121,12 @@ function M.save(opts)
   M.fire("SavePost")
 end
 
----Delete the current session
----@param opts? { session?: string }
+---Delete a session
+---@param opts? { path?: string }
+---@return nil
 function M.delete(opts)
   opts = opts or {}
-  local session = opts.session or M.current()
+  local session = opts.path or M.current()
 
   if session and uv.fs_stat(session) ~= 0 then
     M.fire("DeletePre")
@@ -141,9 +148,9 @@ function M.branch()
 end
 
 ---Select a session to load
+---@return nil
 function M.select()
-  ---@type { session: string, dir: string, branch?: string }[]
-  local items = {}
+  local items = {} ---@type { session: string, dir: string, branch?: string }[]
   local found = {} ---@type table<string, boolean>
   for _, session in ipairs(M.list()) do
     if uv.fs_stat(session) then
@@ -160,7 +167,7 @@ function M.select()
     end
   end
   vim.ui.select(items, {
-    prompt = "Select a session: ",
+    prompt = "Load a session: ",
     format_item = function(item)
       local name = vim.fn.fnamemodify(item.dir, ":p:~")
       if item.branch then
@@ -170,13 +177,16 @@ function M.select()
     end,
   }, function(item)
     if item then
+      M.fire("SelectPre")
       vim.fn.chdir(item.dir)
       M.load()
+      M.fire("SelectPost")
     end
   end)
 end
 
 ---Determines whether to load, start or stop a session
+---@return nil
 function M.toggle()
   M.fire("Toggle")
   if vim.g.persisting == nil then
@@ -219,6 +229,7 @@ end
 
 ---Setup the plugin
 ---@param opts? table
+---@return nil
 function M.setup(opts)
   config.setup(opts)