Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitalk/vim-simple-todo
Mappings to manage GitHub-like task lists
https://github.com/vitalk/vim-simple-todo
productivity todo vim
Last synced: 10 days ago
JSON representation
Mappings to manage GitHub-like task lists
- Host: GitHub
- URL: https://github.com/vitalk/vim-simple-todo
- Owner: vitalk
- Created: 2012-11-25T13:31:11.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2020-02-07T10:19:05.000Z (over 4 years ago)
- Last Synced: 2023-11-07T21:04:37.186Z (12 months ago)
- Topics: productivity, todo, vim
- Language: Vim script
- Homepage: http://www.vim.org/scripts/script.php?script_id=4323
- Size: 48.8 KB
- Stars: 145
- Watchers: 7
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments):
- [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](https://github.com/tpope/vim-repeat)).
- Tick symbol is configurable, e.g.
```
[y] Water
[y] Bread
[ ] Milk
```
## Installation
Use your favorite installation method:
- Tim Pope’s [pathogen](https://github.com/tpope/vim-pathogen):
```sh
cd ~/.vim/bundle
git clone https://github.com/vitalk/vim-simple-todo
```
- Junegunn Choi’s [Plug](https://github.com/junegunn/vim-plug) (recommend):
```vim
Plug 'vitalk/vim-simple-todo'
```
```sh
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](https://github.com/vitalk/sanevi/blob/master/plugin/00_essential.vim#L38-L39).
| 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:
```vim
# 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`.
```vim
let g:simple_todo_tick_symbol = 'y'
```
## Issues
Don’t hesitate to open [GitHub Issues](https://github.com/vitalk/vim-simple-todo/issues) for any bug or suggestions.
## Copyright
Copyright © 2012 Vital Kudzelka. Use it for Good not Evil.
Distributed under the [MIT license](http://mit-license.org/vitalk).