@node-initializr/generator 0.1.0 → 0.1.2

package/dist/ai-config.d.ts

@@ -0,0 +1,4 @@
+import { type ProjectConfig } from '@node-initializr/shared';
+import type { GeneratedFile } from './template-engine.js';
+export declare function buildAiGuidelines(config: ProjectConfig): string;
+export declare function renderAiConfigFiles(config: ProjectConfig): GeneratedFile[];

package/dist/ai-config.js

@@ -0,0 +1,217 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAiGuidelines = buildAiGuidelines;
+exports.renderAiConfigFiles = renderAiConfigFiles;
+const shared_1 = require("@node-initializr/shared");
+function labelFor(options, value) {
+    return options.find((o) => o.value === value)?.label ?? value;
+}
+function pmRun(config, script) {
+    if (config.packageManager === 'pnpm')
+        return `pnpm run ${script}`;
+    if (config.packageManager === 'yarn')
+        return `yarn ${script}`;
+    return `npm run ${script}`;
+}
+function pmExec(config, script) {
+    if (config.packageManager === 'pnpm')
+        return `pnpm ${script}`;
+    if (config.packageManager === 'yarn')
+        return `yarn ${script}`;
+    return `npm run ${script}`;
+}
+function architectureGuidelines(config) {
+    if (config.architecture === 'clean') {
+        return `## Arquitetura — Clean Architecture
+
+- **domain/** — entidades e interfaces de repositório (sem dependências externas)
+- **application/** — casos de uso que orquestram a lógica de negócio
+- **infrastructure/** — implementações concretas (HTTP, persistência, mensageria)
+- **shared/** — erros e utilitários compartilhados
+
+Regras:
+- Domínio não importa de infrastructure nem de frameworks HTTP
+- Casos de uso dependem de interfaces do domínio, não de implementações
+- Controllers/rotas apenas adaptam HTTP → casos de uso`;
+    }
+    if (config.architecture === 'mvc') {
+        return `## Arquitetura — MVC
+
+- **controllers/** — entrada HTTP, validação de request/response
+- **services/** — regras de negócio e orquestração
+- **models/** — estruturas de dados e entidades
+
+Regras:
+- Controllers devem ser finos — delegam lógica para services
+- Services não conhecem detalhes HTTP (req/res)
+- Models representam dados, não lógica de transporte`;
+    }
+    return `## Arquitetura — Modular Monolith
+
+- **modules/** — um módulo por domínio (ex: users, health)
+- Cada módulo contém controller, service e module (NestJS) ou routes equivalentes
+- **shared/** ou **infra/** — código transversal (DB, auth, config)
+
+Regras:
+- Módulos não importam implementações internas de outros módulos diretamente
+- Comunicação entre módulos via interfaces públicas ou eventos
+- Mantenha boundaries claros para facilitar extração futura em microserviços`;
+}
+function frameworkGuidelines(config) {
+    if (config.framework === 'nestjs') {
+        return `## Framework — NestJS
+
+- Use módulos (\`@Module\`), injeção de dependência e providers
+- Controllers com decorators (\`@Controller\`, \`@Get\`, etc.)
+- Services como \`@Injectable()\`
+- Prefira DTOs com class-validator para entrada
+- Entry point: \`src/main.ts\``;
+    }
+    if (config.framework === 'express') {
+        return `## Framework — Express
+
+- Rotas organizadas em módulos/arquivos separados
+- Middleware para auth, parsing e erros
+- Services puros importados pelos controllers/rotas
+- Entry point: \`src/index.${config.language === 'typescript' ? 'ts' : 'js'}\``;
+    }
+    return `## Framework — Fastify
+
+- Use plugins e \`register()\` para modularizar
+- Schemas JSON para validação de request/response quando aplicável
+- Hooks para auth e lifecycle
+- Entry point: \`src/index.${config.language === 'typescript' ? 'ts' : 'js'}\``;
+}
+function stackSection(config) {
+    const lines = [
+        `- **Projeto:** ${config.name}`,
+        `- **Framework:** ${labelFor(shared_1.FRAMEWORK_OPTIONS, config.framework)}`,
+        `- **Linguagem:** ${labelFor(shared_1.LANGUAGE_OPTIONS, config.language)}`,
+        `- **Node.js:** ${config.nodeVersion}`,
+        `- **Package manager:** ${labelFor(shared_1.PACKAGE_MANAGER_OPTIONS, config.packageManager)}`,
+        `- **Arquitetura:** ${labelFor(shared_1.ARCHITECTURE_OPTIONS, config.architecture)}`,
+        `- **Banco:** ${labelFor(shared_1.DATABASE_OPTIONS, config.database)}`,
+        `- **ORM:** ${labelFor(shared_1.ORM_OPTIONS, config.orm)}`,
+        `- **Auth:** ${labelFor(shared_1.AUTH_OPTIONS, config.auth)}`,
+        `- **Mensageria:** ${labelFor(shared_1.MESSAGE_BROKER_OPTIONS, config.messageBroker)}`,
+        `- **Redis:** ${config.redis ? 'sim' : 'não'}`,
+        `- **Swagger:** ${config.swagger ? 'sim' : 'não'}`,
+        `- **Testes:** ${config.jest ? (config.framework === 'nestjs' ? 'Jest' : 'node:test') : 'não'}`,
+        `- **Docker:** ${config.docker ? 'sim' : 'não'}`,
+        `- **GitHub Actions:** ${config.githubActions ? 'sim' : 'não'}`,
+    ];
+    if (config.description) {
+        lines.unshift(`- **Descrição:** ${config.description}`);
+    }
+    return lines.join('\n');
+}
+function dataLayerGuidelines(config) {
+    if (config.database === 'none' || config.orm === 'none') {
+        return `## Camada de dados
+
+Este projeto não inclui banco de dados configurado. Não adicione ORM ou migrations sem alinhar com o time.`;
+    }
+    const ormNotes = {
+        prisma: '- Schema em `prisma/schema.prisma`\n- Use `PrismaClient` via service injetável\n- Migrations: `npx prisma migrate dev`',
+        typeorm: '- Entidades com decorators em `entities/`\n- DataSource configurado em `infra/typeorm/`\n- Use repositories ou EntityManager conforme o padrão do projeto',
+        drizzle: '- Schema em `infra/drizzle/schema`\n- Client tipado via Drizzle\n- Migrations com drizzle-kit',
+        sequelize: '- Models Sequelize em `infra/sequelize/models/`\n- Inicialização em `infra/sequelize/sequelize`\n- Use migrations do Sequelize para alterações de schema',
+    };
+    return `## Camada de dados
+
+- Banco: **${labelFor(shared_1.DATABASE_OPTIONS, config.database)}**
+- ORM: **${labelFor(shared_1.ORM_OPTIONS, config.orm)}**
+
+${ormNotes[config.orm] ?? ''}`;
+}
+function buildAiGuidelines(config) {
+    const testCmd = config.framework === 'nestjs'
+        ? pmRun(config, 'test')
+        : pmExec(config, 'test');
+    const devCmd = config.framework === 'nestjs'
+        ? pmRun(config, 'start:dev')
+        : pmRun(config, 'dev');
+    return `# ${config.name} — instruções para assistentes de IA
+
+Este arquivo foi gerado pelo [Node Initializr](https://github.com/pietro-sdev/node-initializr).
+Siga estas diretrizes ao implementar funcionalidades neste projeto.
+
+## Stack do projeto
+
+${stackSection(config)}
+
+${frameworkGuidelines(config)}
+
+${architectureGuidelines(config)}
+
+${dataLayerGuidelines(config)}
+
+## Convenções gerais
+
+- Linguagem: **${config.language === 'typescript' ? 'TypeScript estrito — evite `any`' : 'JavaScript (ESM)'}**
+- Nomes de arquivos: kebab-case para pastas; siga o padrão já usado no módulo
+- Novos endpoints: inclua health check compatível se alterar rotas globais
+- Erros HTTP: respostas consistentes com o padrão existente no projeto
+- Variáveis de ambiente: documente novas vars em \`.env.example\`
+- Não reestruture a arquitetura escolhida sem solicitação explícita
+
+## Comandos úteis
+
+\`\`\`bash
+${config.packageManager === 'pnpm' ? 'pnpm install' : config.packageManager === 'yarn' ? 'yarn install' : 'npm install'}
+${devCmd}
+${pmRun(config, 'build')}
+${testCmd}
+\`\`\`
+
+## Ao adicionar features
+
+1. Identifique o módulo/camada correto conforme a arquitetura **${labelFor(shared_1.ARCHITECTURE_OPTIONS, config.architecture)}**
+2. Reutilize services, repositories e clients existentes
+3. Mantenha compatibilidade com ${labelFor(shared_1.PACKAGE_MANAGER_OPTIONS, config.packageManager)} e Node ${config.nodeVersion}
+4. Adicione ou atualize testes (${config.framework === 'nestjs' ? 'Jest' : 'node:test'}) quando alterar comportamento
+${config.swagger ? '5. Documente endpoints novos no Swagger/OpenAPI' : ''}
+`;
+}
+const AI_TOOL_FILES = {
+    agents: {
+        path: 'AGENTS.md',
+        wrap: (body) => body,
+    },
+    cursor: {
+        path: '.cursor/rules/node-initializr.mdc',
+        wrap: (body) => `---\ncontext: true\npriority: high\nscope: project\n---\n\n${body}`,
+    },
+    claude: {
+        path: '.claude/CLAUDE.md',
+        wrap: (body) => body,
+    },
+    copilot: {
+        path: '.github/copilot-instructions.md',
+        wrap: (body) => body,
+    },
+    gemini: {
+        path: '.gemini/GEMINI.md',
+        wrap: (body) => body,
+    },
+    jetbrains: {
+        path: '.junie/guidelines.md',
+        wrap: (body) => body,
+    },
+    windsurf: {
+        path: '.windsurf/rules/guidelines.md',
+        wrap: (body) => body,
+    },
+};
+function renderAiConfigFiles(config) {
+    if (!config.aiTools?.length)
+        return [];
+    const body = buildAiGuidelines(config);
+    return config.aiTools.map((tool) => {
+        const target = AI_TOOL_FILES[tool];
+        return {
+            path: target.path,
+            content: target.wrap(body),
+        };
+    });
+}

package/dist/generate.js

@@ -40,6 +40,7 @@ exports.writeProject = writeProject;
 const shared_1 = require("@node-initializr/shared");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
+const ai_config_js_1 = require("./ai-config.js");
 const template_engine_js_1 = require("./template-engine.js");
 const validate_js_1 = require("./validate.js");
 const zip_js_1 = require("./zip.js");
@@ -56,7 +57,9 @@ function renderProject(config) {
     if (errors.length > 0) {
         throw new Error(errors.join('; '));
     }
-    return engine.renderProject(config);
+    const projectFiles = engine.renderProject(config);
+    const aiFiles = (0, ai_config_js_1.renderAiConfigFiles)(config);
+    return [...projectFiles, ...aiFiles];
 }
 async function generateProject(config) {
     const files = renderProject(config);

package/dist/validate.js

@@ -37,5 +37,11 @@ function validateProjectConfig(config) {
     if (config.framework === 'nestjs' && config.language === 'javascript') {
         errors.push('NestJS requer TypeScript.');
     }
+    if (config.aiTools?.length) {
+        const invalid = config.aiTools.filter((tool) => !shared_1.AI_TOOL_VALUES.includes(tool));
+        if (invalid.length > 0) {
+            errors.push(`Ferramentas de IA inválidas: ${invalid.join(', ')}`);
+        }
+    }
     return errors;
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@node-initializr/generator",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Engine de geração de projetos Node.js para o Node Initializr",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pietro-sdev/node-initializr.git",
+    "url": "git+https://github.com/pietro-sdev/node-initializr.git",
     "directory": "packages/generator"
   },
   "publishConfig": {
@@ -22,7 +22,7 @@
     "prepack": "npm run build"
   },
   "dependencies": {
-    "@node-initializr/shared": "*",
+    "@node-initializr/shared": "^0.1.2",
     "archiver": "^7.0.1",
     "handlebars": "^4.7.8"
   },