https://github.com/jackluson/vscode-pomodoro-clock

Pomodoro clock for VS Code
https://github.com/jackluson/vscode-pomodoro-clock

pomodoro pomodoro-clock pomodoro-timer vscode-extension

Last synced: 4 days ago
JSON representation

Pomodoro clock for VS Code

• Host: GitHub
• URL: https://github.com/jackluson/vscode-pomodoro-clock
• Owner: jackluson
• License: agpl-3.0
• Created: 2022-09-09T11:15:49.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T17:16:12.000Z (13 days ago)
• Last Synced: 2024-10-29T18:43:18.004Z (13 days ago)
• Topics: pomodoro, pomodoro-clock, pomodoro-timer, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 770 KB
• Stars: 13
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - jackluson/vscode-pomodoro-clock - Pomodoro clock for VS Code (TypeScript)

README

        
# Pomodoro Clock for VS Code



  


    

      

    

  

  


    

      

    

    

    

    

    

      

    

    

  



Pomodoro clock for VS Code -- The time management for a more productive way to work on VS Code with Pomodoro technique.

## Features

- Follow [Pomodoro technique](https://en.wikipedia.org/wiki/Pomodoro_Technique).

- After each pomodoro, we have a short break. We have long break in 1 times each 4 (can be customized) short break times.

- Extension show a count down(can be customized) clock and name of process.

- When the time is up, there will be a notification prompt and a shortcut action button.

- Ability to Start timer、Pause timer、Restart Timer、 Reset timer on statu bar.

- Provides a simple statistical function that can count the number of Pomodoro clocks today

> Tip: You can click the clock to toggle `countdown` display.

> You can also use it as a simple timer when the `pomodoroClock.countdown` is `false`

## Install

>Install [Pomodoro Clock](https://marketplace.visualstudio.com/items?itemName=jackluson.pomodoro-clock) via VS Code market

## Demo

A simple Pomodoro clock shows in the status bar here.

> Pomodoro clock and Pomodoro type info

![Demo](./screenshots/demo.gif)

> Notification when time up

![Demo](./screenshots/time-up.jpg)

> Pomodoro clock Extension Settings

![Demo](./screenshots/vscode-config.jpg)

## Extension Settings

This extension contributes the following settings:

- `pomodoroClock.workTime`: Work time (in minutes, default is 25).

- `pomodoroClock.breakTime`: Short break time (in minutes, default is 5).

- `pomodoroClock.longBreakTime`: Long break time (in minutes, default is 15).

- `pomodoroClock.repeat`: Number of repeat before long break(default is 4).

- `pomodoroClock.countdown`: Whether to use countdown display(default is true).

> Tip: Reload window to apply the settings. (except `pomodoroClock.countdown`, it will take effect immediately)

## Development

- `yarn install`

- `npm run watch` or `npm run compile`

- `F5` to start debugging

## Acknowledgment

- Inspired by the [Pomodoro-code](https://marketplace.visualstudio.com/items?itemName=odonno.pomodoro-code)

- some icons come from vscode-codicons

## Thanks

Thanks you star