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.
Similar to any other vim plugin, use your preferred method. If you're new, check out:
vim-pathogen or vim-plug or :help packages
:WorklistAdd
and :WorklistRemove
.
No need to enter a TODO comment or switch to another file.:WorklistToggle
and they will be skipped
by the :cn
and :cp
family of commands.
:WorklistNote
and it will be shown in a popup
when browsing the list in the quickfix window.:WorklistShow
.:chistory
, :cnewer
, and :colder
family of commands to jump back to the
worklist.
:WorklistShow
again.:WorklistSave
and :WorklistLoad
.
See doc/worklist.txt
(or :help worklist
from vim after installing) for
commands and configuration.
Here's an asciicast which briefly demos some of the functionality provided by this plugin: