@koalarx/nest 4.0.2 → 4.0.5

package/cli/commands/new/index.js

@@ -26,6 +26,7 @@ import {
   resolveProjectFeatures
 } from "../../utils/install-module.js";
 import { fixLintConfig } from "./fix-lint-config.js";
+import { finalizeNewProjectSetup } from "../../utils/install-workspace-config.js";
 async function promptAuthStrategies(template) {
   const isCrud = template === Template.CRUD_SAMPLE;
   return assertNotCancel(await p.multiselect({
@@ -180,6 +181,8 @@ export async function runNew(args = []) {
     auth: authStrategies,
     features
   });
+  spinner.message("Configurando workspace (.vscode e .env)...");
+  finalizeNewProjectSetup(project.name, project.packageManager);
   spinner.stop("Projeto criado com sucesso!");
   const projectFeatures = resolveProjectFeatures(features, authStrategies);
   const extrasSummary = [
@@ -196,7 +199,8 @@ export async function runNew(args = []) {
     `${color.bold("Gerenciador:")} ${project.packageManager}`,
     `${color.bold("Autenticação:")} ${formatAuthStrategies(authStrategies)}`,
     `${color.bold("Extras:")} ${extrasSummary || color.dim("nenhum")}`,
-    `${color.dim("Depois:")} cd ${project.name} && kl-nest add <feature>`
+    `${color.dim("Depois:")} cd ${project.name} && ${project.packageManager} start`,
+    `${color.dim("Extras:")} kl-nest add <feature>`
   ].join(`
 `), "Resumo");
 }

package/cli/constants/cli-project-checklist.js

@@ -5,6 +5,13 @@ import {
   resolveNewProjectOptions
 } from "./domain.js";
 import { resolveProjectFeatures } from "../utils/install-module.js";
+export const WORKSPACE_SETUP_PATHS = [
+  ".vscode/launch.json",
+  ".vscode/settings.json",
+  ".vscode/tasks.json",
+  ".vscode/extensions.json",
+  ".env"
+];
 export const CORE_REQUIRED_PATHS = [
   "src/core/env.ts",
   "src/host/main.ts",
@@ -165,7 +172,7 @@ export function buildProjectExpectation(template, auth, features) {
   };
 }
 export function requiredPathsForExpectation(expectation) {
-  const paths = [...CORE_REQUIRED_PATHS];
+  const paths = [...CORE_REQUIRED_PATHS, ...WORKSPACE_SETUP_PATHS];
   if (expectation.template === Template.CRUD_SAMPLE) {
     paths.push(...CRUD_TEMPLATE_REQUIRED_PATHS);
   }

package/cli/utils/install-workspace-config.js

@@ -0,0 +1,79 @@
+import { cpSync, existsSync, readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import { getSourceCodePath } from "./get-source-code-path.js";
+import { resolveProjectPath } from "./resolve-project-path.js";
+const PACKAGE_MANAGER_COMMAND = {
+  bun: "bun",
+  npm: "npm",
+  pnpm: "pnpm"
+};
+export function projectNameToSnakeCase(projectName) {
+  const baseName = path.isAbsolute(projectName) ? path.basename(projectName) : projectName;
+  return baseName.replace(/([a-z0-9])([A-Z])/g, "$1_$2").replace(/[\s-]+/g, "_").replace(/__+/g, "_").toLowerCase().replace(/^_+|_+$/g, "");
+}
+function patchDatabaseUrl(content, databaseName) {
+  if (!/^DATABASE_URL=/m.test(content)) {
+    return content;
+  }
+  return content.replace(/^(DATABASE_URL=.+\/)([^/\r\n]+)(\s*)$/m, `$1${databaseName}$3`);
+}
+function patchJsonFile(filePath, patch) {
+  const content = readFileSync(filePath, "utf8");
+  const json = JSON.parse(content);
+  patch(json);
+  writeFileSync(filePath, `${JSON.stringify(json, null, 2)}
+`);
+}
+function runScriptCommand(packageManager, script) {
+  return `${PACKAGE_MANAGER_COMMAND[packageManager]} run ${script}`;
+}
+export function installWorkspaceConfig(projectName, packageManager) {
+  const projectRoot = resolveProjectPath(projectName);
+  const sourceVscode = path.join(getSourceCodePath(), ".vscode");
+  const targetVscode = path.join(projectRoot, ".vscode");
+  cpSync(sourceVscode, targetVscode, { recursive: true });
+  const pmCommand = PACKAGE_MANAGER_COMMAND[packageManager];
+  patchJsonFile(path.join(targetVscode, "launch.json"), (launch) => {
+    const config = launch.configurations[0];
+    config.runtimeExecutable = pmCommand;
+    config.runtimeArgs = ["run", "start:debug"];
+    config.cwd = "${workspaceFolder}";
+  });
+  patchJsonFile(path.join(targetVscode, "tasks.json"), (tasks) => {
+    for (const task of tasks.tasks) {
+      if (task.command.includes("start:dev")) {
+        task.command = runScriptCommand(packageManager, "start:dev");
+      } else if (task.command.includes("test")) {
+        task.command = runScriptCommand(packageManager, "test");
+      } else if (task.command.includes("migration:run")) {
+        task.command = runScriptCommand(packageManager, "migration:run");
+      }
+      task.options = { cwd: "${workspaceFolder}" };
+    }
+  });
+  patchJsonFile(path.join(targetVscode, "settings.json"), (settings) => {
+    settings["npm.packageManager"] = packageManager;
+  });
+  const gitignoreSource = path.join(getSourceCodePath(), ".gitignore");
+  if (existsSync(gitignoreSource)) {
+    cpSync(gitignoreSource, path.join(projectRoot, ".gitignore"), {
+      force: true
+    });
+  }
+}
+export function createEnvFromExample(projectName) {
+  const projectRoot = resolveProjectPath(projectName);
+  const examplePath = path.join(projectRoot, ".env.example");
+  const envPath = path.join(projectRoot, ".env");
+  if (!existsSync(examplePath)) {
+    return;
+  }
+  const databaseName = projectNameToSnakeCase(projectName);
+  const envContent = patchDatabaseUrl(readFileSync(examplePath, "utf8"), databaseName);
+  writeFileSync(examplePath, envContent);
+  writeFileSync(envPath, envContent);
+}
+export function finalizeNewProjectSetup(projectName, packageManager) {
+  installWorkspaceConfig(projectName, packageManager);
+  createEnvFromExample(projectName);
+}

package/cli/utils/patch-infra-module.js

@@ -1,61 +1,81 @@
-export function patchInfraModuleForCache(content) {
-  if (content.includes("CacheServiceProvider")) {
-    return content;
-  }
-  const withAuth = content.includes("ILoggedUserInfoService");
-  let patched = content.replace("import { ILoggingService } from '@/domain/common/ilogging.service';", `import { ICacheService } from '@/domain/common/icache.service';
-import { ILoggingService } from '@/domain/common/ilogging.service';
-import { IRedLockService } from '@/domain/common/ired-lock.service';`).replace("import { LoggingService } from '@/infra/common/logging.service';", `import { CacheServiceProvider } from '@/infra/common/cache-service.provider';
-import { LoggingService } from '@/infra/common/logging.service';
-import { RedLockService } from '@/infra/common/red-lock.service';`).replace(`  providers: [
-    { provide: ILoggingService, useClass: LoggingService },`, `  providers: [
-    CacheServiceProvider,
-    { provide: ICacheService, useExisting: CacheServiceProvider },
-    { provide: ILoggingService, useClass: LoggingService },
-    { provide: IRedLockService, useClass: RedLockService },`);
-  if (withAuth) {
-    return patched.replace("  exports: [RepositoryModule, ILoggingService, ILoggedUserInfoService],", `  exports: [
-    RepositoryModule,
-    ICacheService,
-    ILoggingService,
-    IRedLockService,
-    ILoggedUserInfoService,
-  ],`);
-  }
-  return patched.replace("  exports: [RepositoryModule, ILoggingService],", `  exports: [
-    RepositoryModule,
-    ICacheService,
-    ILoggingService,
-    IRedLockService,
-  ],`);
+function hasCacheProviders(content) {
+  return content.includes("{ provide: ICacheService, useExisting: CacheServiceProvider }");
+}
+function hasAuthProviders(content) {
+  return content.includes("{ provide: ILoggedUserInfoService, useClass: LoggedUserInfoService }");
 }
-export const SLIM_INFRA_MODULE = `import { ILoggingService } from '@/domain/common/ilogging.service';
-import { Module } from '@nestjs/common';
-import { LoggingService } from '@/infra/common/logging.service';
-import { RepositoryModule } from '@/infra/repositories/repository.module';
+export function buildInfraModule({ cache, auth }) {
+  const importLines = [
+    ...cache ? ["import { ICacheService } from '@/domain/common/icache.service';"] : [],
+    "import { ILoggingService } from '@/domain/common/ilogging.service';",
+    ...auth ? [
+      "import { ILoggedUserInfoService } from '@/domain/services/ilogged-user-info.service';"
+    ] : [],
+    ...cache ? ["import { IRedLockService } from '@/domain/common/ired-lock.service';"] : [],
+    "import { Module } from '@nestjs/common';",
+    ...cache ? [
+      "import { CacheServiceProvider } from '@/infra/common/cache-service.provider';"
+    ] : [],
+    "import { LoggingService } from '@/infra/common/logging.service';",
+    ...auth ? [
+      "import { LoggedUserInfoService } from '@/infra/services/logged-user-info.service';"
+    ] : [],
+    ...cache ? ["import { RedLockService } from '@/infra/common/red-lock.service';"] : [],
+    "import { RepositoryModule } from '@/infra/repositories/repository.module';"
+  ];
+  const providerLines = [
+    ...cache ? [
+      "    CacheServiceProvider,",
+      "    { provide: ICacheService, useExisting: CacheServiceProvider },"
+    ] : [],
+    "    { provide: ILoggingService, useClass: LoggingService },",
+    ...cache ? ["    { provide: IRedLockService, useClass: RedLockService },"] : [],
+    ...auth ? [
+      "    { provide: ILoggedUserInfoService, useClass: LoggedUserInfoService },"
+    ] : []
+  ];
+  const exportLines = [
+    "    RepositoryModule,",
+    ...cache ? ["    ICacheService,"] : [],
+    "    ILoggingService,",
+    ...cache ? ["    IRedLockService,"] : [],
+    ...auth ? ["    ILoggedUserInfoService,"] : []
+  ];
+  return `${importLines.join(`
+`)}
 
 @Module({
   imports: [RepositoryModule],
-  providers: [{ provide: ILoggingService, useClass: LoggingService }],
-  exports: [RepositoryModule, ILoggingService],
+  providers: [
+${providerLines.join(`
+`)}
+  ],
+  exports: [
+${exportLines.join(`
+`)}
+  ],
 })
 export class InfraModule {}
 `;
-export function patchInfraModuleForAuth(content) {
-  if (content.includes("ILoggedUserInfoService")) {
+}
+export function patchInfraModuleForCache(content) {
+  if (hasCacheProviders(content)) {
     return content;
   }
-  let patched = content.replace("import { ILoggingService } from '@/domain/common/ilogging.service';", `import { ILoggingService } from '@/domain/common/ilogging.service';
-import { ILoggedUserInfoService } from '@/domain/services/ilogged-user-info.service';`).replace("import { LoggingService } from '@/infra/common/logging.service';", `import { LoggingService } from '@/infra/common/logging.service';
-import { LoggedUserInfoService } from '@/infra/services/logged-user-info.service';`).replace("    { provide: ILoggingService, useClass: LoggingService },", `    { provide: ILoggingService, useClass: LoggingService },
-    { provide: ILoggedUserInfoService, useClass: LoggedUserInfoService },`);
-  if (patched.includes("IRedLockService,")) {
-    return patched.replace(`    IRedLockService,
-  ],`, `    IRedLockService,
-    ILoggedUserInfoService,
-  ],`);
+  return buildInfraModule({
+    cache: true,
+    auth: hasAuthProviders(content) || content.includes("ILoggedUserInfoService")
+  });
+}
+export const SLIM_INFRA_MODULE = buildInfraModule({ cache: false, auth: false });
+export function patchInfraModuleForAuth(content) {
+  if (hasAuthProviders(content)) {
+    return content;
   }
-  return patched.replace("  exports: [RepositoryModule, ILoggingService],", "  exports: [RepositoryModule, ILoggingService, ILoggedUserInfoService],");
+  return buildInfraModule({
+    cache: hasCacheProviders(content) || content.includes("ICacheService"),
+    auth: true
+  });
 }
 export function stripInfraModuleCache(_content) {
   return SLIM_INFRA_MODULE;

package/koala-nest/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "PKief.material-icon-theme"
+  ]
+}

package/koala-nest/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "NestJS Debug",
+      "runtimeExecutable": "bun",
+      "runtimeArgs": ["run", "start:debug"],
+      "cwd": "${workspaceFolder}",
+      "autoAttachChildProcesses": true,
+      "restart": true,
+      "console": "integratedTerminal"
+    }
+  ]
+}

package/koala-nest/.vscode/settings.json

@@ -0,0 +1,77 @@
+{
+  "material-icon-theme.activeIconPack": "nest",
+  "editor.fontFamily": "Fira Code",
+  "editor.fontSize": 15,
+  "editor.fontLigatures": true,
+  "workbench.startupEditor": "newUntitledFile",
+  "js/ts.suggest.autoImports": true,
+  "js/ts.updateImportsOnFileMove.enabled": "always",
+  "editor.rulers": [80, 120],
+  "extensions.ignoreRecommendations": true,
+  "files.associations": {
+    ".env.*": "dotenv",
+    ".prettierrc": "json"
+  },
+  "editor.parameterHints.enabled": false,
+  "editor.renderLineHighlight": "gutter",
+  "editor.lineHeight": 26,
+  "editor.suggestSelection": "first",
+  "explorer.confirmDelete": false,
+  "workbench.editor.labelFormat": "short",
+  "editor.acceptSuggestionOnCommitCharacter": false,
+  "explorer.compactFolders": false,
+  "git.enableSmartCommit": true,
+  "explorer.confirmDragAndDrop": false,
+  "terminal.integrated.fontSize": 14,
+  "breadcrumbs.enabled": true,
+  "editor.tabSize": 2,
+  "workbench.iconTheme": "material-icon-theme",
+  "material-icon-theme.languages.associations": {
+    "dotenv": "tune"
+  },
+  "material-icon-theme.files.associations": {
+    "*.e2e-spec.ts": "test-js",
+    "*.dto.ts": "diff",
+    "*.handler.ts": "esbuild",
+    "*.request.ts": "log",
+    "*.schema.ts": "scheme",
+    "*.response.ts": "conduct",
+    "*.validator.ts": "commitlint"
+  },
+  "material-icon-theme.folders.associations": {
+    "entities": "class",
+    "migrations": "tools",
+    "schemas": "class",
+    "domain": "class",
+    "infra": "app",
+    "dtos": "typescript",
+    "repositories": "mappings"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    }
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    }
+  },
+  "prettier.documentSelectors": ["**/*.ts", "**/*.tsx", "**/*.js"],
+  "npm.scriptExplorerAction": "run",
+  "npm.packageManager": "bun",
+  "editor.wordWrap": "on",
+  "editor.wrappingIndent": "indent",
+  "eslint.workingDirectories": [{ "mode": "auto" }],
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "files.eol": "\n"
+}

package/koala-nest/.vscode/tasks.json

@@ -0,0 +1,37 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "shell",
+      "command": "bun run start:dev",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "isBackground": true,
+      "problemMatcher": [],
+      "label": "Start API (dev)",
+      "detail": "nest start --watch"
+    },
+    {
+      "type": "shell",
+      "command": "bun run test",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "group": "test",
+      "label": "Run tests"
+    },
+    {
+      "type": "shell",
+      "command": "bun run migration:run",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "label": "Run migrations"
+    }
+  ]
+}

package/koala-nest/src/infra/services/database.indicator.service.ts

@@ -1,17 +1,34 @@
 import { DATA_SOURCE_PROVIDER_TOKEN } from '@/infra/database/data-source-factory';
 import { Inject, Injectable } from '@nestjs/common';
-import { TypeOrmHealthIndicator } from '@nestjs/terminus';
+import {
+  HealthIndicatorResult,
+  HealthIndicatorService,
+} from '@nestjs/terminus';
 import { DataSource } from 'typeorm';
 
 @Injectable()
 export class DatabaseIndicator {
   constructor(
-    private readonly typeOrm: TypeOrmHealthIndicator,
+    private readonly healthIndicatorService: HealthIndicatorService,
     @Inject(DATA_SOURCE_PROVIDER_TOKEN)
     private readonly dataSource: DataSource,
   ) {}
 
-  isHealthy() {
-    return this.typeOrm.pingCheck('db', { connection: this.dataSource });
+  async isHealthy(): Promise<HealthIndicatorResult> {
+    const indicator = this.healthIndicatorService.check('db');
+
+    try {
+      if (!this.dataSource.isInitialized) {
+        return indicator.down({ message: 'DataSource not initialized' });
+      }
+
+      await this.dataSource.query('SELECT 1');
+
+      return indicator.up();
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+
+      return indicator.down({ message });
+    }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koalarx/nest",
-  "version": "4.0.2",
+  "version": "4.0.5",
   "description": "CLI para criar APIs NestJS com arquitetura DDD — copia módulos prontos para o seu repositório.",
   "license": "MIT",
   "type": "module",