README.md

Listish.nvim

Neovim plugin for quickfix and local lists. You can add and remove items, or you can create notes on current position to either lists.

1. Demo
2. Requirements
3. Installation
   • Config
   • Lazy Loading
4. Related Projects
5. License

Demo

Both quickfix and local lists have the same set of functionalities.

Adding current location to the list:

Deleting from list:

Adding notes to the list:

Requirements

This library supports Neovim 0.7.0.

This plugin depends are the following libraries. Please make sure to add them as dependencies in your package manager:

• arshlib.nvim
• nvim.lua

Please consider using the nvim-bqf plugin to get the most out of your lists.

Installation

Use your favourite package manager to install this library. Packer example:

use({
  "arsham/listish.nvim",
  requires = { "arsham/arshlib.nvim", "norcalli/nvim.lua" },
  config = function() require("listish").config({}) end,
})

Config

By default this pluging adds all necessary commands and mappings, and updates the theme of the buffer. However you can change or disable them to your liking.

To disable set them to false. For example:

require("listish").config({
  theme_list = false,
  local_list = false,
})

Here is the default settings:

{
  theme_list = true,
  clearqflist = "Clearquickfix", -- command
  clearloclist = "Clearloclist", -- command
  clear_notes = "ClearListNotes", -- command
  lists_close = "<leader>cc",    -- closes both qf/loacal lists
  in_list_dd = "dd",             -- delete current item in the list
  quickfix = {
    open = "<leader>qo",
    on_cursor = "<leader>qq",    -- add current position to the list
    add_note = "<leader>qn",     -- add current position with your note to the list
    clear = "<leader>qd",        -- clear all items
    close = "<leader>qc",
    next = "]q",
    prev = "[q",
  },
  locallist = {
    open = "<leader>wo",
    on_cursor = "<leader>ww",
    add_note = "<leader>wn",
    clear = "<leader>wd",
    close = "<leader>wc",
    next = "]w",
    prev = "[w",
  },
}

Lazy Loading

You can let your package manager to load this plugin on either key-mapping events or when the first quickfix/local list is opened. Packer example:

use({
  "arsham/listish.nvim",
  requires = { "arsham/arshlib.nvim", "norcalli/nvim.lua" },
  config = function() require("listish").config({}) end,
  keys = {
    "<leader>qq", "<leader>qn", "<leader>qo",
    "<leader>ww", "<leader>wn", "<leader>wo",
  },
  ft = { "qf" },
})

Related Projects

• nvim-bqf: manipulate lists with fzf
• replacer.nvim: makes a quickfix list editable in both content and file path
• quickfix-reflector.vim: change code right in the quickfix window

License

Licensed under the MIT License. Check the LICENSE file for details.