This is a fork vitalk's plugin with the only purpose of prefixing TODOs with "# TODO" so that it'll integrate easely on a Ruby project
May be this is the smallest Vim plugin in the world. It adds some useful mappings for manage simple TODO lists (example below) and nothing more.
# TODO [x] Create plugin
# TODO [x] Add help documentation
# TODO [x] Publish to GitHub
# TODO [ ] Spread the word
Plugin supports GitHub-like task lists as well.
- Support markdown list markers
- So it's easy to create tasks in issues or pull requests on GitHub
Use your favorite installation method:
-
Tim Pope's pathogen:
cd .vim/bundle git clone https://github.com/dwaynemac/vim-simple-todo
-
Junegunn Choi's Plug (recommend):
Plug 'dwaynemac/vim-simple-todo'
vim +PlugInstall +qall
All this mappings use the <leader>
key and they work the same on NORMAL
and INSERT
modes. I prefer to use the comma
as the <leader>
key but fell free to set your own.
Key | Help |
---|---|
,i | Create a new todo under cursor |
,I | Create a new todo for current line |
,o | Create a new todo below current line |
,O | Create a new todo above current line |
,x | Mark todo under cursor as done |
,X | Mark todo as undone |
Or even remap them to somethings more comfortable for you:
# Disable default key bindings
let g:simple_todo_map_keys = 0
# Map your keys
nmap <c-i> <Plug>(simple-todo-new)
imap <c-i> <Plug>(simple-todo-new)
# ...etc.
See :help simple-todo-maps
for list of available mappings.
Don't hesitate to open GitHub Issues for any bug or suggestions.
Copyright © 2012 Vital Kudzelka. Use it for Good not Evil.
Distributed under the MIT license.