Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ten3roberts/qf.nvim

Extends the default quickfix and location lists for neovim
https://github.com/ten3roberts/qf.nvim

Last synced: 6 days ago
JSON representation

Extends the default quickfix and location lists for neovim

Awesome Lists containing this project

README 

        
# qf.nvim

Quickfix and location list management for Neovim.



## Features



- Automatically open quickfix and location list

- Automatically close list when empty

- Close location list when parent window is destroyed

- Automatically shrink lists to the number of items

- Toggle list

- Open and Toggle without losing focus

- Follow cursor and select nearest entry

- Navigate location list relative to cursor

- Wrapping navigation

- Save and load lists

- Clear lists

- Automatically close the location list when quickfix list opens, saving

  space

- Open list at the very bottom of the screen rather than at the bottom of

  current split

- Automatically open or close list on window leave and enter

- Make list regroup to window on split

- Close other location list when quickfix opens and vice verse

- Pretty print list entries

- Telescope integration



qf.nvim offers many customization options to suit your workflow.



The plugin uses the default builtin quickfix list and location list and only

extends it, which means all builtin behaviour and plugins are compatible, such

as `:cclose`, `:cnext`, `:copen`, `:grep`, `:make`, `vim.diagnostic.set_qflist`,

etc. For `:make`, there exists an asynchronous name based build system called

( recipe.nvim )[https://github.com/ten3roberts/recipe.nvim], which integrates

directly with qf.nvim for added functionality such as error tallying.



## Installation

### [packer](https://github.com/wbthomason/packer.nvim)



```lua

use {

  'ten3roberts/qf.nvim',

    config = function()

      require'qf'.setup{}

  end

}

```



### [vim-plug](https://github.com/junegunn/vim-plug)



```vim

Plug 'ten3roberts/qf.nvim'



lua require'qf'.setup{}

```



## Api



qf.nvim exposes a lua api and Ex commands.



Most functions require a first parameter list to specify which list to act on.

Either 'c','qf', or 'quickfix' for affecting the quickfix list, or

'l','loc','location' for affecting the location list.



If a value of 'visible' is given, it will use the currently visible list type,

or the quickfix window as a fallback.



Ex commands are prefixed with either `Q`, `L` or `V` for which list to use



See `(qf.nvim)[./doc/qf.txt` for more details.



## Navigation



Unlike `:cnext` and `:cprev`, `:Qnext` and `:Qprev` will not navigate to valid entries which contain file names, as well

as wrapping.



`:Qbelow`, `:Qabove`, `:Lbelow`, `Labove`, etc will navigate to the next or previous entry relative to the cursor.

However, unlike `:cabove` it *will* cross buffer boundaries.



## Save and Restore



A list can be save with `Qsave` and if no name is given it will use the list name, which is usually the command used.



`Qload` will open a menu to select and restore a previous list.



If you use the `qf.set` api the previous list will automatically be saved.



## Example keymaps

```vim

nnoremap lo lua require'qf'.open('l') " Open location list

nnoremap lc lua require'qf'.close('l') " Close location list

nnoremap ll lua require'qf'.toggle('l', true) " Toggle location list and stay in current window



nnoremap co lua require'qf'.open('c') " Open quickfix list

nnoremap cc lua require'qf'.close('c') " Close quickfix list

nnoremap cl lua require'qf'.toggle('c', true) "Toggle quickfix list and stay in current window



nnoremap j lua require'qf'.below('l') " Go to next location list entry from cursor

nnoremap k lua require'qf'.above('l') " Go to previous location list entry from cursor



nnoremap J lua require'qf'.below('c') " Go to next quickfix entry from cursor

nnoremap K lua require'qf'.above('c') " Go to previous quickfix entry from cursor



nnoremap ]q lua require'qf'.below('visible') " Go to next entry from cursor in visible list

nnoremap [q lua require'qf'.above('visible') " Go to previous entry from cursor in visible list

```



## Configuration



Configuration is done by passing a table to setup.



Quickfix list and locations lists are configured separetely with keys 'c' and 'l'



Default setup:



```lua

require 'qf'.setup {

  -- Location list configuration

    l = {

        auto_close = true, -- Automatically close location/quickfix list if empty

        auto_follow = 'prev', -- Follow current entry, possible values: prev,next,nearest, or false to disable

        auto_follow_limit = 8, -- Do not follow if entry is further away than x lines

        follow_slow = true, -- Only follow on CursorHold

        auto_open = true, -- Automatically open list on QuickFixCmdPost

        auto_resize = true, -- Auto resize and shrink location list if less than `max_height`

        max_height = 8, -- Maximum height of location/quickfix list

        min_height = 5, -- Minimum height of location/quickfix list

        wide = false, -- Open list at the very bottom of the screen, stretching the whole width.

        number = false, -- Show line numbers in list

        relativenumber = false, -- Show relative line numbers in list

        unfocus_close = false, -- Close list when window loses focus

        focus_open = false, -- Auto open list on window focus if it contains items

    },

    -- Quickfix list configuration

    c = {

        auto_close = true, -- Automatically close location/quickfix list if empty

        auto_follow = 'prev', -- Follow current entry, possible values: prev,next,nearest, or false to disable

        auto_follow_limit = 8, -- Do not follow if entry is further away than x lines

        follow_slow = true, -- Only follow on CursorHold

        auto_open = true, -- Automatically open list on QuickFixCmdPost

        auto_resize = true, -- Auto resize and shrink location list if less than `max_height`

        max_height = 8, -- Maximum height of location/quickfix list

        min_height = 5, -- Minimum height of location/quickfix list

        wide = false, -- Open list at the very bottom of the screen, stretching the whole width.

        number = false, -- Show line numbers in list

        relativenumber = false, -- Show relative line numbers in list

        unfocus_close = false, -- Close list when window loses focus

        focus_open = false, -- Auto open list on window focus if it contains items

      }

      close_other = false, -- Close location list when quickfix list opens

      pretty = true, -- Pretty print quickfix lists

      silent = false, -- Suppress messages like "(1 of 3): *line content*" on jump

}

```



## Inspiration

- [vim-qf](https://github.com/romainl/vim-qf)

- [vim-loclist-follow](https://github.com/elbeardmorez/vim-loclist-follow)