Flutter Arch CLI

Code generator to facilitate clean architecture

Documentation in pt-BR

Get Start:

dart pub global activate ft_cli

Or:

dart pub global activate --source path ./RepositoryProject

Overview

To make it easier and more intuitive to implement Uncle Bob's Clean Architecture. This CLI provides the base structure, where will dynamically generate the Classes as shown in the examples below.

You can also have the advantage of editing in an easy and dynamic way through the editing of template and triggers to apply replace in some piece of code and create new files from the commands.

Commands:

ft_cli init 

Create the configurable variables of your project, generating a basic structure, where will generate a .ft_cli folder.


# Generate Micro Frontend
ft_cli mf

Select the component you want to create and write the name in snakeCase.

Result
? Qual componente você deseja criar? › 
❯ micro_app
  micro_commons
  micro_core
  base_app


# Generate Layer
ft_cli g layer lib/app/module/home
# Or
ft_cli g l lib/app/module/home
Result


# Generate Page
ft_cli g page lib/app/module/home HomeCards
# Or
ft_cli g p lib/app/module/home HomeCards
Result
// presentation/ui/pages/home_cards/home_cards_page.dart
import 'package:flutter/material.dart';
import 'home_cards_controller.dart';

class HomeCardsPage extends StatefulWidget {

  @override
  _HomeCardsPageState createState() => _HomeCardsPageState();
}

class _HomeCardsPageState extends State<HomeCardsPage> {
  final GlobalKey<ScaffoldState> scaffoldKey = GlobalKey<ScaffoldState>();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      key: scaffoldKey,
      appBar: const AppBar(),
      body: const Container(),
    );
  }
}
// presentation/ui/pages/home_cards/home_cards_controller.dart
class HomeCardsController {
  bool loading = false;

  void setLoading(bool value) {
    loading = value;
  }
}


# Generate Controller
ft_cli g controller lib/app/module/home HomeCards
# Or
ft_cli g c lib/app/module/home HomeCards
Result
// presentation/ui/pages/home_cards/home_cards_controller.dart
class HomeCardsController {
  bool loading = false;

  void setLoading(bool value) {
    loading = value;
  }
}


# Generate DataSource
ft_cli g datasource lib/app/module/home GetHomeCards
# Or
ft_cli g d lib/app/module/home GetHomeCards
Result
// data/datasources/get_home_cards_datasource.dart
abstract class GetHomeCardsDatasource {
  Future<void> call();
}
// external/datasources/get_home_cards_imp_datasource.dart
import '../../data/datasources/get_home_cards_datasource.dart';

class GetHomeCardsImpDatasource implements GetHomeCardsDatasource {
  @override
  Future<void> call() {
    // TODO: implement call
    throw UnimplementedError();
  }
}


# Generate Repository
ft_cli g repository lib/app/module/home GetHomeCards
# Or
ft_cli g repository lib/app/module/home GetHomeCards
Result
// domain/repositories/get_home_cards_repository.dart
abstract class GetHomeCardsRepository {
  Future<void> call();
}
// data/repositories/get_home_cards_imp_repository.dart
import '../../repositories/get_home_cards_repository.dart';

class GetHomeCardsImpRepository implements GetHomeCardsRepository {
  @override
  Future<void> call() {
    // TODO: implement call
    throw UnimplementedError();
  }
}


# Generate UseCase
ft_cli g usecase lib/app/module/home GetHomeCards
# Or
ft_cli g u lib/app/module/home GetHomeCards
Result
// domain/usecases/get_home_cards_usecase.dart
abstract class GetHomeCardsUsecase {
  Future<void> call();
}
// domain/usecases/get_home_cards_imp_usecase.dart
import 'get_home_cards_usecase.dart';

class GetHomeCardsImpUsecase implements GetHomeCardsUsecase {
  @override
  Future<void> call() {
    // TODO: implement call
    throw UnimplementedError();
  }
}
  


# Generate UseCase, Repository and DataSource
ft_cli g usecase lib/app/module/home GetHomeCards -r -d
# Or
ft_cli g u lib/app/module/home GetHomeCards -r -d
Result


# Generate Service
ft_cli g service lib/app/module/home HomeCards
# Or
ft_cli g s lib/app/module/home HomeCards
Result
// domain/services/home_cards_service.dart
abstract class HomeCardsService {
  Future<void> call();
}
// domain/services/home_cards_imp_service.dart
import 'home_cards_service.dart';

class HomeCardsImpService implements HomeCardsService {
  @override
  Future<void> call() {
    // TODO: implement call
    throw UnimplementedError();
  }
}
  


# Generate Entity
ft_cli g entity lib/app/module/home Home
# Or
ft_cli g e lib/app/module/home Home
Result
// domain/models/entities/home_entity.dart 
class HomeEntity {
  HomeEntity();
}


# Generate Dto
ft_cli g dto lib/app/module/home Home
Result
// domain/models/dtos/home_dto.dart
import '../../models/entities/home_entity.dart';

class HomeDto extends HomeEntity {
  HomeDto() : super();
}


-------------------------- HELPS --------------------------

i, init             Gera os arquivos configuraveis do projeto...
Exemplo: ft_cli init

mf, microfrontend   Seleciona a opção para criação de novos componentes de microfrontend...
Exemplo: ft_cli mf

l, layer            Gera a estrutura de pastas de um modulo...
Exemplo: ft_cli g l lib/app/modules/nome_modulo

p, page             Cria uma nova pagina com um controller...
Exemplo: ft_cli g p lib/app/modules/nome_modulo Nome

c, controller       Cria um novo controller...
Exemplo: ft_cli g c lib/app/modules/nome_modulo Nome

d, datasource       Cria a camada de busca dados de fontes externas...
Exemplo: ft_cli g d lib/app/modules/nome_modulo Nome

r, repository       Cria a camada para tratar os dados...
Exemplo: ft_cli g r lib/app/modules/nome_modulo Nome

u, usecase          Cria a camada para tratar as regras de negócio...
Exemplo: ft_cli g u lib/app/modules/nome_modulo Nome

s, service          Cria a camada para tratar os serviços...
Exemplo: ft_cli g s lib/app/modules/nome_modulo Nome

e, entity           Cria as entidades...
Exemplo: ft_cli g e lib/app/modules/nome_modulo Nome

dto                 Cria os dto para transferência de dados...
Exemplo: ft_cli g dto lib/app/modules/nome_modulo Nome

Reserved Words

The reserved words can be used in the templet files that are generated in .ft_cli/templete the reserved words must be used inside mustaches {{}} example {{name}}, can also be used in reserved words an extension, example {{name.pascalCase}} whose extension will format the word as needed, you can check the lists below for all reserved words and extensions.

  • Reserved words can be edited in my_project\.ft_cli\configs.json
Reserved WordsDefault
nameEntrada pelo terminal, este valor é o último parâmetro da expressão para gerar os modelos
pathEntrada pelo terminal, caminho onde o novo arquivo será gerado
moduleinput input by the terminal, name of the module that will generate the new files
projectNameEntrada do nome do projeto quando é criado um componente de microfrontend
projectNameCompleteO nome do projeto concatenado com o padrão do modelo dos microfrontend
repositoryPathInterfacedomain/repositories
repositoryNameFileInterface{{name.snakeCase}}_repository
repositoryPathdata/repositories
repositoryNameFile{{name.snakeCase}}_imp_repository
repositoryNameClassInterface{{name.pascalCase}}Repository
repositoryNameClass{{name.pascalCase}}ImpRepository
datasourcePathInterfacedata/datasources
datasourceNameFileInterface{{name.snakeCase}}_datasource
datasourcePathexternal/datasources
datasourceNameFile{{name.snakeCase}}_imp_datasource
datasourceNameClassInterface{{name.pascalCase}}Datasource
datasourceNameClass{{name.pascalCase}}ImpDatasource
usecasePathInterfacedomain/usecases
usecaseNameFileInterface{{name.snakeCase}}_usecase
usecasePathdomain/usecases
usecaseNameFile{{name.snakeCase}}_imp_usecase
usecaseNameClassInterface{{name.pascalCase}}Usecase
usecaseNameClass{{name.pascalCase}}ImpUsecase
pagePathpresentation/ui/pages/{{name.snakeCase}}
pageNameFile{{name.snakeCase}}_page
pageNameClass{{name.pascalCase}}Page
controllerPathpresentation/ui/pages/{{name.snakeCase}}
controllerNameFile{{name.snakeCase}}_controller
controllerNameClass{{name.pascalCase}}Controller

Methods

The Methods can be used in triggers or templates, and work in sequence, example {{path.replace(str1,str2).replace(str3, str4)}}.

WARNING: If changing routes, use in Windows \\ and in Mac or Linux /.

MethodExemple
replace{{path.replace(string1,string2)}}

Extensions

ExtensionExemple
camelCasetesteCase
constantCaseTESTE_CASE
sentenceCaseTeste case
snakeCaseteste_case
dotCaseteste.case
paramCaseteste-case
pathCaseteste/case
pascalCaseTesteCase
headerCaseTeste-Case
titleCaseTeste Case

Triggers

In .ft_cli/templete a {{term}}_replace_trigger.json file is generated where from your annotation it can apply a replace to any input expression, for example:

[
    {
        "pathFile": "{{path}}\\{{module}}_module.dart",
        "from": "//imports",
        "to": "//imports\nimport '{{controllerPath}}/{{controllerNameFile}}.dart';"
    },
    {
        "pathFile": "{{path}}\\{{module}}_module.dart",
        "from": "//Dependence",
        "to": "//Dependence\nfinal {{controllerNameClass.camelCase}} = {{controllerNameClass.pascalCase}};"
    }
]

Where will perform a replace on the pointed file, from the expression.

Generate new file

In .ft_cli / templete a file {{term}} _ new_file_trigger.json is generated where, from his annotation, he can create a new file with the pre-defined templete, for example:

Note, the generate variable must be true to generate the file.

[
    {
        "pathFile": "{{path}}\\{{module}}_module",
        "pathTemplete": ".ft_cli/template/layer/complete_new_file_exemple.template",
        "generate": true
    }
]

Templates

.ft_cli/template/layer/complete_new_file_exemple.template

class {{module.pascalCase}}Module extends Module {
  @override
  final List<Bind> binds = [
    //Usecases

    //Repositories

    //Datasources
      
    //Controllers
  ];

  @override
  final List<ModularRoute> routes = [
    //Pages
  ];
}

Where will generate a new file from the defined template.

Tests

To add tests, just create a template, example:

import 'package:flutter_test/flutter_test.dart';

import 'package:{{path.replace(\,/).replace(lib/,)}}/{{name.snakeCase}}';

void main() {
  test('adds one to input values', () {
    final calculator = Calculator();
    expect(calculator.addOne(2), 3);
    expect(calculator.addOne(-7), -6);
    expect(calculator.addOne(0), 1);
  });
}

Then add the path of the template in the trigger of creation of the class to be tested, making a replace of the path of this class, forwarding the test file to the tests folder, example:

[
    {
        "pathFile": "{{path.replace(lib/app,test)}}/{{name.snakeCase}}_test",
        "pathTemplete": ".ft_cli/template/example_test.template",
        "extension": "dart",
        "replaceOldFileWithNew": false,
        "generate": true
    }
]

Submit feature and bug requests to improve CLI report issues.

Libraries

app_module
base_app
base_app_controller
bool_utils
constants
controller_design_pattern
datasource_design_pattern
datasource_interface_design_pattern
design_pattern
design_pattern_controller
dialog_utils
directory_utils
dto_design_pattern
entity_design_pattern
file_exists_error
generate_layer_controller
generate_new_file
generate_replace_file
generate_scripts
get_version_controller
global_variable
help_command_controller
init_controller
localization
micro_app
micro_app_controller
micro_commons
micro_commons_controller
micro_core
micro_core_controller
microfrontend
microfrontend_controller
new_file_dto
output_utils
page_design_pattern
path
replace_dto
repository_design_pattern
repository_interface_design_pattern
reserved_words
service_design_pattern
service_interface_design_pattern
triggers_utils
usecase_design_pattern
usecase_interface_design_pattern
validate_arguments
wellcome_message