JS Arch CLI

Code generator to facilitate development

Get Start:

dart pub global activate js_cli

ou

dart pub global activate --source path ./RepositoryProject

Overview

Para tornar mais fácil e intuitivo implementar a Arquitetura Uncle Bob's Clean Architecture. Esta CLI fornece a estrutura base, onde irá gerar dinamicamente as Classes conforme mostrado nos exemplos abaixo.

Comandos:

Crie as variaveis configuraveis do seu projeto, gerando uma estrutura básica, onde ira gerar uma pasta .js_cli

js_cli init 

Gerando um novo módulo

js_cli g layer lib/app/module/home

# Generate Entity
js_cli g entity lib/app/module/home Home

// home.entitiy.dart 
class HomeEntity {

  HomeEntity();

}

# Generate UseCase
js_cli g usecase lib/app/module/home GetHomeCards

//get_home_cards.usecase.dart
abstract class GetHomeCardsUsecase {
  Future<void> call();
}

//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 Repository
js_cli g repository lib/app/module/home GetHomeCards

// 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 Dto
js_cli g dto lib/app/module/home Home

// home_dto.dart
import '../../models/entities/home_entity.dart';

class HomeDto extends HomeEntity {

  HomeDto() : super();

}

# Generate Page
js_cli g page lib/app/module/home HomeCards

# Generate Controller
js_cli g controller lib/app/module/home HomeCards

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

i, init             Gera os arquivos configuraveis do projeto...
g, gen              Geração de estruturade acordo com a opção page, datasoure, repository...
p, page             Cria uma nova pagina com um controller...
d, datasource       Cria a camada de busca dados de fontes externas...
r, repository       Cria a camada para tratar os dados...
u, usecase          Cria a camada para tratar as regras de negócio...
e, entity           Cria as entidades...
dto                 Cria os dto para transferência de dados...

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

Palavras reservadas

Reserved words can be used in the templet files that are generated in .js_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

Palavras reservadas podem ser usadas nos arquivos de modelo que são gerados em .js_cli/templete as palavras reservadas devem ser usadas dentro de mustaches {{}} exemplo {{nome}}, também podem ser usadas em palavras reservadas uma extensão, exemplo {{name.pascalCase}} cuja extensão formatará a palavra conforme necessário, você pode verificar as listas abaixo para todas as palavras reservadas e extensões

• Palavras reservadas podem ser editadas em meu_projeto\.js_cli\configs.json

Extensions

Triggers

Replace

in .js_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:

Em .js_cli/templete, um arquivo {{term}}_replace_trigger.json é gerado onde, a partir de sua anotação, ele pode aplicar uma substituição a qualquer expressão de entrada, por exemplo:

[
    {
        "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}};"
    }
]

Onde irá executar um replace no arquivo apontado, a partir da expressão

Criar novo arquivo

in .js_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. em .js_cli/templete, um arquivo {{term}}_new_file_trigger.json é gerado onde, a partir de sua anotação, ele pode criar um novo arquivo com o modelo predefinido, por exemplo:

Observe que a variável generate deve ser true para gerar o arquivo.

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

Templete

.js_cli/template/layer/complete_new_file_exemple.template

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

    //Repositories

    //Datasources
      
    //Controllers
  ];

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

Onde irá gerar um novo arquivo partir do templete definido.