☕ coffee_required #

Because running your app before coffee is a breaking change.

coffee_required is a humorous yet practical Flutter debug-only guard that helps you:

• ⛔ Block coding before your brain boots (default: 9 AM).
• 💤 Warn about late-night commits (default: 11 PM).
• 🧘 Enforce healthy breaks during long sessions.
• 😏 Roast you with sarcastic logs and overlays.

✨ Why coffee_required? #

Every developer has done one of these:

1. Started debugging at 7:30 AM with zero caffeine.
2. Shipped a bug at 1:42 AM because "it worked on my machine".
3. Fixed something that wasn't broken.

coffee_required acts as a lightweight development gate that nudges you toward better habits—with sarcasm and ☕.

🚀 Features #

⏰ Time-Based Coffee Gate #

Block or warn when starting the app too early.

CoffeeRequired.ensure();

☕ “It’s 07:42. Your brain is still compiling.”

👔 "Corporate" Mode (New!) #

Passive-aggressive messages for the office environment.

CoffeeConfig(roastLevel: CoffeeRoastLevel.corporate);

📋 “Per company policy, coding before coffee is not optimized for synergy.”

💬 Custom Team Roasts #

Inject your own team's inside jokes.

CoffeeConfig(
  customMessages: {
    CoffeeSituation.beforeMinHour: ["Dave, go back to sleep."],
  },
);

🧋 "I Had Coffee" Override #

Bypass the gate for a configurable duration. Perfect for when you promise you are awake.

📦 Installation #

Add this to your pubspec.yaml:

dependencies:
  coffee_required: ^1.0.0

🧪 Usage #

Call before runApp():

import 'package:coffee_required/coffee_required.dart';
import 'package:flutter/material.dart';

void main() {
  // 1. Initialize
  CoffeeRequired.init(
    config: const CoffeeConfig(
      mode: CoffeeMode.warnOnly, // or blockApp
      minHour: 9, 
      maxHour: 23,
      roastLevel: CoffeeRoastLevel.sarcastic, // polite, sarcastic, savage, corporate
    ),
  );

  // 2. Enforce the gate
  CoffeeRequired.ensure();
  
  // 3. Optional: Start break reminders
  CoffeeRequired.remindBreaks();

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'My App',
      // ⚠️ IMPORTANT: Add the navigatorKey to see overlays!
      navigatorKey: CoffeeRequired.navigatorKey, 
      home: const Scaffold(body: Center(child: Text("Hello World"))),
    );
  }
}

⚙️ Configuration #

CoffeeConfig allows full customization:

🛡️ License #

MIT License. Use it, fork it, roast your team with it.