Code Monkey home page Code Monkey logo

vim-airline-tomato's Introduction

vim-airline-tomato

vim-airline-tomato is a Vim extension that allows users to easily apply the Pomodoro Technique in their editor. It is a fork of Zuckonit and is based on vim-airline plugin.

With vim-airline-tomato, users can start and stop a Pomodoro timer and see the current time and remaining time displayed in the Vim status line. The extension also supports customizing the working and rest times, as well as the text displayed for each phase.

Features

  • Easy application of the Pomodoro Technique in Vim
  • Customizable working and rest times
  • Clock and countdown display options
  • Automatic reset of the Pomodoro count after a specified number of Pomodoros

Installation

To install vim-airline-tomato, use one of the following methods:

Using Vim's native package manager

git clone https://github.com/Ideflop/vim-airline-tomato.git ~/.vim/pack/plugins/start/vim-airline-tomato/

Using a plugin manager (e.g. Vundle, Pathogen)

Refer to the documentation of your chosen plugin manager for instructions on how to install vim-airline-tomato.

Configuration

If you want to change the working time:

let g:tomato#interval = 60 * 60

If you wat to change rest time:

let g:tomato#rest_time = 20 * 60

If you want to change working text:

let g:tomato#remind = "๐Ÿ…"

If you want to change rest text:

let g:tomato#restinfo = "โณ"

If you want to enable clock:

let g:tomato#show_clock = 1

If you want to show a count down:

let g:tomato#show_clock = 1  
let g:tomato#show_count_down = 1 

Usage

To start the Pomodoro timer and display it in the status line, run the following command in Vim:

:call tomato#start()

Note that the timer will continue to run even when Vim is not open, so the next time you open Vim the timer will still be running and displayed in the status line.

To stop the Pomodoro timer and remove it from the status line, run the following command in Vim:

:call tomato#stop()

To reset the Pomodoro count to 1, run the following command in Vim:

:call tomato#reset()

Set auto reset when number over a value

let g:tomato#auto_reset_num = 24 (here put the number you wanna set)  

if the g:tomato#auto_reset_num = -1 , then the auto reset will be forbidden
if there is no g:tomato#auto_reset_num in your config, the default auto_reset_num is 24 * 60 / g:tomato#interval, the total tomato numbers of one day.

troubleshooting

If you encounter issues while using vim-airline-tomato, it may be necessary to install certain fonts:

Airline: The extension is based on vim-airline (like powerline, but faster and with a deeper KISS flavor) powerline-font: if you use wild char's, you may need install powerline font.

pomicons: This is a font with 8 symbols to talk about the "Pomodoro Technique"ยฎ (You can use these special symbols to change the configuration). You can use one of the awesome-terminal-fonts that contains both powerline and pomicons symbols.

Screenshot

pomicons

vim-airline-tomato's People

Contributors

zuckonit avatar ideflop avatar xcodebuild avatar danielmschmidt avatar gabrielelana avatar hellolj avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.