md_feature

Brick for creating new feature from template using the mason 🧱

[TOC]

Getting Started 🚀

Requirements

This brick requires packages to be installed

• flutter_bloc
• dio
• retrofit
• build_runner (as dev dependency)
• retrofit_generator (as dev dependency)

(All required dependencies can be added automatically using post_gen.dart hook with optional function)

Installation

Initialize and add brick using mason_cli

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

# 🚀 Initialize mason
mason init

# 📦 Install the brick
mason add md_feature

To create a feature, you must provide values:

• project_name - name of the project to import package (you can take it from name field inside pubspec.yaml of the project)
• feature_name - name of the created feature, for example if path to your features directory is lib/src/features/, provide src/features
• path_to_feature - path to the generated feature to add path imports
• use_fvm - is project uses fvm for flutter versioning

You can create json file for persistent variable values

{
  "project_name": "example_project",
  "path_to_feature": "src/features",
  "use_fvm": true
}

Use it with the command

mason make md_feature -c config.json

For custom output path provide additional -o argument

mason make md_feature -c config.json -o lib/src/features/

Output

Created feature structure will look like this

├ {{feature}}
│├── bloc
││├── {{feature}}_bloc.dart
││├──  {{feature}}_bloc_data.dart
││├──  {{feature}}_bloc_event.dart
││└── {{feature}}_bloc_state.dart
│├── data
││├──  data_source
│││├── {{feature}}_remote_data_source.dart
│││└── {{feature}}_remote_data_source.g.dart
││├── repository
│││└─── {{feature}}_repository_impl.dart
   └── domain
      └── interface
          └── i_{{feature}}_repository.dart

TODO

• describe every feature layer in the README.md
• create tests
• provide entity script example
• provide model script example

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 md_feature

# Install globally
mason add -g md_feature

Usage 🚀

mason make md_feature

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.0.2 - 2024-10-07

• Add 'copyWith' method for BLoC data class
• Rename map to when in BLoC state and event classes
• Fix /bin/sh: fvm dart: command not found when using fvm

1.0.1 - 2024-09-17

• Add use_fvm variable
• Add repository field to generated bloc script
• Add post_gen.dart commands logging
• Update README.md

1.0.0 - 2024-08-12

• Initial release of the brick.

Copyright (c) 2024 mentally_unstable

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.