mvanderkamp / worklist.vim

A quickfix todo list for when you're flying

worklist.vim

Allows you to easily keep track of a todo list in the form of lines in the code that you wish to return to, stored in a quickfix list. Instead of leaving a TODO comment or jumping to a TODO file and trying to explain the context, simply add the line to the worklist and don't let yourself complete your current task until all items in the worklist have been handled. Let the line itself speak to the context of the item, or add a note to the item in the worklist.

Installation

Similar to any other vim plugin, use your preferred method. If you're new, check out:

vim-pathogen or vim-plug or :help packages

Features

• Easily add/remove lines to the list using :WorklistAdd and :WorklistRemove. No need to enter a TODO comment or switch to another file.
• Mark entries as "completed" using :WorklistToggle and they will be skipped by the :cn and :cp family of commands.
  • Allows you to easily keep a record of what you've done and what's still left to do.
• Add a note to an entry using :WorklistNote and it will be shown in a popup when browsing the list in the quickfix window.
• Easily add the worklist after your current position in the quickfix stack and show it using :WorklistShow.
• The worklist will be updated even if it isn't the current quickfix list being shown, allowing you to move on to other quickfix lists then use the :chistory, :cnewer, and :colder family of commands to jump back to the worklist.
  • Alternatively, can just use :WorklistShow again.
• Save and load your worklist using :WorklistSave and :WorklistLoad.
  • Easily keep a different worklist e.g. for each git branch.

Usage

See doc/worklist.txt (or :help worklist from vim after installing) for commands and configuration.

Demo

Here's an asciicast which briefly demos some of the functionality provided by this plugin:

worklist.vim's Issues

errors

Hi there, nice plugin.
I get the attached errors on Vim 9.0.
On entering (via :WorklistShow) on non-first times. (The error does not occur on the first :WorklistShow after vim startup.)

On closing using ZZ or :q. Even when closing the buffer from the first invocation of :WorklistShow.

Undefined variable: v:none in neovim v0.9.5

Full error message below. nvim v0.9.5 on Fedora 39. I've also replicated with v0.10.0-dev on Ubuntu 22.04.

Failed to source `/home/jesse/.local/share/nvim/lazy/worklist.vim/plugin/worklist.vim`

vim/_editor.lua:0: /home/jesse/.config/nvim/init.lua..nvim_exec2() called at /home/jesse/.config/nvim/init.lua:0../home/jesse/.local/share/nvim/lazy/worklist.vim/plugin/worklist.vim, line 17: Vim(let
):E121: Undefined variable: v:none

# stacktrace:
  - vim/_editor.lua:0 _in_ **cmd**
  - .config/nvim/init.lua:14

cannot show worklist

hi there,

not a coder, and using nvim for prose. was hoping to use your plugin as a todo manager for my writing projects. but I can't seem to get it to work properly. on both my 2013 intel mbp (BigSur 11.7.2) and my 2021 M1 mba (Monterey 12.6.2), I get the same error message when running :WorklistShow

running nvim in kitty. is there any other info I can provide to help resolve this?