Nocsharp NPM | npm.io

CLI No C

Descrição

Este projeto é uma CLI (Command Line Interface) desenvolvida em TypeScript para criar e estruturar projetos C# seguindo uma arquitetura em camadas comum em aplicativos C#. A estrutura do projeto C# inclui camadas para API, Domínio e Infraestrutura, organizando claramente as responsabilidades para facilitar a manutenção e escalabilidade do código.

Dependências Principais

commander: Biblioteca para criar interfaces de linha de comando. mustache: Para carregar e interpolar os arquivos template

Pré-requisitos

Certifique-se de ter o Node.js instalado para executar a CLI.

Módulo de Instalação

Instalação Global

Para facilitar o uso do Node Command Line Generator (nc), você pode instalá-lo globalmente e configurar as variáveis de ambiente. Siga os passos abaixo:

Clone o repositório para o seu sistema: git clone https://seu-repositorio-aqui.git
Acesse o diretório do projeto: cd seu-projeto
Instale as dependências: npm install
Execute o script de instalação para configurar o comando global (nc) e adicionar ao PATH: npm run install-global

Uso

Agora, você pode usar o comando nc globalmente para gerar entidades e comandos facilmente. Aqui estão alguns exemplos:

# Criar uma entidade chamada "User" com os campos "name:string" e "age:int"
nc g e User name:string age:int"

# Criar um comando chamado "Generate" com campos opcionais e tipo de gerenciamento
nc g command Generate [fields...] --type <typeFields> --id

Alternativa Simplificada Se preferir não instalar globalmente, você pode usar o script localmente com: node dist/index.js g e User name:string age:int

Para uma configuração mais simplificada e para evitar a necessidade de especificar o caminho completo para o script, você pode adicionar o diretório ao PATH do seu sistema. Adicione a seguinte linha ao seu arquivo de configuração do perfil do sistema (como o .bashrc, .bash_profile, .zshrc, etc.): export PATH=$PATH:/caminho/para/o/diretorio/do/script

Após salvar as alterações no arquivo de configuração, recarregue o perfil do terminal ou reinicie o terminal para que as alterações entrem em vigor.

Agora, você pode usar o comando nc de qualquer diretório no terminal. Lembre-se de ajustar "/caminho/para/o/diretorio/do/Bin" para o caminho real do diretório contendo o bat na pasta Bin

Estrutura do Projeto C

O projeto gerado segue a seguinte estrutura:

API:

Configurations: Classes de configuração relacionadas à API.
Controllers: Controladores responsáveis por receber solicitações HTTP.
Properties: Arquivos relacionados às propriedades do projeto.

Application:

DTOs: Objetos de Transferência de Dados que representam as estruturas de dados utilizadas nas interações entre a camada de aplicação e a API.
Interfaces: Definições de interfaces para serviços que serão implementados na camada de serviços.
Services: Implementações de serviços que realizam as operações de negócios e interagem com a camada de domínio.

Domain:

Commands: Definição de comandos que representam ações na aplicação.
Entities: Modelos de dados (entidades) representando objetos de domínio.
Handlers: Classes de manipulação que processam comandos ou eventos.
Repositories: Interfaces e implementações de repositórios para interação com o armazenamento de dados.
Validation: Classes de validação que garantem integridade dos dados e aplicam regras de negócios.

Infraestrutura:

Configuration: Classes de configuração relacionadas a serviços de infraestrutura.
Data: Implementação do acesso ao banco de dados, mapeamento de entidades e operações de persistência.

Ioc:

Program.cs: Ponto de entrada da aplicação.
appSettings.cs: Classes representando configurações da aplicação em formato de código.
appSettings.Development.json: Configurações específicas do ambiente de desenvolvimento.

Uso

A CLI oferece os seguintes comandos:

nc help:

Exibe informações de ajuda sobre o uso da CLI.

nc g ou nc g help:

Exibe informações de ajuda sobre os comandos de geração.

nc new <nome do projeto>

Cria um novo projeto C# estruturado seguindo a arquitetura em camadas.

nc g entity ou nc g e:

nc g entity <nameEntity> [fields...]

Este comando gera uma entidade com o nome especificado e os campos fornecidos. Os campos devem ser fornecidos no formato name:type.

Opções

--postgres : Especifica campos adicionais para serem usados em bases de dados PostgreSQL. Os campos devem ser fornecidos no formato table:schema.

Exemplos de Uso

# Criar uma entidade chamada "User" com os campos "name:string" e "age:int"
nc g e User name:string age:int

# Criar uma entidade chamada "Product" com os campos "name:string" e "price:decimal" e campos PostgreSQL adicionais
nc g e Product name:string price:decimal --postgres products:public

nc g command ou nc g f:

nc g command <nameCommand> [fields...] --type <typeFields> --id

Este comando tem o objetivo de gerar um comando com o nome especificado e campos opcionais. Os campos devem ser fornecidos no formato name:type. O comando também suporta opções adicionais:

Opções --type : Especifica o tipo de gerenciamento que o comando terá.

--id: Indica se o comando terá um identificador.

Exemplos de Uso

# Criar um comando chamado "Generate" com campos opcionais e tipo de gerenciamento
nc g command Generate [fields...] --type <typeFields> --id

# Atalho para criar um comando usando a opção "f"
nc g f Generate [fields...] --type <typeFields> --id

nc g repository ou nc g r

nc g repository <nameRepository> [fields...]

Este comando tem o objetivo de gerar um repositório com o nome especificado e campos opcionais. Os campos devem ser fornecidos no formato name:type. O comando também suporta opções adicionais:

Exemplos de Uso

# Criar um repositório chamado "ProductRepository" com campos opcionais
nc g repository ProductRepository [fields...]

# Atalho para criar um repositório usando a opção "f"
nc g r ProductRepository [fields...]

nc g handler ou nc g h

nc g handler <nameHandler> [fields...] --repository

Este comando tem o objetivo de gerar um manipulador com o nome especificado e campos opcionais. Os campos devem ser fornecidos no formato name:type. O comando também suporta opções adicionais:

Opções --repository: Este comando cria um manipulador no repositório de destino.

Exemplos de Uso

# Criar um manipulador chamado "ProductHandler" com campos opcionais no repositório
nc g handler ProductHandler [fields...] --repository

# Atalho para criar um manipulador usando a opção "f"
nc g h ProductHandler [fields...] --repository

nc g controler ou nc g c:

nc g controller <nameController> [fields...]

Este comando tem o objetivo de gerar um controlador com o nome especificado e campos opcionais. Os campos devem ser fornecidos no formato name:type.

Exemplos de Uso

# Criar um controlador chamado "ProductController" com campos opcionais
nc g controller ProductController [fields...]

# Atalho para criar um controlador usando a opção "f"
nc g c ProductController [fields...]

nc s ou nc scaffold

nc s <nameScaffold> [fields...] --postgres <postgreSQLFields> --baseSkip --id

Este comando cria automaticamente uma entidade, comandos, manipuladores, repositórios e controladores em um projeto. Ele suporta opções para especificar campos adicionais para bases de dados PostgreSQL, ignorar a entidade base, e incluir um identificador.

Opções --postgres : Especifica campos adicionais para serem usados em bases de dados PostgreSQL. Os campos devem ser fornecidos no formato table:schema.

--baseSkip: Este comando ignora a entidade base.

--id: Gera o arquivo com a opção de identificador.

Exemplo de Uso

# Criar automaticamente uma estrutura completa para um recurso chamado "Product"
nc s Product name:string price:decimal --postgres products:public --id

Notas

Este comando está atualmente em manutenção, e novos recursos e opções serão adicionados em versões futuras. Fique atento para atualizações.

Estrutura do Projeto C

O projeto gerado seguirá a seguinte estrutura:

API:
Configurations: Classes de configuração relacionadas à API. Controllers: Controladores responsáveis por receber solicitações HTTP. Properties: Arquivos relacionados às propriedades do projeto.
Domain:
Commands: Definição de comandos que representam ações na aplicação. Entities: Modelos de dados (entidades) representando objetos de domínio. Handlers: Classes de manipulação que processam comandos ou eventos. Repositories: Interfaces e implementações de repositórios para interação com o armazenamento de dados. Validation: Classes de validação que garantem integridade dos dados e aplicam regras de negócios.
Infraestrutura:
Configuration: Classes de configuração relacionadas a serviços de infraestrutura. Data: Implementação do acesso ao banco de dados, mapeamento de entidades e operações de persistência.
Ioc:
Program.cs: Ponto de entrada da aplicação. appSettings.cs: Classes representando configurações da aplicação em formato de código. appSettings.Development.json: Configurações específicas do ambiente de desenvolvimento.