Toglefritz

// Vibe Coding Style Rules for Flutter Projects

// Purpose
// These rules guide the Cursor system in building and editing Flutter apps using a consistent, scalable, and maintainable structure, inspired by clean architecture and practical experience.

// Documentation Philosophy
// All code should be documented with the assumption that another developer will continue the work.
// Excellent documentation ensures knowledge transfer, supports scalability, and reduces onboarding time.
// Every feature should include inline comments, usage examples when helpful, and README-style explanations in the feature folder when appropriate.

Toglefritz

flowchart LR
    A[Start: CLI Command] --> B[Traverse Directory Structure]
    B -->|DirectoryTraversal.findDartFiles| C{Identify Dart Files}
    C -->|Dart Files Found| D[Parse Dart Files]
    C -->|No Dart Files Found| Z[End: No Action]
    D -->|DartParser.parseFile| E{Extract Metadata}
    E -->|Classes, Methods, Fields| F[Generate Markdown Documentation]
    F -->|MarkdownGenerator.generateMarkdown| G{Write Files to Output Directory}
    G --> H[Markdown Documentation Ready]
    H --> I[Integration with Docusaurus, GitBook, MkDocs]

Toglefritz

/// A controller class designed for driving a clock interface in a Flutter application.
class ClockController with ChangeNotifier {
  /// The current time in 12-hour format.
  late DateTime _currentTime;

  // Getter for the current time
  DateTime get currentTime => _currentTime;

  /// A [DateTime] when the alarm will expire and alert the user.
  DateTime? _alarmTime;

Toglefritz

/// This block uses the setter defined in the previous example.
try {
  alarm = alarmTime;
  print('Alarm set for: $alarm');
} catch (e) {
  print('Error: $e');
}

/// This block uses the equivalent function defined in the previous example.
try {

Toglefritz

/// This is a setter used to set the value of the private variable, `_alarm`  
set alarm(DateTime alarmTime) {
    if(alarmTime.hour < 5) {
      throw Exception('Nope. That is far to early to set an alarm.');
    } else {
      _alarm = alarmTime;
    }
  }

/// This is an equivalent function, also used to set the value of the private variable, `_alarm`

Toglefritz

/// A controller class designed for driving a clock interface in a Flutter application.
class ClockController with ChangeNotifier {
  /// The current time in 12-hour format.
  late DateTime _currentTime;
  
  // Getter for the current time
  DateTime get currentTime => _currentTime;
  
    /// A [DateTime] when the alarm should be triggered
  DateTime? _alarm;

Toglefritz

/// A controller class designed for driving a clock interface in a Flutter application.
class ClockController with ChangeNotifier {
  /// The current time in 12-hour format.
  late DateTime _currentTime;
  
  // Getter for the current time
  DateTime get currentTime => _currentTime;
  
  ClockController() {
    _currentTime = DateTime.now();

Toglefritz

class SimpleClass {
  // Public variable, accessible from outside the class
  String publicVariable;
  
  // Private variable, accessible only within this class
  String _privateVariable;

  SimpleClass(this.publicVariable, this._privateVariable);
}

Toglefritz

<?xml version="1.0" encoding="utf-8"?>
<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
    <background android:drawable="@drawable/ic_launcher_background" />
    <foreground android:drawable="@mipmap/ic_launcher_foreground" />

    <monochrome android:drawable="@mipmap/ic_launcher_monochrome" />
</adaptive-icon>

Toglefritz

return FutureBuilder(
  future: CompletionsApi.getForecast(constraints.maxWidth < 300 ? 6 : 9),
  builder: (BuildContext context, AsyncSnapshot<String?> forecast) {
    if (forecast.hasData) {
      dailyForecast = forecast.data;
      return Text(dailyForecast);
    } else {
      // Display a loading indicator while waiting for the forecast
      return const CircularProgressIndicator();
    }