formigas Feature Brick

A brick that provides the files and structure for a feature how we implement it at formigas in our Flutter projects. It follows the principles of the MVC-pattern.

Pre-requisites 🛠️

• Mason CLI

Usage 🏗️

1. Navigate to the project you want to add the feature to and run:

mason init

2. Add the formigas_feature to mason by running:

mason add formigas_feature

The formigas_feature brick should show up in the list of mason bricks:

$ mason list
/Users/User/foo/bar
└── formigas_feature {VERSION} -> registry.brickhub.dev

3. Generate the feature in your project:

mason make formigas_feature

Output 📦

├── features
│   ├── counter
│   │   ├── cubit
│   │   │   ├── counter_cubit.dart
│   │   │   ├── counter_state.dart
│   │   │   ├── counter_state.freezed.dart
│   │   └── counter_view.dart

Dependencies

Following dependencies will be installed for this brick if they are not yet present:

• flutter_bloc
• bloc_test
• freezed_annotation
• freezed
• build_runner

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 formigas_feature

# Install globally
mason add -g formigas_feature

Usage 🚀

mason make formigas_feature

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.1.0

• Initial release

MIT License

Copyright (c) 2024 formigas GmbH

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.