vim-qf-preview

A plugin for the quickfix and location list window to quickly preview the file with the quickfix item under the cursor in a popup window.

Requirements

Vim >= 8.1.2250

Usage

Quickfix window mapping

To avoid conflicts with other plugins no default key mapping for opening the popup window is provided. You will first have to bind <plug>(qf-preview-open) to a key-sequence of your choice.

For example, to open the popup window with p, add the following to ~/.vim/after/ftplugin/qf.vim:

nmap <buffer> p <plug>(qf-preview-open)

Or alternatively, if you prefer to keep your plugin settings in your vimrc:

augroup qfpreview
    autocmd!
    autocmd FileType qf nmap <buffer> p <plug>(qf-preview-open)
augroup END

Now navigate the cursor in the quickfix window to the desired error and press p to open a popup window with the file containing the error. The window is scrolled such that the buffer line with the error is at the top of the popup window.

Popup window mappings

The following default popup mappings are provided:

• Scroll up/down one text line: Ctrl-k, Ctrl-j
• Scroll to first/last line of displayed buffer: Shift-Home, Shift-End
• Scroll back to error line ("reset"): r
• Close the popup window: q, Ctrl-c

Configuration

b:qfpreview and g:qfpreview

The default popup key mappings and the appearance of the popup window can be configured through the variable b:qfpreview in after/ftplugin/qf.vim, or alternatively through the global variable g:qfpreview. The variable must be a dictionary containing any of the following entries:

¹For valid sign attributes see :help qfpreview.sign and the examples below.

Highlighting

The highlighting of the popup window can be configured through the highlighting groups QfPreview, QfPreviewTitle, QfPreviewScrollbar, QfPreviewThumb and QfPreviewColumn. See :help qfpreview-highlight for more details.

Examples

1. Override the popup scrolling keys:

   let g:qfpreview = {
       \ 'top': g,
       \ 'bottom': G,
       \ 'scrollup': 'k',
       \ 'scrolldown': 'j',
       \ 'halfpageup': 'u',
       \ 'halfpagedown': 'd',
       \ 'fullpageup': 'b',
       \ 'fullpagedown': 'f',
       \ 'next': 'n',
       \ 'previous': 'p'
       \ }

2. Place a sign in the buffer at the error line and highlight the whole line using CursorLine:

   let g:qfpreview = {'sign': {'linehl': 'CursorLine'}}

3. Instead of highlighting the whole line, display a sign in the 'signcolumn':

   let g:qfpreview = {'sign': {'text': '>>', 'texthl': 'Search'}}

4. Same as 3., but also enable the 'number' column. In this case the placed sign is shown in the 'number' column:

   let g:qfpreview = {'number': 1, 'sign': {'text': '>>', 'texthl': 'Todo'}}

Screenshots of 2., 3. and 4.:

Installation

Run the following commands in your terminal:

$ cd ~/.vim/pack/git-plugins/start
$ git clone https://github.com/bfrg/vim-qf-preview
$ vim -u NONE -c 'helptags vim-qf-preview/doc | quit'

Note: The directory name git-plugins is arbitrary, you can pick any other name. For more details see :help packages. Alternatively, use your favorite plugin manager.

License

Distributed under the same terms as Vim itself. See :help license.