feat: tab-scoped sessions

Author: stevearc-stripe

README.md

@@ -14,7 +14,6 @@ A: While it's amazing that this feature is built-in to vim, and it does an impre
 
 ## TODO
 
-- [ ] tab-scoped sessions
 - [ ] documentation
 - [ ] make filepaths relative so sessions are portable
 

lua/resession/config.lua

@@ -22,16 +22,17 @@ local default_config = {
     "winfixheight",
     "winfixwidth",
   },
-  buffers = {
-    -- Custom logic for determining if the buffer should be included
-    filter = function(bufnr)
-      if not vim.tbl_contains({ "", "acwrite", "help" }, vim.bo[bufnr].buftype) then
-        return false
-      end
-      return true
-    end,
-  },
-  windows = {},
+  -- Custom logic for determining if the buffer should be included
+  buf_filter = function(bufnr)
+    if not vim.tbl_contains({ "", "acwrite", "help" }, vim.bo[bufnr].buftype) then
+      return false
+    end
+    return vim.bo[bufnr].buflisted
+  end,
+  -- Custom logic for determining if a buffer should be included in a tab-scoped session
+  tab_buf_filter = function(tabpage, bufnr)
+    return true
+  end,
   -- The name of the directory to store sessions in
   dir = "session",
   -- Configuration for extensions
@@ -70,9 +71,7 @@ M.setup = function(config)
     vim.api.nvim_create_autocmd("VimLeavePre", {
       group = autosave_group,
       callback = function()
-        if resession.get_current() then
-          resession.save(nil, { notify = false })
-        end
+        resession.save_all({ notify = false })
       end,
     })
     autosave_timer = vim.loop.new_timer()
@@ -81,9 +80,7 @@ M.setup = function(config)
       M.autosave.interval * 1000,
       M.autosave.interval * 1000,
       vim.schedule_wrap(function()
-        if resession.get_current() then
-          resession.save(nil, { notify = M.autosave.notify })
-        end
+        resession.save_all({ notify = M.autosave.notify })
       end)
     )
   end

lua/resession/init.lua

@@ -2,6 +2,7 @@ local M = {}
 
 local pending_config
 local current_session
+local tab_sessions = {}
 
 local function do_setup()
   if pending_config then
@@ -19,12 +20,15 @@ end
 ---Get the name of the current session
 ---@return string|nil
 M.get_current = function()
-  return current_session
+  local tabpage = vim.api.nvim_get_current_tabpage()
+  return tab_sessions[tabpage] or current_session
 end
 
 ---Detach from the current session
 M.detach = function()
   current_session = nil
+  local tabpage = vim.api.nvim_get_current_tabpage()
+  tab_sessions[tabpage] = nil
 end
 
 ---@class resession.ListOpts
@@ -59,6 +63,15 @@ M.list = function(opts)
   return ret
 end
 
+local function remove_tabpage_session(name)
+  for k, v in pairs(tab_sessions) do
+    if v == name then
+      tab_sessions[k] = nil
+      break
+    end
+  end
+end
+
 ---@class resession.DeleteOpts
 ---@field dir nil|string Name of directory to save to (overrides config.dir)
 
@@ -88,47 +101,33 @@ M.delete = function(name, opts)
   if current_session == name then
     current_session = nil
   end
+  remove_tabpage_session(name)
 end
 
----@class resession.SaveOpts
----@field detach nil|boolean Immediately detach from the saved session
----@field notify nil|boolean Notify on success
----@field dir nil|string Name of directory to save to (overrides config.dir)
-
----@param name? string
----@param opts? resession.SaveOpts
-M.save = function(name, opts)
-  opts = vim.tbl_extend("keep", opts or {}, {
-    notify = true,
-  })
-  if not name then
-    name = current_session
-  end
-  if not name then
-    vim.ui.input({ prompt = "Session name" }, function(selected)
-      if selected then
-        M.save(selected, opts)
-      end
-    end)
-    return
-  end
+---@param name string
+---@param opts resession.SaveOpts
+---@param target_tabpage? integer
+local function save(name, opts, target_tabpage)
   local config = require("resession.config")
   local files = require("resession.files")
   local layout = require("resession.layout")
   local util = require("resession.util")
   local filename = util.get_session_file(name, opts.dir)
+  local cwd
   local data = {
     buffers = {},
     tabs = {},
+    tab_scoped = target_tabpage ~= nil,
     global = {
       cwd = vim.fn.getcwd(-1, -1),
       height = vim.o.lines - vim.o.cmdheight,
       width = vim.o.columns,
-      options = util.save_global_options(),
+      -- Don't save global options for tab-scoped session
+      options = target_tabpage and {} or util.save_global_options(),
     },
   }
   for _, bufnr in ipairs(vim.api.nvim_list_bufs()) do
-    if config.buffers.filter(bufnr) then
+    if util.include_buf(target_tabpage, bufnr) then
       local buf = {
         name = vim.api.nvim_buf_get_name(bufnr),
         loaded = vim.api.nvim_buf_is_loaded(bufnr),
@@ -137,20 +136,24 @@ M.save = function(name, opts)
       table.insert(data.buffers, buf)
     end
   end
-  for _, tabpage in ipairs(vim.api.nvim_list_tabpages()) do
+  local tabpages = target_tabpage and { target_tabpage } or vim.api.nvim_list_tabpages()
+  local buf_filter = function(bufnr)
+    return util.include_buf(target_tabpage, bufnr)
+  end
+  for _, tabpage in ipairs(tabpages) do
     local tab = {}
     local tabnr = vim.api.nvim_tabpage_get_number(tabpage)
-    if vim.fn.haslocaldir(-1, tabnr) == 1 then
+    if target_tabpage or vim.fn.haslocaldir(-1, tabnr) == 1 then
       tab.cwd = vim.fn.getcwd(-1, tabnr)
     end
     table.insert(data.tabs, tab)
     local winlayout = vim.fn.winlayout(tabnr)
-    tab.wins = layout.add_win_info_to_layout(tabnr, winlayout)
+    tab.wins = layout.add_win_info_to_layout(tabnr, winlayout, buf_filter)
   end
 
-  for ext_name in pairs(config.extensions) do
+  for ext_name, ext_config in pairs(config.extensions) do
     local ext = util.get_extension(ext_name)
-    if ext then
+    if ext and (ext_config.enable_in_tab or not target_tabpage) then
       local ok, ext_data = pcall(ext.on_save)
       if ok then
         data[ext_name] = ext_data
@@ -164,21 +167,97 @@ M.save = function(name, opts)
   end
 
   files.write_json_file(filename, data)
-  if not opts.detach then
-    current_session = name
-  end
   if opts.notify then
     vim.notify(string.format("Saved session %s", name))
   end
 end
 
+---@class resession.SaveOpts
+---@field attach nil|boolean Stay attached to session after saving
+---@field notify nil|boolean Notify on success
+---@field dir nil|string Name of directory to save to (overrides config.dir)
+
+---@param name? string
+---@param opts? resession.SaveOpts
+M.save = function(name, opts)
+  opts = vim.tbl_extend("keep", opts or {}, {
+    notify = true,
+    attach = true,
+  })
+  if not name then
+    -- If no name, default to the current session
+    name = current_session
+  end
+  if not name then
+    vim.ui.input({ prompt = "Session name" }, function(selected)
+      if selected then
+        M.save(selected, opts)
+      end
+    end)
+    return
+  end
+  save(name, opts)
+  tab_sessions = {}
+  if opts.attach then
+    current_session = name
+  else
+    current_session = nil
+  end
+end
+
+---Save a tab-scoped session
+---@param name string
+---@param opts? resession.SaveOpts
+M.save_tab = function(name, opts)
+  opts = vim.tbl_extend("keep", opts or {}, {
+    notify = true,
+    attach = true,
+  })
+  local cur_tabpage = vim.api.nvim_get_current_tabpage()
+  if not name then
+    name = tab_sessions[cur_tabpage]
+  end
+  if not name then
+    vim.ui.input({ prompt = "Session name" }, function(selected)
+      if selected then
+        M.save_tab(selected, opts)
+      end
+    end)
+    return
+  end
+  save(name, opts, cur_tabpage)
+  current_session = nil
+  remove_tabpage_session(name)
+  if opts.attach then
+    tab_sessions[cur_tabpage] = name
+  else
+    tab_sessions[cur_tabpage] = nil
+  end
+end
+
+---Save all current sessions to disk
+M.save_all = function(opts)
+  opts = vim.tbl_extend("keep", opts or {}, {
+    notify = true,
+  })
+  if current_session then
+    save(current_session, opts)
+  else
+    for tabpage, name in pairs(tab_sessions) do
+      save(name, opts, tabpage)
+    end
+  end
+end
+
 local function open_clean_tab()
   -- Detect if we're already in a "clean" tab
   -- (one window, and one empty scratch buffer)
   if #vim.api.nvim_tabpage_list_wins(0) == 1 then
     if vim.api.nvim_buf_get_name(0) == "" then
       local lines = vim.api.nvim_buf_get_lines(0, -1, 2, false)
-      if #lines == 1 and lines[1] == "" then
+      if vim.tbl_isempty(lines) then
+        vim.api.nvim_buf_set_option(0, "buflisted", false)
+        vim.api.nvim_buf_set_option(0, "bufhidden", "wipe")
         return
       end
     end
@@ -201,16 +280,17 @@ local function close_everything()
 end
 
 ---@class resession.LoadOpts
----@field detach nil|boolean Detach from session after loading
----@field reset nil|boolean Close everthing before loading the session (default true)
+---@field attach nil|boolean Attach to session after loading
+---@field reset nil|boolean|"auto" Close everthing before loading the session (default "auto")
 ---@field silence_errors nil|boolean Don't error when trying to load a missing session
 ---@field dir nil|string Name of directory to load from (overrides config.dir)
 
 ---@param name? string
 ---@param opts? resession.LoadOpts
 M.load = function(name, opts)
   opts = vim.tbl_extend("keep", opts or {}, {
-    reset = true,
+    reset = "auto",
+    attach = true,
   })
   local config = require("resession.config")
   local files = require("resession.files")
@@ -237,6 +317,9 @@ M.load = function(name, opts)
     end
     return
   end
+  if opts.reset == "auto" then
+    opts.reset = not data.tab_scoped
+  end
   if opts.reset then
     close_everything()
   else
@@ -248,7 +331,9 @@ M.load = function(name, opts)
     vim.o.columns / data.global.width,
     (vim.o.lines - vim.o.cmdheight) / data.global.height,
   }
-  vim.cmd(string.format("cd %s", data.global.cwd))
+  if not data.tab_scoped then
+    vim.cmd(string.format("cd %s", data.global.cwd))
+  end
   for _, buf in ipairs(data.buffers) do
     local bufnr = vim.fn.bufadd(buf.name)
     if buf.loaded then
@@ -294,10 +379,17 @@ M.load = function(name, opts)
   for k, v in pairs(data.global.options) do
     vim.o[k] = v
   end
-  if opts.detach then
-    current_session = nil
-  else
-    current_session = name
+  current_session = nil
+  if opts.reset then
+    tab_sessions = {}
+  end
+  remove_tabpage_session(name)
+  if opts.attach then
+    if data.tab_scoped then
+      tab_sessions[vim.api.nvim_get_current_tabpage()] = name
+    else
+      current_session = name
+    end
   end
 end
 

lua/resession/layout.lua

@@ -4,8 +4,9 @@ local M = {}
 
 ---@param tabnr integer
 ---@param winid integer
+---@param buf_filter nil|fun(bufnr: integer): boolean
 ---@return table|false
-M.get_win_info = function(tabnr, winid)
+local function get_win_info(tabnr, winid, buf_filter)
   local bufnr = vim.api.nvim_win_get_buf(winid)
   local win = {}
   local supported_by_ext = false
@@ -26,7 +27,7 @@ M.get_win_info = function(tabnr, winid)
       break
     end
   end
-  if not supported_by_ext and not config.buffers.filter(bufnr) then
+  if not supported_by_ext and not buf_filter(bufnr) then
     return false
   end
   win = vim.tbl_extend("error", win, {
@@ -46,10 +47,11 @@ end
 
 ---@param tabnr integer
 ---@param layout table
-M.add_win_info_to_layout = function(tabnr, layout)
+---@param buf_filter nil|fun(bufnr: integer): boolean
+M.add_win_info_to_layout = function(tabnr, layout, buf_filter)
   local type = layout[1]
   if type == "leaf" then
-    layout[2] = M.get_win_info(tabnr, layout[2])
+    layout[2] = get_win_info(tabnr, layout[2], buf_filter)
     if not layout[2] then
       return false
     end
@@ -155,6 +157,9 @@ end
 ---@param scale_factor number[] Scaling factor for [width, height]
 ---@return nil|integer The window that should have focus after session load
 M.set_winlayout = function(layout, scale_factor)
+  if not layout then
+    return
+  end
   set_winlayout(layout)
   local ret = {}
   set_winlayout_data(layout, scale_factor, ret)