Models Bundle

A brick to create multiple models including their properties and all the supporting methods/extensions!

This brick is primarily meant to be used with a config template to generate multiple models using the existing model brick

Table of Contents

• How to use
  • Model from Config
• Outputs

How to use 🚀

Config

mason make model -c models_bundle_config.json

Example Config:

{
  "models": [
    {
      "model_name": "chat",
      "additionals": ["copyWith", "json", "equatable"],
      "style": "json_serializable",
      "relations": [{ "name": "person" }],
      "properties": [
        { "name": "id", "type": "int" },
        { "name": "message", "type": "String" },
        { "name": "sentTime", "type": "DateTime" },
        { "name": "chatImage", "type": "String" },
        { "name": "isForwarded", "type": "bool" },
        { "name": "toUsers", "type": "List<Person>" }
      ]
    },
    {
      "model_name": "person",
      "additionals": ["copyWith", "json", "equatable"],
      "style": "json_serializable",
      "properties": [
        { "name": "id", "type": "int" },
        { "name": "firstName", "type": "String" },
        { "name": "lastName", "type": "String" },
        { "name": "age", "type": "int" },
        { "name": "isHappy", "type": "bool" },
        { "name": "favouriteNumber", "type": "int" },
        { "name": "nicknames", "type": "List<String>" },
        { "name": "countriesVisited", "type": "List<String>" },
        { "name": "organizationId", "type": "String" }
      ]
    },
    {
      "model_name": "organization",
      "additionals": ["copyWith", "json", "equatable"],
      "style": "json_serializable",
      "relations": [{ "name": "person" }],
      "properties": [
        { "name": "id", "type": "int" },
        { "name": "name", "type": "String" },
        { "name": "users", "type": "List<Person>" },
        { "name": "address", "type": "String" }
      ]
    },
...
  ]
}

Variables for a Config ✨

Outputs 📦

mason make model -c models_bundle_config.json

├── models
│   ├── chat.dart
│   ├── chat.g.dart
│   ├── inbox_item.dart
│   ├── inbox_item.g.dart
│   ├── organization.dart
│   ├── organization.g.dart
│   └── organization.freezed.dart
└── ...

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 models_bundle

# Install globally
mason add -g models_bundle

Usage 🚀

mason make models_bundle

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: "any"

0.0.1

• Create initial models_bundle Brick

MIT License

Copyright (c) 2022 Luke Moody

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.