clean_architecture_feature

0.0.5(last year)76

A building block to easily create feature folders using the Clean Architecture approach.

Repository

github.com/jigarfumakiya/clean_architecture_feature

Install

> mason add clean_architecture_feature

Readme Usage Changelog License

🏗️ clean_architecture_feature

Installation

Make sure you have Mason installed. If you don't have it installed, follow the installation guide to get started.

Once you have Mason installed, you can add the clean_architecture_feature brick to your Mason configuration by adding the following code to your mason.yaml file:

bricks:
  clean_architecture_feature: 0.0.5

Usage

To use the clean_architecture_feature brick, you can run the following command in your terminal:

mason make clean_architecture_feature

Variables ✨

The following table outlines the variables that can be used when generating a new feature folder: Look for the variables in the brick.yaml file in github brick.yaml

Variable	Description	Required	Type
`feature_name`	🏷️ Name of the feature	`Yes`	`string`
`use_bloc`	🧱 Determine if you need BLoC for the feature or not	`Yes`	`bool`
`test_dir`	📁 Determine if you need a test directory structure	`No`	`bool`

Output 📦

The generated folder architecture will look like this:

lib/
├── features
│   ├── featureName
│   │   ├── data
│   │   │   ├── datasources
│   │       │   ├── feature_name_remote_source.dart
│   │   │   ├── models
│   │       │   ├── feature_name_network.dart
│   │   │   └── repositories
│   │       │   ├── feature_name_repository_impl.dart
│   │   ├── domain
│   │   │   ├── repositories
│   │       │   ├── feature_name_repository.dart
│   │   │   └── usecases
│   │       │   ├── feature_name_use_case.dart
│   │   └── presentation
│   │       ├── bloc
│   │       │   ├── feature_name_bloc.dart
│   │       ├── widget
│   │       │   ├── feature_name_widget.dart

Contributors 💻

Jigar Fumakiya - Linkedin

if you found this brick helpful, please consider showing your support by giving it a ⭐ on GitHub. Your support is greatly appreciated! 🙏🎉 Additionally, feel free to let me know if you have any suggestions for additional features.

To learn more about the Clean Architecture approach, check out the Reso Coder Clean Architecture Course .

License 🍀

MIT License
Copyright (c) 2023 Jigar Fumakiya

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.

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 clean_architecture_feature

# Install globally
mason add -g clean_architecture_feature

Usage 🚀

mason make clean_architecture_feature

Variables ✨

Name	Description	Default(s)	Type
feature_name	The name of the feature, used for naming the folder, files, and widget.	(empty)	string
use_bloc	Specifies whether the feature should use BLoC for state management.	(empty)	boolean
test_dir	Specifies whether a test directory structure including subfolders and files should be created.	(empty)	boolean

Hooks 🪝

❌ Pre-Gen
❌ Post-Gen

Environment 🌎

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

MIT License
Copyright (c) 2023 Jigar Fumakiya

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.