micro_feature_package

Developed with 💙 by Pedro Zaroni

Opinionated flutter package for a micro feature.

What's Included ✨

Out of the box, this template includes:

• ✅ Dependency Injection Structure - Opinionated structure to handle compile-time safe dependency injection between packages via Composition Root pattern.
• ✅ Opinionated code structure to implement a simple feature - The code is already separated in three main folders -- Presentation, Business Logic and Data -- as a suggestion on how to organize the code for your feature.
• ✅ Bloc - Integrated bloc architecture for scalable, testable code which offers a clear separation between business logic and presentation
• ✅ Widget and Unit tests examples for all classes
• ✅ Shared unit test setUp and tearDown via the flutter_test_config.dart convention file.
• ✅ Json Serialization via code gen
• 🚧 with more to come soon...

Output 📦

├── .gitignore
├── lib
│   ├── src
│   │   ├── di
│   │   └── features
│   │       └── feature_name
│   │           ├── presentation
│   │           │   ├── screens
│   │           │   │   └── widgets
│   │           │   └── bloc
│   │           ├── business_logic
│   │           │   ├── use_case
│   │           │   └── entities
│   │           └── data
│   │               ├── repositories
│   │               ├── data_source
│   │               └── dtos
│   └── package_name.dart
├── test
│   ├── flutter_test_config.dart
│   ├── helpers
│   │   └── pump_app.dart
│   └── src
│       └── features
│           └── feature_name
│               ├── presentation
│               │   ├── screens
│               │   │   └── widgets
│               │   └── bloc
│               ├── business_logic
│               │   ├── use_case
│               │   └── entities
│               └── data
│                   ├── repositories
│                   ├── data_source
│                   └── dtos
├── pubspec.lock
├── pubspec.yaml
└── README.md

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add micro_feature_package

# Install globally
mason add -g micro_feature_package

Usage 🚀

mason make micro_feature_package

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.49 <0.1.0"

0.1.0+1

• Initial release with DI, feature structure and more

MIT License

Copyright (c) 2023 Pedro Zaroni

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.