nvim-pqf makes your quickfix and location list windows look nicer, thanks to a
combination of a custom quickfixtextfunc
function and custom syntax rules for
quickfix/location list buffers.
Without nvim-pqf, your quickfix window looks like this:
With nvim-pqf, it looks like this (colours depend on your theme of course);
NeoVim 0.5 or newer is required. Regular Vim isn't supported.
First install this plugin using your plugin manager of choice. For example, when using vim-plug use the following:
Plug 'yorickpeterse/nvim-pqf'
Once installed, add the following Lua snippet to your init.lua
:
require('pqf').setup()
And that's it!
Each item in the quickfix list starts with a sign that indicates the type of
item, if this information is available. For example, when displaying diagnostics
an item may start with E
for an error, and W
for a warning.
These signs are taken from the text
attribute of NeoVim's diagnostic signs.
Refer to :h diagnostic-signs
for more information, and details on how to
override these signs.
To configure these signs, and other options, see below:
require('pqf').setup({
signs = {
error = 'E',
warning = 'W',
info = 'I',
hint = 'H'
},
-- By default, only the first line of a multi line message will be shown.
-- When this is true, multiple lines will be shown for an entry, separated by a space
show_multiple_lines = false,
-- How long filenames in the quickfix are allowed to be. 0 means no limit.
-- Filenames above this limit will be truncated from the beginning with [...]
max_filename_length = 0,
})
Depending on your theme, you may need to tweak the highlights used by nvim-pqf. The following highlight groups are defined:
Group | Links to | Use |
---|---|---|
qfPath |
Directory |
The file path of a quickfix item |
qfPosition |
Number |
Line and column numbers |
qfError |
DiagnosticError |
The indicator of error items |
qfWarning |
DiagnosticWarn |
The indicator of warning items |
qfInfo |
DiagnosticInfo |
The indicator of info items |
qfHint |
DiagnosticHint |
The indicator of hint items |
It's probably best to tweak the diagnostic highlights, instead of the quickfix ones.
All source code in this repository is licensed under the Mozilla Public License version 2.0, unless stated otherwise. A copy of this license can be found in the file "LICENSE".