scaffold-flutter-package

/scaffold-flutter-package

Scaffold a new component or domain model into shared Flutter packages within a Melos monorepo.

Usage

/scaffold-flutter-package shared_ui <ComponentName>
/scaffold-flutter-package shared_core <ModelName>

shared_ui — New UI Component

Target: packages/shared_ui/lib/components/<component_name>/

Structure:

packages/shared_ui/lib/components/<component_name>/
  <component_name>.dart          # Main widget (StatelessWidget — no Riverpod imports)
  index.dart                     # Barrel export

After creating, add to the package's main export file (e.g., packages/shared_ui/lib/shared_ui.dart):

export 'components/<component_name>/index.dart';

Rules for shared_ui components

• Components in shared_ui are dumb — they receive all data via constructor input() or constructor args and emit events via VoidCallback/Function(T). Zero inject() or ref.watch() calls.
• Add // Tier: Atom | Molecule | Organism as the first comment in the component file before all imports.
• Never put app-specific logic or service calls inside a shared_ui component.
• Never duplicate a component that already exists in shared_ui in an individual app.

shared_core — New Domain Model

Target: packages/shared_core/lib/models/<model_name>/

Structure:

packages/shared_core/lib/models/<model_name>/
  <model_name>.dart              # Freezed model with json_serializable
  <model_name>.freezed.dart      # Generated — run melos run build_runner
  <model_name>.g.dart            # Generated JSON serialization
  index.dart                     # Barrel export

Template for <model_name>.dart:

import 'package:freezed_annotation/freezed_annotation.dart';

part '<model_name>.freezed.dart';
part '<model_name>.g.dart';

@freezed
class <ModelName> with _$<ModelName> {
  const factory <ModelName>({
    required String id,
    // add fields here
  }) = _<ModelName>;

  factory <ModelName>.fromJson(Map<String, dynamic> json) =>
      _$<ModelName>FromJson(json);
}