generator-xdk

Gerador para projetos que utilizam a XDK.

Instalação

Primeiro, instale o Yeoman e o generator-xdk usando npm (assumindo que o node.js já está instalado).

npm install -g yo
npm install -g generator-xdk

Para utilizar:

yo xdk:dotnet # Criar itens para projetos .NET Core
yo xdk:front --force # Criar itens para projetos frontend

.NET Core

Você pode usar o gerador simplesmente rodando o comando yo xdk:dotnet e seguir o fluxo das informações solicitadas. Mas você também pode utilizar parâmetros para passar as informações necessárias. As opções são:

Uso:

yo xdk:dotnet [opções] [argumentos]

Opção	Descrição
-a|--application	Cria classe de serviço no projeto da aplicação (Application) e interface no projeto de contratos (Contracts).
-d|--domain	Cria classe de serviço no projeto de domínio (Domain) e interface no projeto de contratos (Contracts).
-c|--controller	Cria um controle no projeto API (UserInterface)
-f|--full	Cria uma estrutura completa contendo serviço e interface de aplicação e domínio e controle (Application, Domain, Contracts e UserInterface)
-t|--type [base|list|search|entity]	Informa o tipo de estrutura a ser criada, simples (base), com listagem (list), com pesquisa (search) ou completa (entity).
-idt|--idType [Guid|int|etc]	Tipo do ID (qualquer tipo C# aceito pela XDK, ex: Guid, int, etc). Usado apenas quando um controle é gerado e a estrutura não for simples.
-en|--entityName Produto	Nome da entidade (usando a formatação exata, ex: produtodaempresa != ProdutoDaEmpresa).
-ep|--entityPlural Produtos	Nome da entidade no plural (usando a formatação exata, ex: produtosdaempresa != ProdutosDaEmpresa).
-im|--inputModel Produto[Input|Model]	Nome do input (usando a formatação exata, ex: produto[input|model] != Produto[Input|Model]).
-rm|--responseModel Produto[Response|Model]	Nome do input (usando a formatação exata, ex: produto[response|model] != Produto[Response|Model]).

É importante lembrar que o uso das opções é facultativo. As perguntas necessárias serão feitas e suas opções possíveis exibidas, caso não sejam informadas no comando.

Angular

Você pode usar o gerador simplesmente rodando o comando yo xdk:front e seguir o fluxo das informações solicitadas. Mas você também pode utilizar parâmetros para passar as informações necessárias. As opções são:

Uso:

yo xdk:front [opções] [argumentos]

Opção	Descrição
-t|--type [project]	Tipo da estrutura a ser criada: project (criar projeto), table (cria uma página com uma tabela de pesquisa), tablewf (cria uma página com uma tabela de pesquisa e um formulário relacionado), form (cria uma página com um formulário) ou store (cria um store).

É importante lembrar que o uso das opções é facultativo. As perguntas necessárias serão feitas e suas opções possíveis exibidas, caso não sejam informadas no comando.

Tipo projeto (project)

Ao criar um projeto será necessário fornecer as seguintes informações:

• Versão da biblioteca XDK será utilizada
• Nome da aplicação (apenas letras minúsculas e números sem espaços; ex: cadastro-usuarios, sistema-seguranca)
• Se a aplicação vai utilizar um autorizador externo para fazer a autenticação
  • Se a anterior for verdadeira, informar se a aplicação vai utilizar o autorizador da ITIX (OAuth)

Feito isso, um projeto usando angular e a biblioteca da XDK será criado e configurado, estando pronto para desenvolvimento.