Skip to content

lpawlak1/vim-simplest-todo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NeoVim simple todo

Introduction

vim-simplest-todo enables you to create and maintain global todo list. It's nothing fancy, but reliable and easy to use. It support adding, renaming, checking, and deleting elements.

It uses Lua with addition of Icon python3 and vimscript.

pres.jpg


Prerequisites

  • Neovim nightly
  • Linux, no port to windows in in plans
  • Apart from this plugin you need to install popfix preferably master branch.

Installation

Use your favorite plugin manager to install this plugin. tpope/vim-pathogen, VundleVim/Vundle.vim, junegunn/vim-plug, and Shougo/dein.vim are some of the more popular ones.

Personally I use vim-plug and instructions are shown below.

Vim-Plug
  1. Install Vim-Plug, according to its instructions.
  2. Add the following text to your init.vim.
call plug#begin()
  Plug 'RishabhRD/popfix'
  Plug 'lpawlak1/vim-simplest-todo'
call plug#end()
  1. Restart Vim, and run the :PlugInstall to install your plugins.

Getting Started

For opening todo list use <leader>o in normal mode.

Enable/disable can be achieved by setting: g:todo#enable to 1 or 0 in your init.vim.

At the moment plugin supports only keyboard shortcuts presented below.

Current state can offer:

  • a - Adds element after current line

  • A - Adds element to the very end of the list

  • i - Adds element before current line

  • I - Adds element at the beginning of the list

  • d - Deletes element from under the cursor, without warning

  • r - Renames element from under cursor, adds new date stample, gets input with current data from todo

  • q or <Esc> - quiting and saving to global file. Todos are saved to file using python3. If you want to quit without saving changes use :q<CR> which will not save changes,

  • <CR> - Changes state of todo element from checked to unchecked and from unchecked to checked. Date of the element stays as to when was the last rename or creation.

Note: More informations on mappings and settings in :help vim-todo.


Feedback

  • If you get an issue or come up with an awesome idea, don't hesitate to open an issue in github.
  • If you think this plugin is useful or cool, consider rewarding it a star.

About

Neovim plugin for todo list written in lua

Topics

Resources

Stars

Watchers

Forks