Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/APZelos/blamer.nvim

A git blame plugin for neovim inspired by VS Code's GitLens plugin
https://github.com/APZelos/blamer.nvim

blame blamer git gitlens neovim neovim-plugin vim vim-plugin viml vimscript

Last synced: 6 days ago
JSON representation

A git blame plugin for neovim inspired by VS Code's GitLens plugin

Awesome Lists containing this project

README

        

# blamer.nvim

A git blame plugin for (neo)vim inspired by VS Code's GitLens plugin.

![blamer gif](https://res.cloudinary.com/djg49e1u9/image/upload/c_crop,h_336/v1579092411/blamer_mkv07c.gif)

Note: For Vim, a popup feature is required.

## Installation

#### vim-plug

1. Add the following line to your `init.vim`:

```
call plug#begin('~/.local/share/nvim/plugged')
...
Plug 'APZelos/blamer.nvim'
...
call plug#end()
```

2. Run `:PlugInstall`.

#### Packer

1. Add the following to `init.lua`

```lua
require('packer').startup(function(use)
-- other plugins ...
use 'APZelos/blamer.nvim'
-- other ...
end)
```

2. Restart neovim and run `:PackerSync`.

## Configuration

#### Enabled

Enables blamer on (neo)vim startup.

You can toggle blamer on/off with the `:BlamerToggle` command.

If the current directory is not a git repository the blamer will be automatically disabled.

Default: `0`

```
let g:blamer_enabled = 1
```

In lua:

```
vim.g.blamer_enabled = true
```

#### Delay

The delay in milliseconds for the blame message to show. Setting this too low may cause performance issues.

Default: `1000`

```
let g:blamer_delay = 500
```

#### Show in visual modes

Enables / disables blamer in visual modes.

Default: `1`

```
let g:blamer_show_in_visual_modes = 0
```

#### Show in insert modes

Enables / disables blamer in insert modes.

Default: `1`

```
let g:blamer_show_in_insert_modes = 0
```

#### Prefix

The prefix that will be added to the template.

Default: `' '`

```
let g:blamer_prefix = ' > '
```

#### Template

The template for the blame message that will be shown.

Default: `', • '`

Available options: ``, ``, ``, ``, ``, ``, ``, ``, ``.

```
let g:blamer_template = ' '
```

### Date format

The [format](https://devhints.io/datetime#strftime-format) of the date fields. (``, ``)

Default: `'%d/%m/%y %H:%M'`

```
let g:blamer_date_format = '%d/%m/%y'
```

### Relative time

Shows commit date in relative format

Default: `0`

```
let g:blamer_relative_time = 1
```

#### Highlight

The color of the blame message.

Default: `link Blamer Comment`

```
highlight Blamer guifg=lightgrey
```

## Author

[APZelos](https://github.com/APZelos)

## License

This software is released under the MIT License.