coffebar/neovim-project

website github github
session
stars 143
issues 2
subscribers 2
forks 5
CREATED

2023-09-17

UPDATED

13 hours ago


🗃️ Neovim project manager plugin

Neovim project plugin simplifies project management by maintaining project history and providing quick access to saved sessions via Telescope. It runs on top of the Neovim Session Manager, which is needed to store all open tabs and buffers for each project.

  • ✅ Start where you left off last time.
  • ✅ Switch from project to project in second.
  • ✅ Sessions and history can be synced across your devices (rsync, Syncthing, Nextcloud, Dropbox, etc.)
  • ✅ Find all your projects by glob patterns defined in config.
  • ✅ Autosave neo-tree.nvim expanded directories and buffers order in barbar.nvim.

Neovim project manager plugin dracula theme

Neovim project manager plugin onedark theme

🙏 Neovim project manager plugin is heavily inspired by project.vim

Usage

  1. Set patterns in the configuration to discover your projects.
  2. Use commands to open your project. Or open Neovim in the project directory. Both methods will create a session.
  3. Open files inside the project and work.
  4. The session will be saved before closing Neovim or switching to another project via commands.
  5. Open Neovim in any non-project directory and the latest session will be loaded.

📦 Installation

You can install the plugin using your preferred package manager.

{
  "coffebar/neovim-project",
  opts = {
    projects = { -- define project roots
      "~/projects/*",
      "~/.config/*",
    },
  },
  init = function()
    -- enable saving the state of plugins in the session
    vim.opt.sessionoptions:append("globals") -- save global variables that start with an uppercase letter and contain at least one lowercase letter.
  end,
  dependencies = {
    { "nvim-lua/plenary.nvim" },
    { "nvim-telescope/telescope.nvim", tag = "0.1.4" },
    { "Shatur/neovim-session-manager" },
  },
  lazy = false,
  priority = 100,
},
use({
  "coffebar/neovim-project",
  config = function()
    -- enable saving the state of plugins in the session
    vim.opt.sessionoptions:append("globals") -- save global variables that start with an uppercase letter and contain at least one lowercase letter.
    -- setup neovim-project plugin
    require("neovim-project").setup {
      projects = { -- define project roots
        "~/projects/*",
        "~/.config/*",
      },
    }
  end,
  requires = {
    { "nvim-lua/plenary.nvim" },
    { "nvim-telescope/telescope.nvim", tag = "0.1.4" },
    { "Shatur/neovim-session-manager" },
  }
})
{
  "coffebar/neovim-project",
  config = function()
    -- enable saving the state of plugins in the session
    vim.opt.sessionoptions:append("globals") -- save global variables that start with an uppercase letter and contain at least one lowercase letter.
    -- setup neovim-project plugin
    require("neovim-project").setup {
      projects = { -- define project roots
        "~/projects/*",
        "~/.config/*",
      },
    }
  end,
  requires = {
    { "nvim-lua/plenary.nvim" },
    { "nvim-telescope/telescope.nvim", tag = "0.1.4" },
    { "Shatur/neovim-session-manager" },
  }
};

⚙️ Configuration

Default options:

{
  -- Project directories
  projects = {
    "~/projects/*",
    "~/p*cts/*", -- glob pattern is supported
    "~/projects/repos/*",
    "~/.config/*",
    "~/work/*",
  },
  -- Path to store history and sessions
  datapath = vim.fn.stdpath("data"), -- ~/.local/share/nvim/
  -- Load the most recent session on startup if not in the project directory
  last_session_on_startup = true,
  -- Dashboard mode prevent session autoload on startup
  dashboard_mode = false,
  -- Timeout in milliseconds before trigger FileType autocmd after session load
  -- to make sure lsp servers are attached to the current buffer.
  -- Set to 0 to disable triggering FileType autocmd
  filetype_autocmd_timeout = 200,

  -- Overwrite some of Session Manager options
  session_manager_opts = {
    autosave_ignore_dirs = {
      vim.fn.expand("~"), -- don't create a session for $HOME/
      "/tmp",
    },
    autosave_ignore_filetypes = {
      -- All buffers of these file types will be closed before the session is saved
      "ccc-ui",
      "gitcommit",
      "gitrebase",
      "qf",
      "toggleterm",
    },
  },
}

Commands

Neovim project manager will add these commands:

  • :Telescope neovim-project discover - find a project based on patterns.

  • :Telescope neovim-project history - select a project from your recent history.

  • :NeovimProjectLoadRecent - open the previous session.

  • :NeovimProjectLoadHist - opens the project from the history providing a project dir.

  • :NeovimProjectLoad - opens the project from all your projects providing a project dir.

History is sorted by access time. "Discover" keeps order as you have in the config.

Telescope mappings

Use Ctrl+d in Telescope to delete the project's session and remove it from the history.

⚡ Requirements

  • Neovim >= 0.8.0

Demo video

https://github.com/coffebar/neovim-project/assets/3100053/e88ae41a-5606-46c4-a287-4c476ed97ccc

How to manage dotfiles repo

If you have a repository for your dotfiles, you will find it convenient to access them through projects.

Project pattern ~/.config/* matches many programs config folders, including Neovim. So when you need to edit Neovim config, you open project ~/.config/nvim by typing "nv..". When you need to edit alacritty config - you start typing "ala.."

Of course, you want to use vim-fugitive and gitsigns in these projects. And it should be a single git repo for dotfiles. By default, Neovim will know nothing about your dotfiles repo.

Create autocommands to update env variables to tell Neovim where is your dotfiles bare repo. Here is an example from my dotfiles:

local augroup = vim.api.nvim_create_augroup("user_cmds", { clear = true })

local function update_git_env_for_dotfiles()
  -- Auto change ENV variables to enable
  -- bare git repository for dotfiles after
  -- loading saved session
  local home = vim.fn.expand("~")
  local git_dir = home .. "/dotfiles"

  if vim.env.GIT_DIR ~= nil and vim.env.GIT_DIR ~= git_dir then
    return
  end

  -- check dotfiles dir exists on current machine
  if vim.fn.isdirectory(git_dir) ~= 1 then
    vim.env.GIT_DIR = nil
    vim.env.GIT_WORK_TREE = nil
    return
  end

  -- check if the current working directory should belong to dotfiles
  local cwd = vim.loop.cwd()
  if vim.startswith(cwd, home .. "/.config/") or cwd == home or cwd == home .. "/.local/bin" then
    if vim.env.GIT_DIR == nil then
      -- export git location into ENV
      vim.env.GIT_DIR = git_dir
      vim.env.GIT_WORK_TREE = home
    end
  else
    if vim.env.GIT_DIR == git_dir then
      -- unset variables
      vim.env.GIT_DIR = nil
      vim.env.GIT_WORK_TREE = nil
    end
  end
end

vim.api.nvim_create_autocmd("DirChanged", {
  pattern = { "*" },
  group = augroup,
  desc = "Update git env for dotfiles after changing directory",
  callback = function()
    update_git_env_for_dotfiles()
  end,
})

vim.api.nvim_create_autocmd("User", {
  pattern = { "SessionLoadPost" },
  group = augroup,
  desc = "Update git env for dotfiles after loading session",
  callback = function()
    update_git_env_for_dotfiles()
  end,
})

This code should be required from your init.lua before plugins.

🤝 Contributing

  • Open a ticket if you want integration with another plugin, or if you want to request a new feature.
  • If you encounter bugs please open an issue.
  • Pull requests are welcome.