A vim plugin for t.rb.

Corey Prophitt 4878b87e7b Updated the vim documentation 4 years ago
autoload fdcdca155c Converted buffer commands to F and E 4 years ago
doc 4878b87e7b Updated the vim documentation 4 years ago
plugin 27e1dfd5e5 Added edit task functionality 4 years ago
screenshots 28a2ad9ec1 Added screenshot to the repository 4 years ago
.gitignore 674c035065 Initial commit 4 years ago
README.md a33c258980 Updated the usage within the readme 4 years ago

README.md

vim-t

Vim task management at its finest.

alt text

Requirements

First and foremost, vim-t requires the installation of t.rb which is a Ruby gem. Assuming you have Ruby installed, you can install t.rb like so,

$ gem install t.rb

Secondly, vim-t assumes you have compiled vim with Ruby support. Many vim installations come with Ruby support already enabled. You can check your installation with the following command,

$ vim --version | grep ruby

If you see +ruby then you are good to go. If not, you can check your operating system's requirements for installing vim with Ruby support. If you are an Ubuntu user you may not have Ruby support out of the box, but you can easily install a version of vim that does,

$ sudo apt-get install install vim-nox

Installation

The plugin follows the Pathogen/Vundle format. If you're a Vundle user you can simply add the plugin to your plugin list. If you are not familiar with Vundle, I recommend you check it out here.

Plugin 'prophittcorey/vim-t'

If you use Pathogen, you can simply clone the repository in your bundle folder.

$ cd ~/.vim/bundle
$ git clone https://github.com/prophittcorey/vim-t.git

Mappings

By default, vim-t does not provide any mappings. You can add any mapping you wish to your .vimrc file. The mapping I recommend is:

nnoremap <leader>t :Tls<cr>

This mapping will make your <leader>t display the task list.

Another useful mapping is:

nnoremap <leader>T :T<cr>

This mapping makes <leader>T prompt for a new task description.

Usage

Using vim-t is easy. You can use the :T command to create a new task. You can also use the :Tls command to display a list of all your tasks.

Within the tasks list you can navigate lines of tasks, and if you press F on a task the task will be finished and removed from the tasks list. If you modify a task in the task list and press E on the task, the edited task will be saved.

Help

For more info on vim-t, see Vim's help page for vim-t. You can do this via the command: :help vim-t

Note

The t.rb gem creates a .tasks.json file in the current working directory to store task information. If you don't want your tasks in source control you should add the file to your .gitignore file.

$ echo ".tasks.json" >> .gitignore

License

The MIT License (MIT)

Copyright (c) 2015, Corey Prophitt.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.