ft_cli

Description:

ft cli

Flutter Arch CLI #
Code generator to facilitate clean architecture #
Documentation in pt-BR
Get Start:
dart pub global activate ft_cli
copied to clipboard
Or:
dart pub global activate --source path ./RepositoryProject
copied to clipboard
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
copied to clipboard
Create the configurable variables of your project, generating a basic structure, where will generate a .ft_cli folder.

# Generate Micro Frontend
ft_cli mf
copied to clipboard
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
copied to clipboard



# Generate Layer
ft_cli g layer lib/app/module/home
# Or
ft_cli g l lib/app/module/home
copied to clipboard

Result



# Generate Page
ft_cli g page lib/app/module/home HomeCards
# Or
ft_cli g p lib/app/module/home HomeCards
copied to clipboard

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(),
);
}
}
copied to clipboard
// presentation/ui/pages/home_cards/home_cards_controller.dart
class HomeCardsController {
bool loading = false;

void setLoading(bool value) {
loading = value;
}
}
copied to clipboard



# Generate Controller
ft_cli g controller lib/app/module/home HomeCards
# Or
ft_cli g c lib/app/module/home HomeCards
copied to clipboard

Result
// presentation/ui/pages/home_cards/home_cards_controller.dart
class HomeCardsController {
bool loading = false;

void setLoading(bool value) {
loading = value;
}
}
copied to clipboard



# Generate DataSource
ft_cli g datasource lib/app/module/home GetHomeCards
# Or
ft_cli g d lib/app/module/home GetHomeCards
copied to clipboard

Result
// data/datasources/get_home_cards_datasource.dart
abstract class GetHomeCardsDatasource {
Future<void> call();
}
copied to clipboard
// 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();
}
}
copied to clipboard



# Generate Repository
ft_cli g repository lib/app/module/home GetHomeCards
# Or
ft_cli g repository lib/app/module/home GetHomeCards
copied to clipboard

Result
// domain/repositories/get_home_cards_repository.dart
abstract class GetHomeCardsRepository {
Future<void> call();
}
copied to clipboard
// 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();
}
}
copied to clipboard



# Generate UseCase
ft_cli g usecase lib/app/module/home GetHomeCards
# Or
ft_cli g u lib/app/module/home GetHomeCards
copied to clipboard

Result
// domain/usecases/get_home_cards_usecase.dart
abstract class GetHomeCardsUsecase {
Future<void> call();
}
copied to clipboard
// 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();
}
}

copied to clipboard



# 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
copied to clipboard

Result



# Generate Service
ft_cli g service lib/app/module/home HomeCards
# Or
ft_cli g s lib/app/module/home HomeCards
copied to clipboard

Result
// domain/services/home_cards_service.dart
abstract class HomeCardsService {
Future<void> call();
}
copied to clipboard
// 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();
}
}

copied to clipboard



# Generate Entity
ft_cli g entity lib/app/module/home Home
# Or
ft_cli g e lib/app/module/home Home
copied to clipboard

Result
// domain/models/entities/home_entity.dart
class HomeEntity {
HomeEntity();
}
copied to clipboard



# Generate Dto
ft_cli g dto lib/app/module/home Home
copied to clipboard

Result
// domain/models/dtos/home_dto.dart
import '../../models/entities/home_entity.dart';

class HomeDto extends HomeEntity {
HomeDto() : super();
}
copied to clipboard



-------------------------- 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

copied to clipboard
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 Words
Default




name
Entrada pelo terminal, este valor é o último parâmetro da expressão para gerar os modelos


path
Entrada pelo terminal, caminho onde o novo arquivo será gerado


module
input input by the terminal, name of the module that will generate the new files


projectName
Entrada do nome do projeto quando é criado um componente de microfrontend


projectNameComplete
O nome do projeto concatenado com o padrão do modelo dos microfrontend


repositoryPathInterface
domain/repositories


repositoryNameFileInterface
{{name.snakeCase}}_repository


repositoryPath
data/repositories


repositoryNameFile
{{name.snakeCase}}_imp_repository


repositoryNameClassInterface
{{name.pascalCase}}Repository


repositoryNameClass
{{name.pascalCase}}ImpRepository


datasourcePathInterface
data/datasources


datasourceNameFileInterface
{{name.snakeCase}}_datasource


datasourcePath
external/datasources


datasourceNameFile
{{name.snakeCase}}_imp_datasource


datasourceNameClassInterface
{{name.pascalCase}}Datasource


datasourceNameClass
{{name.pascalCase}}ImpDatasource


usecasePathInterface
domain/usecases


usecaseNameFileInterface
{{name.snakeCase}}_usecase


usecasePath
domain/usecases


usecaseNameFile
{{name.snakeCase}}_imp_usecase


usecaseNameClassInterface
{{name.pascalCase}}Usecase


usecaseNameClass
{{name.pascalCase}}ImpUsecase


pagePath
presentation/ui/pages/{{name.snakeCase}}


pageNameFile
{{name.snakeCase}}_page


pageNameClass
{{name.pascalCase}}Page


controllerPath
presentation/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 /.



Method
Exemple




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



Extensions #



Extension
Exemple




camelCase
testeCase


constantCase
TESTE_CASE


sentenceCase
Teste case


snakeCase
teste_case


dotCase
teste.case


paramCase
teste-case


pathCase
teste/case


pascalCase
TesteCase


headerCase
Teste-Case


titleCase
Teste 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}};"
}
]
copied to clipboard
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
}
]
copied to clipboard
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
];
}

copied to clipboard
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);
});
}
copied to clipboard
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
}
]
copied to clipboard

Submit feature and bug requests to improve CLI report issues.