| name | add-feature |
| description | Scaffold a new Clean Architecture feature with all layers (domain, data, presentation), DI registration, routing, and translations. Use when creating a new feature module. |
Add New Feature
Scaffold a complete Clean Architecture feature module with all required layers.
When to Use
- User asks to create a new feature, screen, or module
- User says "add feature", "create feature", "new feature"
- A new section of the app needs to be built from scratch
Instructions
Follow these steps in order. See tech_readme_files/2_development/QUICK_FEATURE_GUIDE.md and tech_readme_files/1_getting_started/PROJECT_ARCHITECTURE.md for structure and layering.
Step 1 — Create Folder Structure
lib/features/<feature_name>/
├── data/
│ ├── datasources/
│ ├── models/
│ └── repositories/
├── domain/
│ ├── entities/
│ ├── repositories/
│ └── usecases/
└── presentation/
├── bloc/
├── pages/
└── widgets/
Step 2 — Domain Entity
- File:
domain/entities/<name>_entity.dart
- Extend
Equatable
- No Flutter imports — pure Dart only
- No
fromJson/toJson
Step 3 — Domain Repository Contract
- File:
domain/repositories/<name>_repository.dart
- Abstract class only
- Return
Either<Failure, T> for every method
Step 4 — Domain Use Cases
- One file per operation:
domain/usecases/<action>_usecase.dart
- Extend
UseCase<ReturnType, Params>
- Params class extends
Equatable
- Use
NoParams when no input needed
Step 5 — Data Model
- File:
data/models/<name>_model.dart
- Extends the entity
- Add
factory fromJson(Map<String, dynamic> json) — map backend snake_case
- Add
Map<String, dynamic> toJson()
Step 6 — Data Source
- File:
data/datasources/<name>_remote_datasource.dart
- Abstract class + implementation
- Use
ApiClient for HTTP calls
- Parse with
ApiResponse.fromJson()
- Add new endpoints to
lib/core/api/api_endpoints.dart
Step 7 — Repository Implementation
- File:
data/repositories/<name>_repository_impl.dart
- Implements domain contract
- Wrap calls in try/catch with exception-to-failure mapping
Step 8 — BLoC Events
- File:
presentation/bloc/<name>_event.dart
- Abstract event extends
Equatable
Step 9 — BLoC States
- File:
presentation/bloc/<name>_state.dart
- States: Initial, Loading, Loaded (with data), Error (with message)
Step 10 — BLoC
- File:
presentation/bloc/<name>_bloc.dart
- Inject use cases via constructor
- Register event handlers in
super constructor
- Use
result.fold() for Either handling
- Log transitions with
AppLogger.logBlocTransition()
Step 11 — Pages & Widgets
- Pages:
presentation/pages/<name>_page.dart
- Widgets:
presentation/widgets/
- Use shared widgets from
lib/shared/widgets/
Step 12 — Register in DI
In lib/injection_container.dart:
- Data sources, repos, use cases →
registerLazySingleton
- BLoC →
registerFactory
- Add
BlocProvider in app.dart
Step 13 — Add Route & Translations
- Add route name to
lib/config/routes/route_names.dart
- Add GoRoute to
lib/config/routes/app_router.dart
- Add l10n keys to both
lib/l10n/arb/app_en.arb and app_ar.arb
- Run
flutter gen-l10n
Post-Completion Checklist
