Simple todo in Vim

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.

[x] Create plugin
[x] Add help documentation
[x] Publish to GitHub
[ ] Spread the word

Features

Support GitHub-like task lists:
- Works well with different markdown list markers, e.g. -, +, *.
- So it's easy to create tasks in issues or pull requests on GitHub
Each mapping is repeatable via . (require tpope/repeat).
Tick symbol is configurable, e.g.
```
[y] Water
[y] Bread
[ ] Milk
```

Installation

Use your favorite installation method:

Tim Pope's pathogen:

cd .vim/bundle
git clone https://github.com/vitalk/vim-simple-todo

Junegunn Choi's Plug (recommend):

Plug 'vitalk/vim-simple-todo'

vim +PlugInstall +qall

Usage

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.

You can also change the tick symbol to something else. Default is x.

let g:simple_todo_tick_symbol = 'y'

Issues

Don't hesitate to open GitHub Issues for any bug or suggestions.

Copyright