Mason brick with clean architecture feature

This brick generates the folder structure and empty classes for the new feature according to the clean architecture. Using this brick implies that you have the following folder structure in your project: lib/features/[feature_folder].

Getting Started

0. Make sure you have Mason installed. installation guide

dart pub global activate mason_cli

NOTE: The following commands assume that you are in the project directory (where pubspec.yaml is located)

1. Initialize mason in the current directory. This will generate a mason.yaml and allow mason to work with bricks scoped locally within the workspace.

mason init

2. Add brick to mason.yaml file.

mason add feature_clean_architecture --git-url https://github.com/alvo2k/mason_feature_clean_architecture

3. Let him cook.

mason make feature_clean_architecture

or

mason make feature_clean_architecture \
--feature_name "example brick" \
--generate_barrel_files true \
--use_equatable true \
--use_injectable false \
--use_json_serializable true \
--use_bloc true

Variables ✨

The following table outlines the variables that can be used when generating a new feature folder:

Outputs 📦

The generated folder architecture will look like this:

lib/features/example_brick/
├── data
│   ├── datasources
│   │   └── example_brick_data_source.dart
│   ├── models
│   │   ├── example_brick_model.dart
│   │   └── models.dart
│   └── repositories
│       └── example_brick_repository_impl.dart
├── domain
│   ├── entities
│   │   ├── entities.dart
│   │   └── example_brick.dart
│   ├── repositories
│   │   └── example_brick_repository.dart
│   ├── usecases
│   │   ├── example_brick_usecase.dart
│   │   └── usecases.dart
│   └── view.dart
└── presentation
    ├── bloc
    │   ├── example_brick_bloc.dart
    │   ├── example_brick_event.dart
    │   └── example_brick_state.dart
    ├── pages
    │   └── example_brick_page.dart
    └── widgets
        ├── example_brick.dart
        └── view.dart

Bloc events types

Abstract:

part of 'example_brick_bloc.dart';

abstract class ExampleBrickEvent extends Equatable {}

class LoadExampleBrick extends ExampleBrickEvent {
  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

Sealed:

part of 'example_brick_bloc.dart';

sealed class ExampleBrickEvent extends Equatable {}

final class LoadExampleBrick extends ExampleBrickEvent {
  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

Bloc state types

Abstract:

part of 'example_brick_bloc.dart';

abstract class ExampleBrickState extends Equatable {}

class ExampleBrickInitial extends ExampleBrickState {
  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

class ExampleBrickLoading extends ExampleBrickState {
  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

class ExampleBrickLoaded extends ExampleBrickState {
  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

Sealed:

part of 'example_brick_bloc.dart';

sealed class ExampleBrickState extends Equatable {}

final class ExampleBrickInitial extends ExampleBrickState {
  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

final class ExampleBrickLoading extends ExampleBrickState {
  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

final class ExampleBrickLoaded extends ExampleBrickState {
  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

Enum:

part of 'example_brick_bloc.dart';

class ExampleBrickState extends Equatable {
  const ExampleBrickState._({
    required this.status,
  });

  const ExampleBrickState.initial()
      : this._(status: ExampleBrickStatus.initial);

  final ExampleBrickStatus status;

  @override
  List<Object?> get props => [status];

  ExampleBrickState copyWith(
    ExampleBrickStatus? status,
  ) =>
      ExampleBrickState._(
        status: status ?? this.status,
      );
}

enum ExampleBrickStatus { initial, loading, loaded }

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_clean_architecture

# Install globally
mason add -g feature_clean_architecture

Usage 🚀

mason make feature_clean_architecture

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.0.1

• add: folder structure, barrel files, bloc|cubit as a state managment, use of equatable, injectable, and json_serializable packages.

MIT License Copyright (c) 2023 Aleksandr Voenkov

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.