Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/housebirdgames/mindful-coding
A Visual Studio Code Extension that reminds you to take breaks for window-gazing and stretching.
https://github.com/housebirdgames/mindful-coding
mindfulness productivity reminder visual-studio-code vscode vscode-extension well-being
Last synced: about 1 month ago
JSON representation
A Visual Studio Code Extension that reminds you to take breaks for window-gazing and stretching.
- Host: GitHub
- URL: https://github.com/housebirdgames/mindful-coding
- Owner: HousebirdGames
- Created: 2024-03-05T15:38:42.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-16T07:35:04.000Z (9 months ago)
- Last Synced: 2024-03-16T21:03:54.613Z (9 months ago)
- Topics: mindfulness, productivity, reminder, visual-studio-code, vscode, vscode-extension, well-being
- Language: JavaScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=HousebirdGames.mindful-coding
- Size: 1.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Mindful Coding
Mindful Coding helps you enhance your productivity and well-being by reminding you to take short breaks for window-gazing, stretching, and custom activities throughout your coding sessions.
## Features
Mindful Coding offers customizable reminders to:
- **Look Away**: Gaze out of a window every 20 minutes (customizable) to reduce eye strain and refresh your mind.
- **Stretch**: Take a brief stretching break every 45 minutes (customizable) to keep your body relaxed and prevent muscle stiffness.
- **Custom Reminders**: Create your own reminders for any activity you want to incorporate into your routine.
Choose how you receive reminders:
- **Notification**: A gentle pop-up notification.
- **Status Bar**: A discreet message in the VSCode status bar.
- **Annoying Popup**: A more insistent pop-up to make sure you don't skip your break.
## Getting Started
1. **Install Mindful Coding** from the VSCode Marketplace.
2. **Configure your preferences** in the VSCode settings under `Extensions > Mindful Coding`.
- Set reminder intervals (minimum time is 1 minute).
- Choose the reminder type.
- Enable or disable specific reminders.
- Add, edit, or delete custom reminders.
## Usage
Once installed and configured, Mindful Coding runs automatically in the background. Depending on your settings, you'll receive notifications reminding you to take breaks.
- Click on the reminder or the status bar message to acknowledge and dismiss the notification.
- Use the command `Open Mindful Coding Settings` from the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) to adjust settings at any time.
- Use the command `Manage Custom Reminders` to add, edit, or delete your custom reminders.
## Customization
Customize Mindful Coding via the settings:
```json
"mindfulCoding.reminderType": "Notification",
"mindfulCoding.enableWindowGazeReminder": true,
"mindfulCoding.windowGazeInterval": 20,
"mindfulCoding.enableStretchReminder": true,
"mindfulCoding.stretchInterval": 45,
"mindfulCoding.enableCustomReminders": true,
"mindfulCoding.customReminders": [
{
"text": "Drink water",
"interval": 30
}
]
```
Custom Reminders:
- The reminder message cannot be empty.
- The minimum interval for any reminder is 1 minute.
- You can enable or disable all custom reminders using the `enableCustomReminders` setting.
## Contributing
Contributions are welcome! Check out the [GitHub repository](https://github.com/HousebirdGames/Mindful-Coding.git) for source code, to report issues, or suggest improvements.