This VIM extension is intended to keep the TODOs in your source code organized without disrupting your workflow.
Add this to your .vimrc
Bundle 'Gorgoroth/NotSoPlainTasks'
NotSoPlainTasks does not disrupt your workflow, simply add and remove your TODOs in your source code as you always would.
Just work as normal, if there's a todo, just do this
// TODO explain do_stuff function better
then save with :w, your task with be added to project.todo in your working dir. All tasks are grouped by source code filenames. If you remove the comment again and save, the task is toggled as done in the project.todo.
Hit
<Leader>nptg
to generate a project.todo from all files in your working directory
In your *.todo-files, you can use the following keys in normal mode:
<Leader>nptn - new task
<Leader>nptj - jump, same as gf below
gf - jump to file and line of task under cursor
<Leader>nptd - done with task, currently jumps to file and line of task under cursor
<Leader>nptc - clean tasks, removes all done tasks from project.todo
Source code file is authorative Except for cancelled and done tasks, as well as tasks without line numbers
Cases
- User adds new todo in source code
- User removes todo in source code
- User changes todo text
- User changes source code so todo line number changes
- changes source code and todo tex
- User marks task as done in project todo
- User creates new tasks in project todo
Case 1: Create new todo Case 2: Remove todo/mark as done Case 3: like below Case 4: Try to find matching todo and update Case 5: Create new todo, then clean up orphaned todos without matches Case 6: Remove todo line in source code Case 7: Do nothing if there is no line number, simply keep at position
For now lets simply mark all removed tasks as done and create new tasks for those that have no clear matches