chore(main): release 3.1.0 (#66)

🤖 I have created a release *beep* *boop*
---


##
[3.1.0](https://github.com/folke/persistence.nvim/compare/v3.0.1...v3.1.0)
(2024-07-07)


### Features

* **load:** fallback to regular session when branch session does not
exist (yet)
([a93748a](a93748acdb))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

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

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -75,7 +75,7 @@ body:
         -- install plugins
         local plugins = {
           "folke/tokyonight.nvim",
-          "folke/persistence.nvim",
+          { "folke/persistence.nvim", opts = {} },
           -- add any other plugins here
         }
         require("lazy").setup(plugins, {

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/folke/persistence.nvim/discussions
+    about: Use Github discussions instead

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Description
+
+<!-- Describe the big picture of your changes to communicate to the maintainers
+  why we should accept this pull request. -->
+
+## Related Issue(s)
+
+<!--
+  If this PR fixes any issues, please link to the issue here.
+  - Fixes #<issue_number>
+-->
+
+## Screenshots
+
+<!-- Add screenshots of the changes if applicable. -->
+

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yml

@@ -1,72 +1,14 @@
 name: CI
+
 on:
   push:
+    branches: [main, master]
   pull_request:
 
 jobs:
-  tests:
+  ci:
-    strategy:
+    uses: folke/github/.github/workflows/ci.yml@main
-      matrix:
+    secrets: inherit
-        # os: [ubuntu-latest, windows-latest]
-        os: [ubuntu-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install Neovim
-        shell: bash
-        run: |
-          mkdir -p /tmp/nvim
-          wget -q https://github.com/neovim/neovim/releases/download/nightly/nvim.appimage -O /tmp/nvim/nvim.appimage
-          cd /tmp/nvim
-          chmod a+x ./nvim.appimage
-          ./nvim.appimage --appimage-extract
-          echo "/tmp/nvim/squashfs-root/usr/bin/" >> $GITHUB_PATH
-      - name: Run Tests
-        run: |
-          nvim --version
-          [ ! -d tests ] && exit 0
-          nvim --headless -u tests/init.lua -c "PlenaryBustedDirectory tests/ {minimal_init = 'tests/init.lua', sequential = true}"
-  docs:
-    runs-on: ubuntu-latest
-    needs: tests
-    if: ${{ github.ref == 'refs/heads/main' }}
-    steps:
-      - uses: actions/checkout@v3
-      - name: panvimdoc
-        uses: kdheepak/panvimdoc@main
     with:
-          vimdoc: persistence.nvim
+      plugin: persistence.nvim
-          version: "Neovim >= 0.8.0"
+      repo: folke/persistence.nvim
-          demojify: true
-          treesitter: true
-      - name: Push changes
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: "chore(build): auto-generate vimdoc"
-          commit_user_name: "github-actions[bot]"
-          commit_user_email: "github-actions[bot]@users.noreply.github.com"
-          commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
-  release:
-    name: release
-    if: ${{ github.ref == 'refs/heads/main' }}
-    needs:
-      - docs
-      - tests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: google-github-actions/release-please-action@v3
-        id: release
-        with:
-          release-type: simple
-          package-name: persistence.nvim
-      - uses: actions/checkout@v3
-      - name: tag stable versions
-        if: ${{ steps.release.outputs.release_created }}
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email github-actions[bot]@users.noreply.github.com
-          git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/google-github-actions/release-please-action.git"
-          git tag -d stable || true
-          git push origin :stable || true
-          git tag -a stable -m "Last Stable Release"
-          git push origin stable

.github/workflows/labeler.yml

@@ -0,0 +1,8 @@
+name: "PR Labeler"
+on:
+  - pull_request_target
+
+jobs:
+  labeler:
+    uses: folke/github/.github/workflows/labeler.yml@main
+    secrets: inherit

.github/workflows/pr.yml

@@ -0,0 +1,18 @@
+name: PR Title
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+      - ready_for_review
+
+permissions:
+  pull-requests: read
+
+jobs:
+  pr-title:
+    uses: folke/github/.github/workflows/pr.yml@main
+    secrets: inherit

.github/workflows/stale.yml

@@ -0,0 +1,10 @@
+name: Stale Issues & PRs
+
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+jobs:
+  ci:
+    uses: folke/github/.github/workflows/stale.yml@main
+    secrets: inherit

.github/workflows/update.yml

@@ -0,0 +1,12 @@
+name: Update Repo
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Run every hour
+    - cron: "0 * * * *"
+
+jobs:
+  ci:
+    uses: folke/github/.github/workflows/update.yml@main
+    secrets: inherit

.gitignore

@@ -1,8 +1,9 @@
-tt.*
-.tests
-doc/tags
-debug
-.repro
-foo.*
 *.log
-data
+/.repro
+/.tests
+/build
+/debug
+/doc/tags
+foo.*
+node_modules
+tt.*

CHANGELOG.md

@@ -1,5 +1,47 @@
 # Changelog
 
+## [3.1.0](https://github.com/folke/persistence.nvim/compare/v3.0.1...v3.1.0) (2024-07-07)
+
+
+### Features
+
+* **load:** fallback to regular session when branch session does not exist (yet) ([a93748a](https://github.com/folke/persistence.nvim/commit/a93748acdb2e7bc4389b3738b4c787b764c3b2a6))
+
+## [3.0.1](https://github.com/folke/persistence.nvim/compare/v3.0.0...v3.0.1) (2024-07-07)
+
+
+### Bug Fixes
+
+* branch detection. Closes [#62](https://github.com/folke/persistence.nvim/issues/62) ([a1d37fa](https://github.com/folke/persistence.nvim/commit/a1d37fa32ef9431f6a57c217ba5c456d20834679))
+* **branch:** escape branch name. Fixes [#65](https://github.com/folke/persistence.nvim/issues/65) ([1565ca0](https://github.com/folke/persistence.nvim/commit/1565ca0af2d93ee94335c2950d92bc133c90aa82))
+* windows ([2d83b1a](https://github.com/folke/persistence.nvim/commit/2d83b1a5c3fe5b2251866f5263fb9607db8d64c0))
+
+## [3.0.0](https://github.com/folke/persistence.nvim/compare/v2.0.0...v3.0.0) (2024-07-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* opts.need specifieds how many buffers should be open for saving. Replaces save_empty. Closes #19
+* removed load_pre/load_post/save_pre/save_post in favor of events. Check the readme
+* removed `opts.options`. Use `vim.o.sessionoptions` instead.
+
+### Features
+
+* added `require("persistence").select()` to select a session to load ([5346b53](https://github.com/folke/persistence.nvim/commit/5346b5346a2dd1732ae84f05251ecb704f35df87))
+* opts.need specifieds how many buffers should be open for saving. Replaces save_empty. Closes [#19](https://github.com/folke/persistence.nvim/issues/19) ([7bb5755](https://github.com/folke/persistence.nvim/commit/7bb575517cebbc2b172caa04581dc5d91be90136))
+* persistence.active. Check if a session saving is active ([f0ac0e9](https://github.com/folke/persistence.nvim/commit/f0ac0e981e4c864df11e613636a23c5bad09376d))
+* **persistence:** add `pre-` and `post-` load hooks ([#24](https://github.com/folke/persistence.nvim/issues/24)) ([3d443bd](https://github.com/folke/persistence.nvim/commit/3d443bd0a7e1d9eebfa37321fc8118d8d538af13))
+* removed `opts.options`. Use `vim.o.sessionoptions` instead. ([eb5622e](https://github.com/folke/persistence.nvim/commit/eb5622edae69ec65f6f83fcdd0eb5a70ce48ece7))
+* removed load_pre/load_post/save_pre/save_post in favor of events. Check the readme ([f58a838](https://github.com/folke/persistence.nvim/commit/f58a838282dac1ed33165a5fd03829b036584df2))
+* sessions per branch. Closes [#9](https://github.com/folke/persistence.nvim/issues/9) ([cd0054e](https://github.com/folke/persistence.nvim/commit/cd0054e6a4c17e4068a3e69a030013d268e569f9))
+
+
+### Bug Fixes
+
+* don't save `gitrebase` session ([#44](https://github.com/folke/persistence.nvim/issues/44)) ([9dbe264](https://github.com/folke/persistence.nvim/commit/9dbe2648c67b678bf7fe688f03b57a2514e03e6f))
+* opts.need ([9c0e522](https://github.com/folke/persistence.nvim/commit/9c0e5227fa7b36208a2db0d812008965c1aac889))
+* remove expand() as stdpath() expands itself ([#50](https://github.com/folke/persistence.nvim/issues/50)) ([a2fd3d9](https://github.com/folke/persistence.nvim/commit/a2fd3d99656ac496e56233aa4a40dd045a16fdc4))
+
 ## [2.0.0](https://github.com/folke/persistence.nvim/compare/v1.2.1...v2.0.0) (2023-10-15)
 
 

README.md

@@ -35,27 +35,38 @@ Persistence comes with the following defaults:
 ```lua
 {
   dir = vim.fn.stdpath("state") .. "/sessions/", -- directory where session files are saved
-  options = { "buffers", "curdir", "tabpages", "winsize" }, -- sessionoptions used for saving
+  -- minimum number of file buffers that need to be open to save
-  pre_save = nil, -- a function to call before saving the session
+  -- Set to 0 to always save
-  post_save = nil, -- a function to call after saving the session
+  need = 1,
-  save_empty = false, -- don't save if there are no open file buffers
+  branch = true, -- use git branch to save session
-  pre_load = nil, -- a function to call before loading the session
-  post_load = nil, -- a function to call after loading the session
 }
 ```
 
+> [!TIP]
+> To configure what should be saved in your session, check [:h 'sessionoptions'](https://neovim.io/doc/user/options.html#'sessionoptions')
+
 ## 🚀 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
+-- load the session for the current directory
-vim.api.nvim_set_keymap("n", "<leader>qs", [[<cmd>lua require("persistence").load()<cr>]], {})
+vim.keymap.set("n", "<leader>qs", function() require("persistence").load() end)
 
--- restore the last session
+-- select a session to load
-vim.api.nvim_set_keymap("n", "<leader>ql", [[<cmd>lua require("persistence").load({ last = true })<cr>]], {})
+vim.keymap.set("n", "<leader>qS", function() require("persistence").select() end)
+
+-- load the last session
+vim.keymap.set("n", "<leader>ql", function() require("persistence").load({ last = true }) end)
 
 -- stop Persistence => session won't be saved on exit
-vim.api.nvim_set_keymap("n", "<leader>qd", [[<cmd>lua require("persistence").stop()<cr>]], {})
+vim.keymap.set("n", "<leader>qd", function() require("persistence").stop() end)
 ```
+
+## 📅 Events
+
+- **PersistenceLoadPre**: before loading a session
+- **PersistenceLoadPost**: after loading a session
+- **PersistenceSavePre**: before saving a session
+- **PersistenceSavePost**: after saving a session

doc/persistence.nvim.txt

@@ -1,4 +1,4 @@
-*persistence.nvim.txt*      For Neovim >= 0.8.0      Last change: 2024 June 12
+*persistence.nvim.txt*           For Neovim          Last change: 2024 July 07
 
 ==============================================================================
 Table of Contents                         *persistence.nvim-table-of-contents*
@@ -9,6 +9,7 @@ Table of Contents                         *persistence.nvim-table-of-contents*
   - Installation                   |persistence.nvim-persistence-installation|
   - Configuration                 |persistence.nvim-persistence-configuration|
   - Usage                                 |persistence.nvim-persistence-usage|
+  - Events                               |persistence.nvim-persistence-events|
 
 ==============================================================================
 1. Persistence                                  *persistence.nvim-persistence*
@@ -53,16 +54,17 @@ Persistence comes with the following defaults:
 >lua
     {
       dir = vim.fn.stdpath("state") .. "/sessions/", -- directory where session files are saved
-      options = { "buffers", "curdir", "tabpages", "winsize" }, -- sessionoptions used for saving
+      -- minimum number of file buffers that need to be open to save
-      pre_save = nil, -- a function to call before saving the session
+      -- Set to 0 to always save
-      post_save = nil, -- a function to call after saving the session
+      need = 1,
-      save_empty = false, -- don't save if there are no open file buffers
+      branch = true, -- use git branch to save session
-      pre_load = nil, -- a function to call before loading the session
-      post_load = nil, -- a function to call after loading the session
     }
 <
 
 
+  [!TIP] To configure what should be saved in your session, check |:h
+  'sessionoptions'|
+
 USAGE                                     *persistence.nvim-persistence-usage*
 
 **Persistence** works well with plugins like `startify` or `dashboard`. It will
@@ -70,16 +72,27 @@ 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
+    -- load the session for the current directory
-    vim.api.nvim_set_keymap("n", "<leader>qs", [[<cmd>lua require("persistence").load()<cr>]], {})
+    vim.keymap.set("n", "<leader>qs", function() require("persistence").load() end)
     
-    -- restore the last session
+    -- select a session to load
-    vim.api.nvim_set_keymap("n", "<leader>ql", [[<cmd>lua require("persistence").load({ last = true })<cr>]], {})
+    vim.keymap.set("n", "<leader>qS", function() require("persistence").select() end)
+    
+    -- load the last session
+    vim.keymap.set("n", "<leader>ql", function() require("persistence").load({ last = true }) end)
     
     -- stop Persistence => session won't be saved on exit
-    vim.api.nvim_set_keymap("n", "<leader>qd", [[<cmd>lua require("persistence").stop()<cr>]], {})
+    vim.keymap.set("n", "<leader>qd", function() require("persistence").stop() end)
 <
 
+
+EVENTS                                   *persistence.nvim-persistence-events*
+
+- **PersistenceLoadPre**before loading a session
+- **PersistenceLoadPost**after loading a session
+- **PersistenceSavePre**before saving a session
+- **PersistenceSavePost**after saving a session
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl:

lua/persistence/config.lua

@@ -1,17 +1,15 @@
 local M = {}
 
----@class PersistenceOptions
+---@class Persistence.Config
----@field pre_save? fun()
----@field post_save? fun()
----@field pre_load? fun()
----@field post_load? fun()
 local defaults = {
   dir = vim.fn.stdpath("state") .. "/sessions/", -- directory where session files are saved
-  options = { "buffers", "curdir", "tabpages", "winsize", "skiprtp" }, -- sessionoptions used for saving
+  -- minimum number of file buffers that need to be open to save
-  save_empty = false, -- don't save if there are no open file buffers
+  -- Set to 0 to always save
+  need = 1,
+  branch = true, -- use git branch to save session
 }
 
----@type PersistenceOptions
+---@type Persistence.Config
 M.options = {}
 
 function M.setup(opts)

lua/persistence/init.lua

@@ -1,99 +1,146 @@
 local Config = require("persistence.config")
 
+local uv = vim.uv or vim.loop
+
 local M = {}
----@type string?
+M._active = false
-M.current = nil
 
 local e = vim.fn.fnameescape
 
-function M.get_current()
+---@param opts? {branch?: boolean}
-  local pattern = "/"
+function M.current(opts)
-  if vim.fn.has("win32") == 1 then
+  opts = opts or {}
-    pattern = "[\\:]"
+  local name = vim.fn.getcwd():gsub("[\\/:]+", "%%")
+  if Config.options.branch and opts.branch ~= false then
+    local branch = M.branch()
+    if branch and branch ~= "main" and branch ~= "master" then
+      name = name .. "%%" .. branch:gsub("[\\/:]+", "%%")
+    end
   end
-  local name = vim.fn.getcwd():gsub(pattern, "%%")
   return Config.options.dir .. name .. ".vim"
 end
 
-function M.get_last()
-  local sessions = M.list()
-  table.sort(sessions, function(a, b)
-    return vim.loop.fs_stat(a).mtime.sec > vim.loop.fs_stat(b).mtime.sec
-  end)
-  return sessions[1]
-end
-
 function M.setup(opts)
   Config.setup(opts)
   M.start()
 end
 
+function M.fire(event)
+  vim.api.nvim_exec_autocmds("User", {
+    pattern = "Persistence" .. event,
+  })
+end
+
+-- Check if a session is active
+function M.active()
+  return M._active
+end
+
 function M.start()
-  M.current = M.get_current()
+  M._active = true
   vim.api.nvim_create_autocmd("VimLeavePre", {
     group = vim.api.nvim_create_augroup("persistence", { clear = true }),
     callback = function()
-      if Config.options.pre_save then
+      M.fire("SavePre")
-        Config.options.pre_save()
-      end
 
-      if not Config.options.save_empty then
+      if Config.options.need > 0 then
         local bufs = vim.tbl_filter(function(b)
-          if vim.bo[b].buftype ~= "" then
+          if vim.bo[b].buftype ~= "" or vim.bo[b].filetype == "gitcommit" or vim.bo[b].filetype == "gitrebase" then
-            return false
-          end
-          if vim.bo[b].filetype == "gitcommit" then
-            return false
-          end
-          if vim.bo[b].filetype == "gitrebase" then
             return false
           end
           return vim.api.nvim_buf_get_name(b) ~= ""
         end, vim.api.nvim_list_bufs())
-        if #bufs == 0 then
+        if #bufs < Config.options.need then
           return
         end
       end
 
       M.save()
-
+      M.fire("SavePost")
-      if type(Config.options.post_save) == "function" then
-        Config.options.post_save()
-      end
     end,
   })
 end
 
 function M.stop()
-  M.current = nil
+  M._active = false
   pcall(vim.api.nvim_del_augroup_by_name, "persistence")
 end
 
 function M.save()
-  local tmp = vim.o.sessionoptions
+  vim.cmd("mks! " .. e(M.current()))
-  vim.o.sessionoptions = table.concat(Config.options.options, ",")
-  vim.cmd("mks! " .. e(M.current or M.get_current()))
-  vim.o.sessionoptions = tmp
 end
 
-function M.load(opt)
+---@param opts? { last?: boolean }
-  opt = opt or {}
+function M.load(opts)
-  local sfile = opt.last and M.get_last() or M.get_current()
+  opts = opts or {}
-  if sfile and vim.fn.filereadable(sfile) ~= 0 then
+  ---@type string
-    if type(Config.options.pre_load) == "function" then
+  local file
-      Config.options.pre_load()
+  if opts.last then
+    file = M.last()
+  else
+    file = M.current()
+    if vim.fn.filereadable(file) == 0 then
+      file = M.current({ branch = false })
     end
-
-    vim.cmd("silent! source " .. e(sfile))
-
-    if type(Config.options.post_load) == "function" then
-      Config.options.post_load()
   end
+  if file and vim.fn.filereadable(file) ~= 0 then
+    M.fire("LoadPre")
+    vim.cmd("silent! source " .. e(file))
+    M.fire("LoadPost")
   end
 end
 
+---@return string[]
 function M.list()
-  return vim.fn.glob(Config.options.dir .. "*.vim", true, true)
+  local sessions = vim.fn.glob(Config.options.dir .. "*.vim", true, true)
+  table.sort(sessions, function(a, b)
+    return uv.fs_stat(a).mtime.sec > uv.fs_stat(b).mtime.sec
+  end)
+  return sessions
+end
+
+function M.last()
+  return M.list()[1]
+end
+
+function M.select()
+  ---@type { session: string, dir: string, branch?: string }[]
+  local items = {}
+  local have = {} ---@type table<string, boolean>
+  for _, session in ipairs(M.list()) do
+    if uv.fs_stat(session) then
+      local file = session:sub(#Config.options.dir + 1, -5)
+      local dir, branch = unpack(vim.split(file, "%%", { plain = true }))
+      dir = dir:gsub("%%", "/")
+      if jit.os:find("Windows") then
+        dir = dir:gsub("^(%w)/", "%1:/")
+      end
+      if not have[dir] then
+        have[dir] = true
+        items[#items + 1] = { session = session, dir = dir, branch = branch }
+      end
+    end
+  end
+  vim.ui.select(items, {
+    prompt = "Select a session: ",
+    format_item = function(item)
+      return vim.fn.fnamemodify(item.dir, ":p:~")
+    end,
+  }, function(item)
+    if item then
+      vim.fn.chdir(item.dir)
+      M.load()
+    end
+  end)
+end
+
+--- get current branch name
+---@return string?
+function M.branch()
+  if uv.fs_stat(".git") then
+    local ret = vim.fn.systemlist("git branch --show-current")[1]
+    return vim.v.shell_error == 0 and ret or nil
+  end
 end
 
 return M

selene.toml

@@ -1 +1,4 @@
-std="lua51+vim"
+std="vim"
+
+[lints]
+mixed_table="allow"

stylua.toml

@@ -1,3 +1,6 @@
 indent_type = "Spaces"
 indent_width = 2
 column_width = 120
+[sort_requires]
+enabled = true
+

vim.toml

@@ -1,2 +1,21 @@
+[selene]
+base = "lua51"
+name = "vim"
+
 [vim]
 any = true
+
+[jit]
+any = true
+
+[assert]
+any = true
+
+[describe]
+any = true
+
+[it]
+any = true
+
+[before_each.args]
+any = true