cuppa

Oh look at that, it's time for a cuppa!

Report a Bug · Request Feature

About

It's easy to spend hours programming, and forget to take a break.

Cuppa is here to remind you!

(back to top)

Installation

You can install in one of two ways

Visual Studio Marketplace

Visit cuppa and click the Install button.

VS Code

Type⌘P (⌃P on Windows) to open Quick Open and paste the following:

ext install AlDuncanson.cuppa

(back to top)

Usage

cuppa starts automatically when you open a workspace

when it's almost time (10 seconds left), cuppa will turn yellow to get your attention

when the time is up, you'll receive a notification in the bottom right

just click to reset cuppa!

Note: you can click to reset cuppa at any time

(back to top)

Configuration

cuppa is configurable!

You can edit cuppa's time and message with the following configuration keys in your User/settings.json file

Or type ⌘⇧P (⌃⇧P on Windows) to open Command Palette and type Preferences: Open Settings (UI), then search for cuppa

(back to top)

Roadmap

• [x] user settings
  • custom reminder time
  • custom reminder message
• [x] command palette commands
  • reset cuppa reminder
• [x] configure the trigger time for the 'warning' state from the default 10s to any value
• [x] setup Github discussions
• [ ] custom side bar panel

See requested features and ideas in cuppa Discussions!

(back to top)

Contributing

Contributions are greatly appreciated.

If you have a suggestion that would make cuppa better, you can open an issue with the tag "enhancement".

Or feel free to fork the project and open a pull request with your suggested changes.

Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Al Duncanson

• @al_duncanson
• alexjduncanson@gmail.com

(back to top)

Acknowledgments

• Choose an Open Source License
• Project badges
• Code screenshots

(back to top)