remember-me

If within a project:

On open, remember what I was doing.

On close, memorize what I'm doing.

If outside a project:

Don't bother me

Use Case

I use nvim in a couple of distinct ways. I'm either working on a project, taking notes/writing or messing with dotfiles/system config.

Sessions only make sense to me when working in a project.

• Default (n)vim session management is cumbersome.
• Session management plugins are overkill since I just want part of that functionality and only when inside a project.
• Project management plugins are overkill since I don't really need to manage my projects, I usually navigate to them using z.lua.

Since nothing felt right, I started writing stuff in my config to fit my needs:

• I just want sessions when inside a project.
• Even inside a project, I don't want sessions if I'm explicitly opening a file, editing a commit or reading a man page.
• I don't want any overhead. Set the thing up and forget about it.
• I want a quick way to remove the current session if I decide it's useless.

Usage

As such, this plugin has a set it and forget it approach to session handling.

Aucmds are already set up to handle the described behavior when opening and closing nvim.

If that's not enough and/or you wish to extend the behavior, you can save, load and forget sessions manually with the user commands:

:Memorize
:Recall
:Forget

Or by calling these functions directly from you lua config:

require("remember_me").memorize()
require("remember_me").recall()
require("remember_me").forget()

A note on forgetting

Using the "forget" functionality will both delete the current session and turn off the aucmds: No automatic session saving will occur on exit. To turn the aucmds back on again, just use the "recall" functionality.

Setup

As usual, require("remember_me").setup() needs to be added to your config.

You can pass a table to setup() with your desired config, as explained below.

Default config

{
  ignore_ft = { "man", "gitignore", "gitcommit" },
  session_store = "~/.cache/remember-me/",
  project_roots = { ".git", ".svn" },
}

Full config table can be found here.

Options

Please keep in mind that the config variables you specify will override the default ones.

So to add a filetype to ignore, use ignore_ft = { "man", "gitignore", "gitcommit", "something_else" }

• ignore_ft

File types for which nothing will happen, even if within a project. No saving nor loading sessions.

• session_store

Where to store and look for sessions. Only affects the sessions managed by this plugin.

It takes both full and relative paths, although relative paths are expanded from nvim's cwd.

• project_roots

What defines a project.

The plugin will search up the directory tree until it finds one of these markers and consider the directory in which it found it as the project's root.

Can take files or directories, but can't handle globs or patterns.