CLI
Os Diagramas do Necord é uma coleção de diagramas que te ajudam a inicializar, desenvolver, e manter suas aplicações Necord. Ele incorpora padrões arquitetônicos de melhor prática para incentivar aplicativos bem estruturados.
Instalação
Para instalar os diagramas, execute o seguinte comando:
- npm
- Yarn
- pnpm
npm install -g @nestjs/cli
npm install -D @necord/schematics
yarn global add @nestjs/cli
yarn add --dev @necord/schematics
pnpm add -g @nestjs/cli
pnpm add -D @necord/schematics
Utilização
Gerando comandos
Para gerar um slash command você pode usar o esquema de comando:
nest g -c @necord/schematics command
a partir de lá, o assistente perguntará qual é o nome do comando e o tipo de comando.
As opções disponíveis para este comando são as seguintes:
Opção | Descrição |
---|---|
--name | O nome do comando. |
--path | O caminho para criar o serviço. |
--flat | Se um diretório foi criado ou não. (padrão: false) |
--sourceRoot | Diretório raiz do serviço NestJS fonte. |
--spec | Se um arquivo de spec é gerado ou não. (padrão: true) |
--strategy | O tipo de comando. (comando de texto ou slash-command) |
Gerando componentes de mensagem
Para gerar um slash command você pode usar o diagrama de componente:
nest g -c @necord/schematics component
a partir de lá, o assistente perguntará qual é o nome do comando e o tipo de comando.
As opções disponíveis para este comando são as seguintes:
Opção | Descrição |
---|---|
--name | O nome do componente. |
--path | O caminho para criar o serviço. |
--flat | Se um diretório foi criado ou não. (padrão: false) |
--sourceRoot | Diretório raiz do serviço NestJS fonte. |
--spec | Se um arquivo de spec é gerado ou não. (padrão: true) |
--strategy | O tipo de componente. (botão, seleção) |
Gerando menus de contexto
Para gerar um menu de contexto você pode usar o diagrama de menu de contexto:
nest g -c @necord/schematics context-menu
a partir de lá, o assistente perguntará qual é o nome do menu de contexto e o tipo do menu de contexto.
As opções disponíveis para este comando são as seguintes:
Opção | Descrição |
---|---|
--name | O nome do menu de contexto. |
--path | O caminho para criar o serviço. |
--flat | Se um diretório foi criado ou não. (padrão: false) |
--sourceRoot | Diretório raiz do serviço NestJS fonte. |
--spec | Se um arquivo de spec é gerado ou não. (padrão: true) |
--strategy | O tipo de menu de contexto. (usuário, mensagem) |
Gerando componentes modais
Para gerar um componente modal você pode usar o diagrama de componente modal:
nest g -c @necord/schematics modal
a partir de lá, o assistente perguntará qual é o nome do componente de modal e o tipo do componente de modal.
As opções disponíveis para este comando são as seguintes:
Opção | Descrição |
---|---|
--name | O nome do modal. |
--path | O caminho para criar o serviço. |
--flat | Se um diretório foi criado ou não. (padrão: false) |
--sourceRoot | Diretório raiz do serviço NestJS fonte. |
--strategy | Se um arquivo de spec é gerado ou não. (padrão: true) |