vim-simple-todo

by vitalk

Mappings to manage GitHub-like task lists

135 Stars 24 Forks Last release: over 3 years ago (0.19) 97 Commits 18 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Simple todo in Vim

Maybe 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 helpful documentation
[x] Publish to GitHub
[ ] Spread the word

Features

  • Support GitHub-like task lists:

    • [x] Works well with different markdown list markers, e.g.
      -
      ,
      +
      ,
      *
      .
    • [ ] So it’s easy to create tasks in issues or pull requests on GitHub
  • Visually selected tasks can be processed at once.

  • 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:

  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

 key and they work the same on 
NORMAL
,
VISUAL
and
INSERT
modes. The default
 is backslash (
\
), but I prefer to use the comma as the
 key but feel 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 | |
s
| Switch todo status for current line |

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 (simple-todo-new) imap (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

Copyright © 2012 Vital Kudzelka. Use it for Good not Evil.

Distributed under the MIT license.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.