feat!: version 3 (#186)

* feat: new command format (#183)

Co-authored-by: Oli Morris <[email protected]>

* feat: can delete session in `vim.ui.select` (#184)

Co-authored-by: Oli Morris <[email protected]>

* tests: move from plenary to mini.test (#185)

---------

Co-authored-by: Oli Morris <[email protected]>

Author: olimorris

.github/workflows/ci.yml

@@ -12,57 +12,29 @@ concurrency:
 
 jobs:
   tests:
-    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - os: ubuntu-latest
-            url: https://github.com/neovim/neovim/releases/download/nightly/nvim-linux-x86_64.tar.gz
-          - os: ubuntu-latest
-            url: https://github.com/neovim/neovim/releases/download/v0.11.0/nvim-linux-x86_64.tar.gz
-          - os: ubuntu-latest
-            url: https://github.com/neovim/neovim/releases/download/v0.10.0/nvim-linux64.tar.gz
-          - os: ubuntu-latest
-            url: https://github.com/neovim/neovim/releases/download/v0.9.0/nvim-linux64.tar.gz
-          - os: ubuntu-latest
-            url: https://github.com/neovim/neovim/releases/download/v0.8.0/nvim-linux64.tar.gz
+        os: [ubuntu-latest]
+        nvim_tag: [nightly, v0.11.0, v0.10.0, v0.9.0, v0.8.0]
+    name: ${{ matrix.os }} / ${{ matrix.nvim_tag }}
+    runs-on: ${{ matrix.os }}
+    env:
+      NVIM: ${{ matrix.os == 'windows-latest' && 'nvim-win64\\bin\\nvim.exe' || 'nvim' }}
 
     steps:
-      - uses: actions/checkout@v4
-      - run: date +%F > todays-date
-      - name: Restore from todays cache
-        uses: actions/cache@v4
-        with:
-          path: _neovim
-          key: ${{ runner.os }}-${{ matrix.url }}-${{ hashFiles('todays-date') }}
+      - name: Checkout 📋
+        uses: actions/checkout@v6
 
-      - name: Prepare
+      - name: Prepare Neovim 🚧
+        env:
+          NVIM_TAG: ${{ matrix.nvim_tag }}
         run: |
-          test -d _neovim || {
-            mkdir -p _neovim
-            curl -sL ${{ matrix.url }} | tar xzf - --strip-components=1 -C "${PWD}/_neovim"
-          }
-          mkdir -p ~/.local/share/nvim/site/pack/vendor/start
-          git clone --depth 1 https://github.com/nvim-lua/plenary.nvim ~/.local/share/nvim/site/pack/vendor/start/plenary.nvim
-          ln -s $(pwd) ~/.local/share/nvim/site/pack/vendor/start
+          #bash ./scripts/dependencies.sh
+          bash ./scripts/ci-install.sh
 
-      - name: Run tests
+      - name: Run tests 🧪
         run: |
-          export PATH="${PWD}/_neovim/bin:${PATH}"
-          export VIM="${PWD}/_neovim/share/nvim/runtime"
-          nvim --version
+          $NVIM --version
           make test
 
-  release:
-    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
-    runs-on: ubuntu-latest
-    needs:
-      - tests
-    permissions:
-      contents: write
-      pull-requests: write
-    steps:
-      - uses: googleapis/release-please-action@v4
-        with:
-          release-type: simple

.github/workflows/format.yml

@@ -0,0 +1,18 @@
+name: Format with StyLua
+
+on: [pull_request]
+
+jobs:
+  stylua:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - name: Format 🖌️
+        uses: JohnnyMorganz/stylua-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: v2.0.2
+          args: --check .
+

.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Release 📦
+        uses: googleapis/release-please-action@v4
+        with:
+          release-type: simple
+

.gitignore

@@ -1,6 +1,5 @@
-misc/
+deps/
 !tests/**/*
-.luarc.json
 todo.md
 
 tests/.DS_Store

.luarc.json

@@ -0,0 +1,15 @@
+{
+  "runtime": {
+    "version": "LuaJIT",
+    "pathStrict": true
+  },
+  "diagnostics.globals": ["vim",
+        "describe",
+        "it",
+        "MiniTest",
+        "before_each",
+        "after_each"],
+  "type": {
+    "checkTableShape": true
+  }
+}

Makefile

@@ -1,44 +1,45 @@
-PANVIMDOC_DIR = misc/panvimdoc
-PANVIMDOC_URL = https://github.com/kdheepak/panvimdoc
-PLENARY_DIR = misc/plenary
-PLENARY_URL = https://github.com/nvim-lua/plenary.nvim
+all: format docs test
 
-all: format test docs
-
-docs: $(PANVIMDOC_DIR)
-	@cd $(PANVIMDOC_DIR) && \
-	pandoc \
+docs: deps/panvimdoc
+	@echo Generating Docs...
+	@LUA_PATH="deps/panvimdoc/?.lua;;" pandoc \
+		README.md \
 		--metadata="project:persisted.nvim" \
 		--metadata="description:Simple session management for Neovim" \
+		--metadata="titledatepattern:%Y %B %d" \
 		--metadata="toc:true" \
 		--metadata="incrementheadinglevelby:0" \
 		--metadata="treesitter:true" \
-		--lua-filter scripts/skip-blocks.lua \
-		--lua-filter scripts/include-files.lua \
-		--lua-filter scripts/remove-emojis.lua \
-		-t scripts/panvimdoc.lua \
-		../../README.md \
-		-o ../../doc/persisted.nvim.txt
+		--metadata="dedupsubheadings:true" \
+		--metadata="ignorerawblocks:true" \
+		--metadata="docmapping:false" \
+		--metadata="docmappingproject:true" \
+		--lua-filter deps/panvimdoc/scripts/include-files.lua \
+		--lua-filter deps/panvimdoc/scripts/skip-blocks.lua \
+		--lua-filter deps/panvimdoc/scripts/remove-emojis.lua \
+		-t deps/panvimdoc/scripts/panvimdoc.lua \
+		-o doc/persisted.nvim.txt
+
+format:
+	@echo Formatting...
+	@stylua tests/ lua/ -f ./stylua.toml
 
-$(PANVIMDOC_DIR):
-	git clone --depth=1 --no-single-branch $(PANVIMDOC_URL) $(PANVIMDOC_DIR)
-	@rm -rf doc/panvimdoc/.git
+test: deps
+	@echo Testing...
+	nvim --headless --noplugin -u ./scripts/minimal_init.lua -c "lua MiniTest.run()"
 
-check:
-	stylua --check lua/ tests/ -f ./stylua.toml
+test_file: deps
+	@echo Testing File...
+	nvim --headless --noplugin -u ./scripts/minimal_init.lua -c "lua MiniTest.run_file('$(FILE)')"
+
+deps: deps/mini.nvim deps/panvimdoc
+	@echo Pulling...
+
+deps/mini.nvim:
+	@mkdir -p deps
+	git clone --filter=blob:none https://github.com/echasnovski/mini.nvim $@
+
+deps/panvimdoc:
+	@mkdir -p deps
+	git clone --filter=blob:none https://github.com/kdheepak/panvimdoc $@
 
-format:
-	stylua lua/ tests/ -f ./stylua.toml
-
-test: $(PLENARY_DIR)
-	nvim --headless --noplugin -u tests/minimal.vim +Setup
-	# nvim --headless --noplugin -u tests/minimal.vim +TestAutoloading
-	nvim --headless --noplugin -u tests/minimal.vim +TestGitBranching
-	nvim --headless --noplugin -u tests/minimal.vim +TestFollowCwd
-	nvim --headless --noplugin -u tests/minimal.vim +TestDefaults
-	nvim --headless --noplugin -u tests/minimal.vim +TestDirs
-	nvim --headless --noplugin -u tests/minimal.vim +TearDown
-
-$(PLENARY_DIR):
-	git clone --depth=1 --branch v0.1.3 $(PLENARY_URL) $(PLENARY_DIR)
-	@rm -rf $(PLENARY_DIR)/.git

README.md

@@ -103,17 +103,17 @@ require('telescope').setup({
 
 **Commands**
 
-The plugin comes with a number of commands:
-
-- `:SessionToggle` - Determines whether to load, start or stop a session
-- `:SessionStart` - Start recording a session. Useful if `autostart = false`
-- `:SessionStop` - Stop recording a session
-- `:SessionSave` - Save the current session
-- `:SessionSelect` - Load a session from the list (useful if you don't wish to use the Telescope extension)
-- `:SessionLoad` - Load the session for the current directory and current branch (if `git_use_branch = true`)
-- `:SessionLoadLast` - Load the most recent session
-- `:SessionLoadFromFile` - Load a session from a given path
-- `:SessionDelete` - Delete the current session
+The plugin has a number of commands:
+
+- `:Persisted toggle` - Determines whether to load, start or stop a session
+- `:Persisted start` - Start recording a session. Useful if `autostart = false`
+- `:Persisted stop` - Stop recording a session
+- `:Persisted save` - Save the current session
+- `:Persisted select` - Load a session from a list (useful if you don't wish to use the Telescope extension)
+- `:Persisted load` - Load the session for the current directory and current branch (if `git_use_branch = true`)
+- `:Persisted load_last` - Load the most recent session
+- `:Persisted delete` - Delete a session from a list
+- `:Persisted delete_current` - Delete the current session
 
 **Telescope extension**
 
@@ -528,6 +528,27 @@ You may wish to only save a session if the current working directory is in a tab
 }
 ```
 
+**Notifying when a session has been deleted**
+
+When you delete a session, it can be helpful to have a notification appear confirming the deletion:
+
+```lua
+{
+  "olimorris/persisted.nvim",
+  lazy = false,
+  config = function()
+    local persisted = require("persisted").setup()
+
+    vim.api.nvim_create_autocmd("User", {
+      pattern = "PersistedDeletePost",
+      callback = function(event)
+        vim.notify("Session `" .. event.data.path .. "` deleted")
+      end,
+    })
+  end,
+}
+```
+
 <!-- panvimdoc-ignore-start -->
 
 ## :clap: Acknowledgements

lua/persisted/init.lua

@@ -10,9 +10,11 @@ local uv = vim.uv or vim.loop
 
 ---Fire an event
 ---@param event string
+---@param data? table
 ---@return nil
-function M.fire(event)
-  vim.api.nvim_exec_autocmds("User", { pattern = "Persisted" .. event })
+function M.fire(event, data)
+  data = data or {}
+  vim.api.nvim_exec_autocmds("User", { pattern = "Persisted" .. event, data = data })
 end
 
 ---Get the current session for the current working directory and git branch
@@ -126,17 +128,17 @@ end
 ---Delete a session
 ---@param opts? { path?: string }
 ---@return nil
-function M.delete(opts)
+function M.delete_current(opts)
   opts = opts or {}
   local session = opts.path or M.current()
 
   if session and uv.fs_stat(session) ~= 0 then
-    M.fire("DeletePre")
+    M.fire("DeletePre", { path = session })
     vim.schedule(function()
       M.stop()
       vim.fn.delete(vim.fn.expand(session))
     end)
-    M.fire("DeletePost")
+    M.fire("DeletePost", { path = session })
   end
 end
 
@@ -149,9 +151,11 @@ function M.branch()
   end
 end
 
----Select a session to load
+---Handle the vim.ui.select behaviour
+---@param opts { prompt: string, handler: function}
 ---@return nil
-function M.select()
+function M.handle_selected(opts)
+  ---@type { session: string, dir: string, branch?: string }[]
   local items = {} ---@type { session: string, dir: string, branch?: string }[]
   local found = {} ---@type table<string, boolean>
   for _, session in ipairs(M.list()) do
@@ -169,7 +173,7 @@ function M.select()
     end
   end
   vim.ui.select(items, {
-    prompt = "Load a session: ",
+    prompt = opts.prompt,
     format_item = function(item)
       local name = vim.fn.fnamemodify(item.dir, ":p:~")
       if item.branch then
@@ -179,12 +183,34 @@ function M.select()
     end,
   }, function(item)
     if item then
+      opts.handler(item)
+    end
+  end)
+end
+
+---Load a session from the list
+---@return nil
+function M.select()
+  M.handle_selected({
+    prompt = "Load a session: ",
+    handler = function(item)
       M.fire("SelectPre")
       vim.fn.chdir(item.dir)
       M.load()
       M.fire("SelectPost")
-    end
-  end)
+    end,
+  })
+end
+
+---Delete a session from the list
+---@return nil
+function M.delete()
+  M.handle_selected({
+    prompt = "Delete a session: ",
+    handler = function(item)
+      M.delete_current({ path = item.session })
+    end,
+  })
 end
 
 ---Determines whether to load, start or stop a session