generate

Generates files based on a schematic for organizing your project's structure.

With any generated schematic template, this generates simple di code, and tests to help you quickly expand your project.

This has the following schematic templates:

• screen
• service
• widget

Getting Started 🚀

The generated code may depend on go_router, flutter_riverpod, riverpod, flutter_test (dev), or test (dev) packages.

• Each screen has a private class with navigation information. This class contains a GoRoute declaration from go_router package for the screen. In future, this class will also have methods to create a path for navigating to this screen using path and query parameters.
• The providers of service and controllers use flutter_riverpod and riverpod packages.
• The tests that are generated use flutter_test and test packages.

Table of Contents

• How to use
  • Model from Command Line
  • Model from Config
• Outputs
  • Screen
  • Service
  • Widget

How to use 🚀

Command Line

mason make generate --schematic screen --name hello_world --di riverpod

Then add your methods in the service! (Optional and available only for service)

Variables for the Command Line ✨

Config

mason make generate -c generate_config.json

Example Config:

{
  "schematic": "screen", // Could be screen, service, or widget
  "name": "hello world",
  "di": "riverpod" // Could be riverpod
}

Variables for a Config ✨

Outputs 📦

Screen

Creates a new, screen definition in the given project with controllers, providers, state, and tests.

--schematic screen --name hello_world --di riverpod
├── lib
│   └── screens
│       └── hello_world
│           ├── hello_world_controller.dart
│           ├── hello_world_provider.dart
│           ├── hello_world_screen.dart
│           ├── hello_world_state.dart
│           └── hello_world.dart
├── tests
│   └── screens
│       └── hello_world
│           └── hello_world_screen_test.dart
└── ...

Example of a generated Screen

Service

Creates a new, generic service class definition in the given project with provider, abstract class, and tests.

--schematic service --name hello_world --di riverpod
├── lib
│   └── services
│       └── hello_world
│           ├── hello_world.dart
│           ├── hello_world_provider.dart
│           ├── hello_world_service.dart
│           └── hello_world_service_impl.dart
├── tests
│   └── services
│       └── hello_world
│           └── hello_world_service_test.dart
└── ...

Example of a generated Service

Widget

Creates a new, generic widget definition in the given project with its inherited theme (optional), and tests.

--schematic widget --name hello_world --di riverpod
├── lib
│   └── widgets
│       └── hello_world
│           ├── hello_world_theme.dart
│           └── hello_world.dart
├── tests
│   └── widgets
│       └── hello_world
│           ├── hello_world_theme_test.dart
│           └── hello_world_test.dart
└── ...

Example of a generated Widget

Roadmap

• Support for go_router configs generation and updation when a screen is added
• Support for bloc as a di for screens or services
• Support for code generation for layer-first, or feature-first project structure.

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 generate

# Install globally
mason add -g generate

Usage 🚀

mason make generate

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ❌   Post-Gen

Environment 🌎

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

0.1.4+1

• Replace state_notifier import with riverpod in controller.

0.1.4

• Update file names in template to use a smaller path (Path length reduced upto 11-30%)

0.1.3

• Fix pre-gen hook ending with error.
• Add missing @override annotation in templates.
• Add simple tests for pre-gen hooks.
• You can disable generation of tests by using the has_tests variable.

0.1.2+1

• Update README.md

0.1.2

• Add InheritedTheme generation for widget schematic in the pre_gen hook.

0.1.1

• Update README
• Add widget as a schematic

0.1.0+1

• Add screen schematic generation
• Add service schematic generation
• Add riverpod for di with screen or service
• Add test generation for screen and service

BSD 3-Clause License

Copyright (c) 2023, Syed Mushaheed All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.