Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imNel/monorepo.nvim
An effective way to juggle monorepos in neovim
https://github.com/imNel/monorepo.nvim
monorepo neovim neovim-plugin
Last synced: 2 months ago
JSON representation
An effective way to juggle monorepos in neovim
- Host: GitHub
- URL: https://github.com/imNel/monorepo.nvim
- Owner: imNel
- License: mit
- Created: 2023-04-27T10:23:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-21T23:28:12.000Z (10 months ago)
- Last Synced: 2024-07-23T08:39:01.351Z (2 months ago)
- Topics: monorepo, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 1.55 MB
- Stars: 95
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# monorepo.nvim
**_monorepo.nvim_** is a plugin to manage the scope of monorepos inside of neovim!
Its goal is to make juggling multiple projects inside of a monorepo a little easier, in combination with Telescope's `find_files`.
## Requirements
- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) for the project picker
- [nvim-lua/plenary.nvim](https://github.com/nvim-lua/plenary.nvim) for some helper functions used internally
## Installing
Install the plugin (This example uses [lazy.nvim](https://github.com/folke/lazy.nvim))
```lua
{
"imNel/monorepo.nvim",
config = function()
require("monorepo").setup({
-- Your config here!
})
end,
dependencies = { "nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim"},
},
```
### Config Defaults
```lua
{
silent = false, -- Supresses vim.notify messages
autoload_telescope = true, -- Automatically loads the telescope extension at setup
data_path = vim.fn.stdpath("data"), -- Path that monorepo.json gets saved to
}
```
The telescope extension needs to be loaded at any point AFTER `require("telescope").setup()` and `require("monorepo").setup()`.
By default, this is done automatically but you can undo this by setting `{ autoload_telescope = false }` in the config.
This is the snippet you'll need to run to load the extension if doing it manually
```lua
require("telescope").load_extension("monorepo")
```
Set up your keybinds!
```lua
vim.keymap.set("n", "m", function()
require("telescope").extensions.monorepo.monorepo()
end)
vim.keymap.set("n", "n", function()
require("monorepo").toggle_project()
end)
```
## Usage (These can be mapped to keybinds)
### Managing Projects
You can add the current file's directory to the project list (works in netrw and files)
```lua
:lua require("monorepo").add_project()
```
You can also remove it if you don't want it in the project list
```lua
:lua require("monorepo").remove_project()
```
You can also toggle these with a single command
```lua
:lua require("monorepo").toggle_project()
```
You can also use a prompt to manage your projects
```lua
-- You can use "add", "remove" or "toggle" here.
-- If you don't specify any, it defaults to add
:lua require("monorepo").prompt_project("add")
```
### Changing Projects
You can jump to a specific sub-project using its index (they're ordered in the order you added them)
```lua
:lua require("monorepo").go_to_project(index)
```
_I use a for loop here to quickly jump to different indexes_
```lua
for i = 1, 9 do
set("n", "" .. i, function()
require("monorepo").go_to_project(i)
end)
end
```
There are also functions to jump to the next or previous project
```lua
:lua require("monorepo").next_project()
:lua require("monorepo").previous_project()
```
### Telescope
You can view the project list like this
```lua
:Telescope monorepo
```
or this
```lua
:lua require("telescope").extensions.monorepo.monorepo()
```
You can also manage your projects using keybinds inside of telescope.
```lua
-- Normal Mode
dd -> delete_entry
-- Insert Mode
-> delete_entry
-> add_entry
```
_These are very basic for now and can't be changed in the config, feel free to create an issue to suggest ideas._
### Changing Monorepos
Using this, you can switch monorepos without having to close nvim and cd to a different directory
```lua
:lua require("monorepo").change_monorepo(path)
```
This pairs well with something like [telescope-project.nvim](https://github.com/nvim-telescope/telescope-project.nvim), which offers a hook when changing projects.
See an example from my own config below:
```lua
require("telescope").setup({
extensions = {
project = {
on_project_selected = function(prompt_bufnr)
-- Change dir to the selected project
project_actions.change_working_directory(prompt_bufnr, false)
-- Change monorepo directory to the selected project
local selected_entry = action_state.get_selected_entry(prompt_bufnr)
require("monorepo").change_monorepo(selected_entry.value)
require("telescope.builtin").find_files()
end,
}
}
}
```
## FAQ
### Does this persist between sessions? Where does this save?
I use `vim.fn.stdpath("data")` to find the data path and then write a file called `monorepo.json`.
This defaults to `$HOME/.local/share/nvim/` but can be changed in the config with `{ data_path = '/path/to/directory' }`
## Extras features I wanna add in the future
- Lualine support??
- NerdTree support? what are popular trees/fs plugins?
- Give projects a "nickname"?
- Include info on projects?
- When opening a known subproject, it detects it
- Remove repeated code with add, remove and toggle
- Other ways to add projects