Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coffebar/neovim-project
Neovim project plugin simplifies project management by maintaining project history and providing quick access to projects via Telescope or fzf-lua..
https://github.com/coffebar/neovim-project
lua neovim neovim-plugin
Last synced: 19 days ago
JSON representation
Neovim project plugin simplifies project management by maintaining project history and providing quick access to projects via Telescope or fzf-lua..
- Host: GitHub
- URL: https://github.com/coffebar/neovim-project
- Owner: coffebar
- License: apache-2.0
- Created: 2023-09-17T11:47:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-13T09:40:08.000Z (3 months ago)
- Last Synced: 2024-10-13T08:27:16.097Z (2 months ago)
- Topics: lua, neovim, neovim-plugin
- Language: Lua
- Homepage: https://www.buymeacoffee.com/coffebar
- Size: 93.8 KB
- Stars: 197
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - coffebar/neovim-project - Declarative project management, automatic saving of sessions, uses Telescope. (Session / Indent)
README
# 🗃️ Neovim project manager plugin
**Neovim project** plugin simplifies project management by maintaining project history and providing quick access to saved sessions via [Telescope](https://github.com/nvim-telescope/telescope.nvim) or [fzf-lua](https://github.com/ibhagwan/fzf-lua). It runs on top of the [Neovim Session Manager](https://github.com/Shatur/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**.
- ✅ Choose your favorite picker.
🙏 **Neovim project manager** plugin is heavily inspired by [project.vim](https://github.com/ahmedkhalf/project.nvim)
## Usage
1. Set patterns in the [configuration](#%EF%B8%8F-configuration) to discover your projects.
2. Use [commands](#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](#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.
Lazy.nvim
```lua
{
"coffebar/neovim-project",
opts = {
projects = { -- define project roots
"~/projects/*",
"~/.config/*",
},
picker = {
type = "telescope", -- or "fzf-lua"
}
},
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" },
-- optional picker
{ "nvim-telescope/telescope.nvim", tag = "0.1.4" },
-- optional picker
{ "ibhagwan/fzf-lua" },
{ "Shatur/neovim-session-manager" },
},
lazy = false,
priority = 100,
},
```
packer.nvim
```lua
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/*",
},
picker = {
type = "telescope", -- or "fzf-lua"
}
}
end,
requires = {
{ "nvim-lua/plenary.nvim" },
-- optional picker
{ "nvim-telescope/telescope.nvim", tag = "0.1.4" },
-- optional picker
{ "ibhagwan/fzf-lua" },
{ "Shatur/neovim-session-manager" },
}
})
```
pckr.nvim
```lua
{
"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/*",
},
picker = {
type = "telescope", -- or "fzf-lua"
}
}
end,
requires = {
{ "nvim-lua/plenary.nvim" },
-- optional picker
{ "nvim-telescope/telescope.nvim", tag = "0.1.4" },
-- optional picker
{ "ibhagwan/fzf-lua" },
{ "Shatur/neovim-session-manager" },
}
};
```
## ⚙️ Configuration
### Default options:
```lua
{
-- 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,
-- Keymap to delete project from history in Telescope picker
forget_project_keys = {
-- insert mode: Ctrl+d
i = "",
-- normal mode: d
n = "d"
},
-- 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",
},
},
-- Picker to use for project selection
-- Options: "telescope", "fzf-lua"
-- Fallback to builtin select ui if the specified picker is not available
picker = {
type = "telescope", -- or "fzf-lua"
opts = {
-- picker-specific options
},
},
}
```
## Commands
Neovim project manager will add these commands:
- `:NeovimProjectDiscover` - find a project based on patterns.
- `:NeovimProjectHistory` - 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.
#### Mappings
Use `Ctrl+d` in Telescope / fzf-lua to delete the project's session and remove it from the history.
## ⚡ Requirements
- Neovim >= 0.8.0
- Optional: Telescope.nvim for the Telescope picker
- Optional: fzf-lua for the fzf-lua picker
## 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:
```lua
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.