Code Monkey home page Code Monkey logo

nomodoro's Introduction

logo

Finally, Nvim + Pomodoro!

Yes, its another Pomodoro plugin for Nvim. Originally made to my own use and to learn the basics of plugin creation with Neovim.

I decided to leave this available for everyone that can find it useful also and please feel free to use, copy, comment or change anything you want.

demo

Features

  • Setup your pomodoro sessions time
  • Start and Stop sessions
  • Show status realtime from other plugins
  • Not just Pomodoro focused! Custom timer for any use

Quickstart

Instalation

Using vim-plug

Plug 'dbinagi/nomodoro'

Setup

To load plugin with default configuration:

require('nomodoro').setup({})

Setup

Default Configuration

require('nomodoro').setup({
    work_time = 25,
    break_time = 5,
    menu_available = true,
    texts = {
        on_break_complete = "TIME IS UP!",
        on_work_complete = "TIME IS UP!",
        status_icon = "",
        timer_format = '!%0M:%0S' -- To include hours: '!%0H:%0M:%0S'
    },
    on_work_complete = function() end,
    on_break_complete = function() end
})

Commands

Command Description
NomoWork Start work timer
NomoBreak Start break timer
NomoStop Stop all timers
NomoStatus Print time left manually
NomoTimer N Runs a timer for N minutes

Configure keys

By default, no shortcuts are provided, you could configure the following.

local map = vim.api.nvim_set_keymap
local opts = { noremap = true, silent = true }

map('n', '<leader>nw', '<cmd>NomoWork<cr>', opts)
map('n', '<leader>nb', '<cmd>NomoBreak<cr>', opts)
map('n', '<leader>ns', '<cmd>NomoStop<cr>', opts)

Optional UI

Integration with lualine

As an example, to integrate the status realtime with lualine use the following:

local lualine = require'lualine'
lualine.setup({
    sections = {
        lualine_x = {
            require('nomodoro').status,
        }
    }
})

Integration with nui.menu

If you like menus, you can install the dependency nui.menu and you will have enable a command NomoMenu to display options in a popup

menu

nomodoro's People

Contributors

dbinagi avatar

Stargazers

 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.