ToyChest.nvim

A barely opinionated session manager for nvim, ToyChest.nvim.

Installation

By default, the sessions will be stored and read at ~/.vim_sessions. That could be configured via the setup function.

With Lazy.nvim

{
  "limxingzhi/toychest.nvim",
  config = function()
    require("toychest").setup()
  end
},

Usages

Usage with commands

The underlying implementation uses :mks! and :source.

List available sessions:

:Sesr

Write/save the current session:

:Sesw <session_name>

Read/replay a session:

:Sesr <session_name>

Custom directory for sessions

You can set a custom directory.

{
  "limxingzhi/toychest.nvim",
  config = function()
    require("toychest").setup({
      dir = '~/.my_sessions' -- directory for your sessions
    })
  end
},

Usage with bindings

You can also call the save_sessions(name) and restore_session(name) functions directly to read and write sessions.

This example assigns keybinds to read and write sessions based on the branch name.

{
  "limxingzhi/toychest.nvim",
  config = function()
    require("toychest").setup()

    -- "vim session write" : save current session based on branch name
    vim.keymap.set({ "n" }, "<leader>vsw", function()
      local branch = vim.fn.system "git branch --show-current | tr -d '\n'"
      require('toychest').save_session(branch)
    end)

    -- "vim session read" : restore current session based on branch name
    vim.keymap.set({ "n" }, "<leader>vsr", function()
      local branch = vim.fn.system "git branch --show-current | tr -d '\n'"
      require('toychest').restore_session(branch)
    end)
  end
},

This example is complete config that appends the current working directory and the git branch as the file name.

{
  "limxingzhi/toychest.nvim",
  config = function()
    require("toychest").setup()

    local function assert_is_repo()
      local isGitRepo = vim.fn.system("git rev-parse --is-inside-work-tree 2>/dev/null"):gsub("%s+", "")
      if isGitRepo ~= "true" then
        error("The current directory is not a Git repository.")
        return
      end
    end

    local function get_name()
      assert_is_repo()
      local currentDir = vim.fn.getcwd()
      local folderName = vim.fn.fnamemodify(currentDir, ":t")
      local branchName = vim.fn.system("git rev-parse --abbrev-ref HEAD 2>/dev/null"):gsub("%s+", "")
      return folderName .. '__' .. branchName
    end

    vim.keymap.set({ "n" }, "<leader>vsw", function()
      require("toychest").save_session(get_name())
    end)

    -- "vim session read" : restore current session based on branch name
    vim.keymap.set({ "n" }, "<leader>vsr", function()
      require("toychest").restore_session(get_name())
    end)
  end
},

References

• How to write a neovim plugin