243 lines
7.2 KiB
Markdown
243 lines
7.2 KiB
Markdown
# lazygit.nvim
|
|
|
|
Plugin for calling [lazygit](https://github.com/jesseduffield/lazygit) from within neovim.
|
|
|
|
|
|
|
|
See [akinsho/nvim-toggleterm](https://github.com/akinsho/nvim-toggleterm.lua#custom-terminals) or [voldikss/vim-floaterm](https://github.com/voldikss/vim-floaterm) as an alternative to this package.
|
|
|
|
### Install
|
|
|
|
Install using [`vim-plug`](https://github.com/junegunn/vim-plug):
|
|
|
|
```vim
|
|
" nvim v0.7.2
|
|
Plug 'kdheepak/lazygit.nvim'
|
|
```
|
|
|
|
Install using [`packer.nvim`](https://github.com/wbthomason/packer.nvim):
|
|
|
|
```lua
|
|
-- nvim v0.7.2
|
|
use({
|
|
"kdheepak/lazygit.nvim",
|
|
-- optional for floating window border decoration
|
|
requires = {
|
|
"nvim-lua/plenary.nvim",
|
|
},
|
|
})
|
|
```
|
|
|
|
Install using [`lazy.nvim`](https://github.com/folke/lazy.nvim):
|
|
|
|
```lua
|
|
-- nvim v0.8.0
|
|
require("lazy").setup({
|
|
{
|
|
"kdheepak/lazygit.nvim",
|
|
-- optional for floating window border decoration
|
|
dependencies = {
|
|
"nvim-lua/plenary.nvim",
|
|
},
|
|
},
|
|
})
|
|
```
|
|
|
|
Feel free to use any plugin manager.
|
|
Just remember that if you are not using the latest neovim release, you will need to use [the `nvim-v0.4.3` branch](https://github.com/kdheepak/lazygit.vim/tree/nvim-v0.4.3).
|
|
Integration with `nvr` works better on the `main` branch.
|
|
|
|
You can check what version of `neovim` you have:
|
|
|
|
```bash
|
|
nvim --version
|
|
```
|
|
|
|
### Usage
|
|
|
|
The following are configuration options and their defaults.
|
|
|
|
```vim
|
|
let g:lazygit_floating_window_winblend = 0 " transparency of floating window
|
|
let g:lazygit_floating_window_scaling_factor = 0.9 " scaling factor for floating window
|
|
let g:lazygit_floating_window_border_chars = ['╭','─', '╮', '│', '╯','─', '╰', '│'] " customize lazygit popup window corner characters
|
|
let g:lazygit_floating_window_use_plenary = 0 " use plenary.nvim to manage floating window if available
|
|
let g:lazygit_use_neovim_remote = 1 " fallback to 0 if neovim-remote is not installed
|
|
|
|
let g:lazygit_use_custom_config_file_path = 0 " config file path is evaluated if this value is 1
|
|
let g:lazygit_config_file_path = '' " custom config file path
|
|
```
|
|
|
|
```lua
|
|
vim.g.lazygit_floating_window_winblend = 0 -- transparency of floating window
|
|
vim.g.lazygit_floating_window_scaling_factor = 0.9 -- scaling factor for floating window
|
|
vim.g.lazygit_floating_window_border_chars = ['╭','─', '╮', '│', '╯','─', '╰', '│'] -- customize lazygit popup window corner characters
|
|
vim.g.lazygit_floating_window_use_plenary = 0 -- use plenary.nvim to manage floating window if available
|
|
vim.g.lazygit_use_neovim_remote = 1 -- fallback to 0 if neovim-remote is not installed
|
|
|
|
vim.g.lazygit_use_custom_config_file_path = 0 -- config file path is evaluated if this value is 1
|
|
vim.g.lazygit_config_file_path = '' -- custom config file path
|
|
```
|
|
|
|
Call `:LazyGit` to start a floating window with `lazygit` in the current working directory.
|
|
And set up a mapping to call `:LazyGit`:
|
|
|
|
```vim
|
|
" setup mapping to call :LazyGit
|
|
nnoremap <silent> <leader>gg :LazyGit<CR>
|
|
```
|
|
|
|
Call `:LazyGitCurrentFile` to start a floating window with `lazygit` in the project root of the current file.
|
|
|
|
Open the configuration file for `lazygit` directly from vim.
|
|
|
|
```vim
|
|
:LazyGitConfig<CR>
|
|
```
|
|
|
|
If the file does not exist it'll load the defaults for you.
|
|
|
|
|
|
|
|
Open project commits with `lazygit` directly from vim in floating window.
|
|
|
|
```vim
|
|
:LazyGitFilter<CR>
|
|
```
|
|
|
|
Open buffer commits with `lazygit` directly from vim in floating window.
|
|
|
|
```vim
|
|
:LazyGitFilterCurrentFile<CR>
|
|
```
|
|
|
|
**Using neovim-remote**
|
|
|
|
If you have [neovim-remote](https://github.com/mhinz/neovim-remote) and have configured to use it in neovim, it'll launch the commit editor inside your neovim instance when you use `C` inside `lazygit`.
|
|
|
|
1. `pip install neovim-remote`
|
|
|
|
2. Add the following to your `~/.bashrc`:
|
|
|
|
```bash
|
|
if [ -n "$NVIM_LISTEN_ADDRESS" ]; then
|
|
alias nvim=nvr -cc split --remote-wait +'set bufhidden=wipe'
|
|
fi
|
|
```
|
|
|
|
3. Set `EDITOR` environment variable in `~/.bashrc`:
|
|
|
|
```bash
|
|
if [ -n "$NVIM_LISTEN_ADDRESS" ]; then
|
|
export VISUAL="nvr -cc split --remote-wait +'set bufhidden=wipe'"
|
|
export EDITOR="nvr -cc split --remote-wait +'set bufhidden=wipe'"
|
|
else
|
|
export VISUAL="nvim"
|
|
export EDITOR="nvim"
|
|
fi
|
|
```
|
|
|
|
4. Add the following to `~/.vimrc`:
|
|
|
|
```vim
|
|
if has('nvim') && executable('nvr')
|
|
let $GIT_EDITOR = "nvr -cc split --remote-wait +'set bufhidden=wipe'"
|
|
endif
|
|
```
|
|
|
|
If you have `neovim-remote` and don't want `lazygit.nvim` to use it, you can disable it using the following configuration option:
|
|
|
|
```vim
|
|
let g:lazygit_use_neovim_remote = 0
|
|
```
|
|
|
|
### Telescope Plugin
|
|
|
|
The Telescope plugin is used to track all git repository visited in one nvim session.
|
|
|
|
|
|
(background image is not included :smirk:)
|
|
|
|
**Why a telescope Plugin** ?
|
|
|
|
Assuming you have one or more submodule(s) in your project and you want to commit changes in both the submodule(s)
|
|
and the main repo.
|
|
Though switching between submodules and main repo is not straight forward.
|
|
A solution at first could be:
|
|
|
|
1. open a file inside the submodule
|
|
2. open lazygit
|
|
3. do commit
|
|
4. then open a file in the main repo
|
|
5. open lazygit
|
|
6. do commit
|
|
|
|
That is really annoying.
|
|
Instead, you can open it with telescope.
|
|
|
|
**How to use**
|
|
|
|
Install using [`packer.nvim`](https://github.com/wbthomason/packer.nvim):
|
|
|
|
```lua
|
|
-- nvim v0.7.2
|
|
use({
|
|
"kdheepak/lazygit.nvim",
|
|
requires = {
|
|
"nvim-telescope/telescope.nvim",
|
|
"nvim-lua/plenary.nvim",
|
|
},
|
|
config = function()
|
|
require("telescope").load_extension("lazygit")
|
|
end,
|
|
})
|
|
```
|
|
|
|
Install using [`lazy.nvim`](https://github.com/folke/lazy.nvim):
|
|
|
|
```lua
|
|
-- nvim v0.8.0
|
|
require("lazy").setup({
|
|
{
|
|
"kdheepak/lazygit.nvim",
|
|
dependencies = {
|
|
"nvim-telescope/telescope.nvim",
|
|
"nvim-lua/plenary.nvim"
|
|
},
|
|
config = function()
|
|
require("telescope").load_extension("lazygit")
|
|
end,
|
|
},
|
|
})
|
|
```
|
|
|
|
Lazy loading `lazygit.nvim` for telescope functionality is not supported. Open an issue if you wish to have this feature.
|
|
|
|
If you are not using Packer, to load the telescope extension, you have to add this line to your configuration:
|
|
|
|
```lua
|
|
require('telescope').load_extension('lazygit')
|
|
```
|
|
|
|
By default the paths of each repo is stored only when lazygit is triggered.
|
|
Though, this may not be convenient, so it possible to do something like this:
|
|
|
|
```vim
|
|
autocmd BufEnter * :lua require('lazygit.utils').project_root_dir()
|
|
```
|
|
|
|
That makes sure that any opened buffer which is contained in a git repo will be tracked.
|
|
|
|
Once you have loaded the extension, you can invoke the plugin using:
|
|
|
|
```lua
|
|
lua require("telescope").extensions.lazygit.lazygit()
|
|
```
|
|
|
|
### Highlighting groups
|
|
|
|
| Highlight Group | Default Group | Description |
|
|
| ------------------| --------------| -----------------------------------------|
|
|
| **LazyGitFloat** | **_Normal_** | Float terminal foreground and background |
|
|
| **LazyGitBorder** | **_Normal_** | Float terminal border |
|