Riverpod Clean Feature Brick

A "feature" brick, based on Riverpod + Clean Architecture in mind, with proper usage, which means:

no dogmas
creates only what's needed
no unnecessary code
no unnecessary layers of indirection

This brick allows us to create a new feature, and its output is based on this architecture.

Architecture Summary

TL;DR, clean architecture is based on the following layers:

Presentation layer
- pages
- widgets
- providers
- controllers
- views
Domain layer
- entities
- services (or "use cases")
- repositories interfaces
- adapters
Data layer
- repositories
- sources
- models
- adapters
- etc.

We strongly simplify that, but still have the same mental/conceptual mapping. Indeed, this brick won't generate any data layer for you, as it's meant to stay... somewhere else. Check the architecture example above for more information.

Customizations

Available customizations:

codegen y/n
freezed y/n
state: none, controller, provider, both
pages y/n
models: y/n

Getting started

New to Mason? Read the documentation to learn how to spin up this brick!

Contributing

This project might need your help. Please raise issues about bugs or unexpected behaviors and submit PRs if you will.

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 riverpod_clean_feature

# Install globally
mason add -g riverpod_clean_feature

Usage 🚀

mason make riverpod_clean_feature

Variables ✨

Name	Description	Default(s)	Type
name	(empty)	something_new	string
state	(empty)	provider (provider, controller, both, no state is involved)	enum
page	(empty)	true	boolean
model	(empty)	true	boolean

Hooks 🪝

✅ Pre-Gen
✅ Post-Gen

Environment 🌎

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

0.0.3

BREAKING: removing external data - related logic from the brick
- you can find a dedicated brick for this purpose: riverpod_clean_external_data
- this was due to wrong interpretation on the architecture model, I'm sorry bout that
greatly simplified this brick's architecture

0.0.2

Updated README.md to cross reference its sibiling brick

0.0.1+1

Initial release.

The MIT License (MIT)

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.