quicker.nvim

Improved UI and workflow for the Neovim quickfix

<!-- TOC -->

• Requirements
• Features
• Installation
• Setup
• Options
• Highlights
• API
• Other Plugins

<!-- /TOC -->

Requirements

• Neovim 0.10+

Features

• Improved styling - including syntax highlighting of grep results.
• Show context lines - easily view lines above and below the quickfix results.
• Editable buffer - make changes across your whole project by editing the quickfix buffer and :w.
• API helpers - some helper methods for common tasks, such as toggling the quickfix.

Improved styling (colorscheme: Duskfox)
Before
<img width="695" alt="Screenshot 2024-07-30 at 6 03 39 PM" src="https://github.com/user-attachments/assets/8faa4790-8a7a-4d05-882e-c4e8e7653b00">

After
<img width="686" alt="Screenshot 2024-07-30 at 2 05 49 PM" src="https://github.com/user-attachments/assets/90cf87dd-83ec-4967-88aa-5ffe3e1e6623">

Context lines around the results
<img width="816" alt="Screenshot 2024-07-30 at 2 06 17 PM" src="https://github.com/user-attachments/assets/844445c9-328f-4f18-91d9-b32d32d3ef39">

Editing the quickfix to apply changes across multiple files

https://github.com/user-attachments/assets/5065ac4d-ec24-49d1-a95d-232344b17484

Installation

quicker.nvim supports all the usual plugin managers

<details> <summary>lazy.nvim</summary>

{
  'stevearc/quicker.nvim',
  ft = "qf",
  ---@module "quicker"
  ---@type quicker.SetupOptions
  opts = {},
}

</details> <details> <summary>Packer</summary>

require("packer").startup(function()
  use({
    "stevearc/quicker.nvim",
    config = function()
      require("quicker").setup()
    end,
  })
end)

</details> <details> <summary>Paq</summary>

require("paq")({
  { "stevearc/quicker.nvim" },
})

</details> <details> <summary>vim-plug</summary>

Plug 'stevearc/quicker.nvim'

</details> <details> <summary>dein</summary>

call dein#add('stevearc/quicker.nvim')

</details> <details> <summary>Pathogen</summary>

git clone --depth=1 https://github.com/stevearc/quicker.nvim.git ~/.vim/bundle/

</details> <details> <summary>Neovim native package</summary>

git clone --depth=1 https://github.com/stevearc/quicker.nvim.git \
  "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/pack/quicker/start/quicker.nvim

</details>

Setup

You will need to call setup() for quicker to start working

require("quicker").setup()

It's not required to pass in any options, but you may wish to to set some keymaps.

vim.keymap.set("n", "<leader>q", function()
  require("quicker").toggle()
end, {
  desc = "Toggle quickfix",
})
vim.keymap.set("n", "<leader>l", function()
  require("quicker").toggle({ loclist = true })
end, {
  desc = "Toggle loclist",
})
require("quicker").setup({
  keys = {
    {
      ">",
      function()
        require("quicker").expand({ before = 2, after = 2, add_to_existing = true })
      end,
      desc = "Expand quickfix context",
    },
    {
      "<",
      function()
        require("quicker").collapse()
      end,
      desc = "Collapse quickfix context",
    },
  },
})

Options

A complete list of all configuration options

<!-- OPTIONS -->

require("quicker").setup({
  -- Local options to set for quickfix
  opts = {
    buflisted = false,
    number = false,
    relativenumber = false,
    signcolumn = "auto",
    winfixheight = true,
    wrap = false,
  },
  -- Set to false to disable the default options in `opts`
  use_default_opts = true,
  -- Keymaps to set for the quickfix buffer
  keys = {
    -- { ">", "<cmd>lua require('quicker').expand()<CR>", desc = "Expand quickfix content" },
  },
  -- Callback function to run any custom logic or keymaps for the quickfix buffer
  on_qf = function(bufnr) end,
  edit = {
    -- Enable editing the quickfix like a normal buffer
    enabled = true,
    -- Set to true to write buffers after applying edits.
    -- Set to "unmodified" to only write unmodified buffers.
    autosave = "unmodified",
  },
  -- Keep the cursor to the right of the filename and lnum columns
  constrain_cursor = true,
  highlight = {
    -- Use treesitter highlighting
    treesitter = true,
    -- Use LSP semantic token highlighting
    lsp = true,
    -- Load the referenced buffers to apply more accurate highlights (may be slow)
    load_buffers = false,
  },
  follow = {
    -- When quickfix window is open, scroll to closest item to the cursor
    enabled = false,
  },
  -- Map of quickfix item type to icon
  type_icons = {
    E = "󰅚 ",
    W = "󰀪 ",
    I = " ",
    N = " ",
    H = " ",
  },
  -- Border characters
  borders = {
    vert = "┃",
    -- Strong headers separate results from different files
    strong_header = "━",
    strong_cross = "╋",
    strong_end = "┫",
    -- Soft headers separate results within the same file
    soft_header = "╌",
    soft_cross = "╂",
    soft_end = "┨",
  },
  -- How to trim the leading whitespace from results. Can be 'all', 'common', or false
  trim_leading_whitespace = "common",
  -- Maximum width of the filename column
  max_filename_width = function()
    return math.floor(math.min(95, vim.o.columns / 2))
  end,
  -- How far the header should extend to the right
  header_length = function(type, start_col)
    return vim.o.columns - start_col
  end,
})

<!-- /OPTIONS -->

Highlights

These are the highlight groups that are used to style the quickfix buffer. You can set these highlight groups yourself or use :help winhighlight in the setup opts option to override them for just the quickfix window.

• QuickFixText - The base text when there are no syntax highlights
• QuickFixTextInvalid - The text when valid = 0
• QuickFixHeaderHard - The header that divides results from different files (with context expanded)
• QuickFixHeaderSoft - The header that divides results within the same file (with context expanded)
• Delimiter - The divider between filename, line number, and text
• QuickFixLineNr - The line number
• QuickFixFilename - The filename
• QuickFixFilenameInvalid - The filename when valid = 0
• DiagnosticSign* - The signs that display the quickfix error type

API

<!-- API -->

expand(opts)

expand(opts)
Expand the context around the quickfix results.

| Param | Type | Desc | | ---------------- | ------------------------- | -------------------------------------------------------------- | | opts | nil\|quicker.ExpandOpts | | | >before | nil\|integer | Number of lines of context to show before the line (default 2) | | >after | nil\|integer | Number of lines of context to show after the line (default 2) | | >add_to_existing | nil\|boolean | | | >loclist_win | nil\|integer | |

Note:

<pre> If there are multiple quickfix items for the same line of a file, only the first one will remain after calling expand(). </pre>

collapse()

collapse()
Collapse the context around quickfix results, leaving only the valid items.

toggle_expand(opts)

toggle_expand(opts)
Toggle the expanded context around the quickfix results.

| Param | Type | Desc | | ---------------- | ------------------------- | -------------------------------------------------------------- | | opts | nil\|quicker.ExpandOpts | | | >before | nil\|integer | Number of lines of context to show before the line (default 2) | | >after | nil\|integer | Number of lines of context to show after the line (default 2) | | >add_to_existing | nil\|boolean | | | >loclist_win | nil\|integer | |

refresh(loclist_win, opts)

refresh(loclist_win, opts)
Update the quickfix list with the current buffer text for each item.

| Param | Type | Desc | | ----------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------- | | loclist_win | nil\|integer | | | opts | nil\|quicker.RefreshOpts | | | >keep_diagnostics | nil\|boolean | If a line has a diagnostic type, keep the original text and display it as virtual text after refreshing from source. |

is_open(loclist_win)

is_open(loclist_win)

| Param | Type | Desc | | ----------- | -------------- | ---------------------------------------------------------------------- | | loclist_win | nil\|integer | Check if loclist is open for the given window. If nil, check quickfix. |

toggle(opts)

toggle(opts)
Toggle the quickfix or loclist window.

| Param | Type | Desc