https://github.com/tveskag/nvim-blame-line

A small plugin that uses neovims virtual text to print git blame info at the end of the current line.
https://github.com/tveskag/nvim-blame-line

git vim

Last synced: 14 days ago
JSON representation

A small plugin that uses neovims virtual text to print git blame info at the end of the current line.

• Host: GitHub
• URL: https://github.com/tveskag/nvim-blame-line
• Owner: tveskag
• License: mit
• Created: 2019-03-04T23:09:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-11T17:23:42.000Z (about 2 years ago)
• Last Synced: 2024-07-31T20:51:21.680Z (3 months ago)
• Topics: git, vim
• Language: Vim script
• Homepage:
• Size: 9.78 MB
• Stars: 182
• Watchers: 5
• Forks: 8
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - tveskag/nvim-blame-line - A small plugin that uses neovims virtual text to print git blame info at the end of the current line. (Git / Quickfix)

README

        
# nvim-blame-line

A small plugin that uses neovims virtual text to print git blame info at the end of the current line.

Also supports showing blame below the current window, for normal vim users.

nvim-blame-line prints author, date and summary of the commit belonging to the line underneath the cursor.

Just like a real IDE!

## Installation

Use a plugin manager like [vim-plug](https://github.com/junegunn/vim-plug)

```

Plug 'tveskag/nvim-blame-line'

```

## Usage

![Example gif](https://github.com/tveskag/nvim-blame-line/blob/master/img/example.gif "Example gif")

### Commands

The plugin is exposed through these commands:

- `EnableBlameLine`

- `DisableBlameLine`

- `ToggleBlameLine`

- `SingleBlameLine`

Example mapping:

```vim

nnoremap  b :ToggleBlameLine

```

Use autocmd to enable on startup:

```vim

autocmd BufEnter * EnableBlameLine

```

### Options

 

```vim

" Show blame info below the statusline instead of using virtual text

let g:blameLineUseVirtualText = 0

" Specify the highlight group used for the virtual text ('Comment' by default)

let g:blameLineVirtualTextHighlight = 'Question'

" Change format of virtual text ('%s' by default)

let g:blameLineVirtualTextFormat = '/* %s */'

" Customize format for git blame (Default format: '%an | %ar | %s')

let g:blameLineGitFormat = '%an - %s'

" Refer to 'git-show --format=' man pages for format options)

" Change message when content is not committed

let g:blameLineMessageWhenNotYetCommited = ''

```