From 1d2780db0b7319c0da6ac711c401c7312f4058e5 Mon Sep 17 00:00:00 2001 From: Lucas Ruthes Date: Fri, 8 Aug 2025 00:23:35 +0000 Subject: [PATCH 1/3] feat: generate ARCHITECTURE.md documenting the project structure --- packages/cli/src/ui.ts | 24 ++++++++++++++++++ .../src/templates/node-ts/ARCHITECTURE.md | 25 +++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 packages/cli/src/ui.ts create mode 100644 packages/core/src/templates/node-ts/ARCHITECTURE.md diff --git a/packages/cli/src/ui.ts b/packages/cli/src/ui.ts new file mode 100644 index 00000000..7e817479 --- /dev/null +++ b/packages/cli/src/ui.ts @@ -0,0 +1,24 @@ +import inquirer from 'inquirer'; +import chalk from 'chalk'; + +// Prompt wrappers +export async function prompt(questions: inquirer.QuestionCollection) { + return inquirer.prompt(questions); +} + +// Logging helpers +export function logSuccess(message: string) { + console.log(chalk.green('✔ ' + message)); +} + +export function logError(message: string) { + console.error(chalk.red('✖ ' + message)); +} + +export function logInfo(message: string) { + console.log(chalk.blue('ℹ ' + message)); +} + +export function logWarning(message: string) { + console.warn(chalk.yellow('⚠ ' + message)); +} diff --git a/packages/core/src/templates/node-ts/ARCHITECTURE.md b/packages/core/src/templates/node-ts/ARCHITECTURE.md new file mode 100644 index 00000000..a152240e --- /dev/null +++ b/packages/core/src/templates/node-ts/ARCHITECTURE.md @@ -0,0 +1,25 @@ +# Arquitetura do Projeto + +Este documento descreve a arquitetura escolhida durante a configuração do projeto. + +## Estrutura de Pastas + +- `src/`: Contém o código-fonte principal da aplicação. +- `test/`: Inclui os testes automatizados. +- `docs/`: Documentação adicional do projeto. +- `config/`: Arquivos de configuração e ambientes. +- `public/`: Recursos públicos, como imagens e arquivos estáticos. + +## Finalidade de Cada Pasta + +- **src/**: Onde toda a lógica de negócio e componentes principais residem. +- **test/**: Testes unitários, de integração e end-to-end. +- **docs/**: Documentação técnica, ADRs e guias de uso. +- **config/**: Configurações de ambiente, variáveis e scripts de inicialização. +- **public/**: Arquivos acessíveis diretamente pelo servidor web. + +## Melhores Práticas e Referências + +- [12 Factor App](https://12factor.net/pt_br/) +- [Node.js Best Practices](https://github.com/goldbergyoni/nodebestpractices) +- [Clean Architecture](https://dev.to/eduardomoroni/clean-architecture-na-pratica-4e1b) \ No newline at end of file From 9a531dc4481b92847cae206d3bb57060186dd1d8 Mon Sep 17 00:00:00 2001 From: Lucas Ruthes Date: Fri, 8 Aug 2025 00:41:32 +0000 Subject: [PATCH 2/3] chore: trigger pipeline From f2d6b9644358988165d7fc15c9aa70c000e26608 Mon Sep 17 00:00:00 2001 From: Lucas Ruthes Date: Fri, 8 Aug 2025 00:46:45 +0000 Subject: [PATCH 3/3] chore: trigger pipeline