Feature Brick

Brick para iniciar qualquer feature do seu projeto ja com os arquivos criados na arquitetura que utilizamos hoje na Jera.

O módulo vem com a view, view_controller e view_model criada com o nome de sua preferencia, também existe a possibilidade opcional de gerar ou não a factory ou módulo (Service Locator) da feature com a rota pronta para adicionar ao mobile_router.dart.

A estrutura das pastas e arquivos gerados para factory é essa:

• {name_feature}
  • di
    • {name_feature}_factory.dart
  • {name_feature}_view.dart
  • {name_feature}_view_controller.dart
  • {name_feature}_view_model.dart

A estrutura das pastas e arquivos gerados para Service Locator é essa:

• {name_feature}
  • module
    • {name_feature}_module.dart
  • {name_feature}_view.dart
  • {name_feature}_view_controller.dart
  • {name_feature}_view_model.dart

Como instalar e gerar os arquivos

Para utilizar da brick adicione ela ao seu mason.yaml com o nome jera_create_feature.

$ mason add jera_create_feature

Logo após adicionar rode o comando para gerar os arquivos dentro de seu projeto:

$ mason make jera_create_feature -o lib/features 

Note que o que vem depois do -o é o path no qual você gostaria de adicionar essa funcionalidade.

Após isso seu terminal fará duas perguntas, uma para você definir o nome da sua feature, e outra se deve gerar ou não sua factory você deve digitar s para gerar e n para não gerar.

Dependencias do modulo

Ao criar sua feature ainda não sera possivel navegar até a tela em si e também não havera nenhum layout predefinido apenas gerará o necessário para começar uma nova tela, para navegar para sua nova funcionalidade você deverá adicionar a rota gerada do seu factory (caso possua um próprio) no seu mobile router, do contrário deverá adicionar ao seu factory atual essa nova feature.
Segue o código que deve ser adicionado ao MobileRouter:

static final Map<String, WidgetBuilder> routes = {
  ...
  /// Feature route
  {NameFeature}Factory.nameFeature: (_) {
    return {NameFeature}Factory.nameFeatureRoute();
  },
}

A sua parte na brick

Esse módulo de Create Feature é uma base para a sua nova funcionalidade para otimizar o seu tempo criando e nomeando arquivos. Porém precisa que você de fato execute o que essa feature deveria fazer.

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 jera_create_feature

# Install globally
mason add -g jera_create_feature

Usage 🚀

mason make jera_create_feature

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.3.0+7

• Adicionado outro condicional para gerar o módulo do Service Locator.

0.1.0+1

• Na primeira versão geramos os arquivos e protocolos, com factory e rota de navegação.

MIT License

Copyright (c) 2023 Jera Software

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.