Feature Brick

A brick to create a feature and tests using best practices and your state management of choice! Supports Bloc, Cubit, Provider, Riverpod, None.

Note: Since version 0.6.0, the brick now uses Super Initializers for features widgets. If you are not using dart 2.17, use the below versions.

How to use 🚀

mason make feature_brick --feature_name login --state_management bloc

Variables ✨

Outputs 📦

See feature_brick_tests for tests output

--feature_name login --state_management bloc
├── login
│   ├── bloc
│   │   ├── bloc.dart
│   │   ├── login_bloc.dart
│   │   ├── login_event.dart
│   │   └── login_state.dart
│   ├── view
│   │   └── login_page.dart
│   ├── widgets
│   │   ├── login_body.dart
│   │   └── widgets.dart
│   └── login.dart
└── ...

--feature_name login --state_management cubit
├── login
│   ├── cubit
│   │   ├── cubit.dart
│   │   ├── login_cubit.dart
│   │   └── login_state.dart
│   ├── view
│   │   └── login_page.dart
│   ├── widgets
│   │   ├── login_body.dart
│   │   └── widgets.dart
│   └── login.dart
└── ...

--feature_name login --state_management provider
├── login
│   ├── provider
│   │   ├── login_provider.dart
│   │   ├── provider.dart
│   ├── view
│   │   └── login_page.dart
│   ├── widgets
│   │   ├── login_body.dart
│   │   └── widgets.dart
│   └── login.dart
└── ...

--feature_name login --state_management riverpod
├── login
│   ├── provider
│   │   ├── login_provider.dart
│   │   ├── provider.dart
│   ├── view
│   │   └── login_page.dart
│   ├── widgets
│   │   ├── login_body.dart
│   │   └── widgets.dart
│   └── login.dart
└── ...

--feature_name login --state_management none
├── login
│   ├── view
│   │   └── login_page.dart
│   ├── widgets
│   │   ├── login_body.dart
│   │   └── widgets.dart
│   └── login.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 feature_brick

# Install globally
mason add -g feature_brick

Usage 🚀

mason make feature_brick

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: "any"

0.6.2

• 🐛: Fix full path variable to make the feature name snake case inside an import
• 🧹: Abstract Bloc events that extend Equatable will now hold the overridable props

0.6.1

• 🧹: Update naming of generated test methods to match their results

0.6.0

• 🎉: Update key parameters to use dart 2.17 Super Initializers

0.5.1

• 🐛: Provider State Management gives a "Could not find the correct Provider above this Consumer Widget" error

0.5.0

• 🎉: Generate tests with the feature (100% code coverage) - Currently Bloc, Cubit, None are 100% covered

0.4.0

• 🎉: Update imports to be relative

0.3.0

• 🎉: cubit option for feature_brick
• 🎉: Add more documentation for generated files

0.2.2

• 🧹: Update prompt to confirm when asking for equatable

0.2.1

• 🧹: Update state_management variable to use enum
• 🐛: Small bug fix with using bloc

0.2.0

• 🎉:Create options for riverpod as state management generation
• 🧹: Update documentation to reflect new riverpod changes

0.1.0

• 🎉:Create options for provider as state management generation
• 🎉:Make equatable option only available for developers using bloc

0.0.4

• 🧹: Updated documentation in brick.yaml description

0.0.3

• 🧹: Reverted changes as feature causes malformed bundle (Not available)

0.0.2

• 🧹: Deprecating this package to update name to feature

0.0.1

• 🎉: Create initial Feature Brick which supports bloc and none as state management options

MIT License

Copyright (c) 2023 Luke Moody

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.