Async Module

A Brick to create simple async features & modules for FLutter using Riverpod and Freezed

The Brick uses:

• Riverpod and
• Flutter Riverpod for state management. And
• Build Runner with
• Freezed and
• Freezed Annotation for model generation.

Requirements 🚀

Before you move forward, be sure to have

• all dependencies mentioned above added to your project trough your pubspec.yaml

How to use 🚀

First create your mason project by running mason init on any folder that you want.

Afterwards, add the library to your project.

mason add async_module

Now generate the files.

You can either fill in the variables on your CLI:

mason make async_module --module_name "Counter" --wrap_with_page false

OR

let CLI guide you through the process

mason make async_module

Variables ✨

Outputs 📦

--module_name "Counter" --wrap_with_page false
├── counter
│   ├── state_mgmt
│   │   ├── counter_controller.dart
│   │   ├── counter_state.dart
│   │   ├── counter_state.freezed.dart
│   │   └── state_mgmt.dart
│   ├── view
│   │   ├── counter.dart
│   │   └── view.dart
│   └── counter.dart
└── ...

--module_name "Counter" --wrap_with_page true
├── counter
│   ├── state_mgmt
│   │   ├── counter_controller.dart
│   │   ├── counter_state.dart
│   │   ├── counter_state.freezed.dart
│   │   └── state_mgmt.dart
│   ├── view
│   │   ├── counter_page.dart
│   │   ├── counter.dart
│   │   └── view.dart
│   └── counter.dart
└── ...

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 async_module

# Install globally
mason add -g async_module

Usage 🚀

mason make async_module

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.1.0

• 🎉: Create initial Async Module

MIT License

Copyright (c) 2022 Moritz Theis

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.