nestcraftx 0.2.5 → 0.3.0

package/utils/configs/configureDocker.js

@@ -1,120 +1,120 @@
-const fs = require("fs");
-const { logInfo } = require("../loggers/logInfo");
-const { logSuccess } = require("../loggers/logSuccess");
-const { createFile } = require("../userInput");
-
-async function configureDocker(inputs) {
-  logInfo("Generating Docker files...");
-
-  const dockerfileContent = `
-# ------------------ Stage 1: Build & Dependencies ------------------
-FROM node:20-alpine AS builder
-
-# Set working directory
-WORKDIR /app
-
-# Copy package files first to leverage Docker cache
-COPY package.json package-lock.json ./
-
-# Install dependencies (Node dependencies and global tools like Prisma if needed)
-# The 'production' flag ensures only production dependencies are installed if applicable.
-# 'npm ci' is recommended for CI/CD/Docker builds instead of 'npm install'
-RUN ${
-    inputs.packageManager === "npm"
-      ? "npm ci"
-      : `${inputs.packageManager} install --frozen-lockfile`
-  }
-
-# Copy the rest of the application source code
-COPY . .
-
-# Build the NestJS application (if TypeScript is used)
-RUN ${inputs.packageManager} run build
-
-# ------------------ Stage 2: Production Runtime ------------------
-FROM node:20-alpine AS production
-
-# Set working directory
-WORKDIR /app
-
-# Copy production node_modules from the builder stage
-COPY --from=builder /app/node_modules ./node_modules
-
-# Copy built application and start scripts (dist and package.json)
-COPY --from=builder /app/dist ./dist
-COPY --from=builder /app/package.json ./package.json
-
-# Expose the application port (usually 3000 for NestJS)
-EXPOSE 3000
-
-# Run the application using the built files (production environment)
-# Use 'start:prod' if available, otherwise fall back to 'start'
-CMD [ "${inputs.packageManager}", "run", "start:prod" ]
-`;
-  await createFile({
-    path: "Dockerfile",
-    contente: dockerfileContent.trim(),
-  });
-  const dockerComposeContent = `
-version: '3.8'
-
-services:
-  # Application Service (NestJS)
-  app:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    # Links the container to the internal network
-    networks:
-      - backend_network
-    # Maps internal port 3000 (EXPOSE in Dockerfile) to external port 3000
-    ports:
-      - "3000:3000"
-    # Mount .env file (for local dev, not recommended for prod)
-    env_file:
-      - .env
-    # Restart policy
-    restart: always
-    # Wait for the DB to be ready (requires 'wait-for-it' or similar)
-    depends_on:
-      - db
-
-  # Database Service (PostgreSQL - generic image for example)
-  db:
-    image: postgres:15-alpine
-    container_name: ${inputs.projectName}_db
-    networks:
-      - backend_network
-    environment:
-      POSTGRES_USER: ${inputs.dbConfig.POSTGRES_USER || "postgres"}
-      POSTGRES_PASSWORD: ${inputs.dbConfig.POSTGRES_PASSWORD || "secret"}
-      POSTGRES_DB: ${inputs.dbConfig.POSTGRES_DB || "mydatabase"}
-      # Optional: Set timezone
-      TZ: Europe/Paris
-    # For dev purposes: map DB port externally (optional)
-    ports:
-      - "5432:5432"
-    # Persist database data
-    volumes:
-      - postgres_data:/var/lib/postgresql/data
-    restart: always
-
-# Networks definition
-networks:
-  backend_network:
-    driver: bridge
-
-# Volumes definition
-volumes:
-  postgres_data:
-`;
-
-  await createFile({
-    path: "docker-compose.yml",
-    contente: dockerComposeContent.trim(),
-  });
-
-  logSuccess("Docker successfully configured with enhanced settings");
-}
-
-module.exports = { configureDocker };
+const fs = require("fs");
+const { logInfo } = require("../loggers/logInfo");
+const { logSuccess } = require("../loggers/logSuccess");
+const { createFile } = require("../userInput");
+
+async function configureDocker(inputs) {
+  logInfo("Generating Docker files...");
+
+  const dockerfileContent = `
+# ------------------ Stage 1: Build & Dependencies ------------------
+FROM node:20-alpine AS builder
+
+# Set working directory
+WORKDIR /app
+
+# Copy package files first to leverage Docker cache
+COPY package.json package-lock.json ./
+
+# Install dependencies (Node dependencies and global tools like Prisma if needed)
+# The 'production' flag ensures only production dependencies are installed if applicable.
+# 'npm ci' is recommended for CI/CD/Docker builds instead of 'npm install'
+RUN ${
+    inputs.packageManager === "npm"
+      ? "npm ci"
+      : `${inputs.packageManager} install --frozen-lockfile`
+  }
+
+# Copy the rest of the application source code
+COPY . .
+
+# Build the NestJS application (if TypeScript is used)
+RUN ${inputs.packageManager} run build
+
+# ------------------ Stage 2: Production Runtime ------------------
+FROM node:20-alpine AS production
+
+# Set working directory
+WORKDIR /app
+
+# Copy production node_modules from the builder stage
+COPY --from=builder /app/node_modules ./node_modules
+
+# Copy built application and start scripts (dist and package.json)
+COPY --from=builder /app/dist ./dist
+COPY --from=builder /app/package.json ./package.json
+
+# Expose the application port (usually 3000 for NestJS)
+EXPOSE 3000
+
+# Run the application using the built files (production environment)
+# Use 'start:prod' if available, otherwise fall back to 'start'
+CMD [ "${inputs.packageManager}", "run", "start:prod" ]
+`;
+  await createFile({
+    path: "Dockerfile",
+    contente: dockerfileContent.trim(),
+  });
+  const dockerComposeContent = `
+version: '3.8'
+
+services:
+  # Application Service (NestJS)
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    # Links the container to the internal network
+    networks:
+      - backend_network
+    # Maps internal port 3000 (EXPOSE in Dockerfile) to external port 3000
+    ports:
+      - "3000:3000"
+    # Mount .env file (for local dev, not recommended for prod)
+    env_file:
+      - .env
+    # Restart policy
+    restart: always
+    # Wait for the DB to be ready (requires 'wait-for-it' or similar)
+    depends_on:
+      - db
+
+  # Database Service (PostgreSQL - generic image for example)
+  db:
+    image: postgres:15-alpine
+    container_name: ${inputs.projectName}_db
+    networks:
+      - backend_network
+    environment:
+      POSTGRES_USER: ${inputs.dbConfig.POSTGRES_USER || "postgres"}
+      POSTGRES_PASSWORD: ${inputs.dbConfig.POSTGRES_PASSWORD || "secret"}
+      POSTGRES_DB: ${inputs.dbConfig.POSTGRES_DB || "mydatabase"}
+      # Optional: Set timezone
+      TZ: Europe/Paris
+    # For dev purposes: map DB port externally (optional)
+    ports:
+      - "5432:5432"
+    # Persist database data
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    restart: always
+
+# Networks definition
+networks:
+  backend_network:
+    driver: bridge
+
+# Volumes definition
+volumes:
+  postgres_data:
+`;
+
+  await createFile({
+    path: "docker-compose.yml",
+    contente: dockerComposeContent.trim(),
+  });
+
+  logSuccess("Docker successfully configured with enhanced settings");
+}
+
+module.exports = { configureDocker };

package/utils/configs/setupCleanArchitecture.js

@@ -79,7 +79,7 @@ async function setupCleanArchitecture(inputs) {
         const mongooseSchemaContent = await generateMongooseSchemaFileContent(
           entity,
           entitiesData,
-          mode
+          mode,
         );
 
         const schemaPath = `src/${entity.name}/infrastructure/persistence/mongoose`;
@@ -128,7 +128,7 @@ async function setupCleanArchitecture(inputs) {
 
       // 4. Use Cases
       const useCases = ["Create", "GetById", "GetAll", "Update", "Delete"];
-      useCases.forEach(async (useCase) => {
+      for (const useCase of useCases) {
         let content = "";
         const entityName = capitalize(entity.name);
         const entityNameLower = decapitalize(entity.name);
@@ -141,7 +141,7 @@ async function setupCleanArchitecture(inputs) {
 
 import { Inject, Logger } from '@nestjs/common';
 import { Create${entityName}Dto } from 'src/${entity.name}/application/dtos/${entity.name}.dto';
-import { I${entityName}RepositoryName, I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
+import { I${entityName}RepositoryName, type I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
 import { ${entityName}Entity } from 'src/${entity.name}/domain/entities/${entityNameLower}.entity';
 
 export class Create${entityName}UseCase {
@@ -168,7 +168,7 @@ export class Create${entityName}UseCase {
  */
 
 import { Inject, Logger, NotFoundException } from '@nestjs/common';
-import { I${entityName}RepositoryName, I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
+import { I${entityName}RepositoryName, type I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
 import { ${entityName}Entity } from 'src/${entity.name}/domain/entities/${entityNameLower}.entity';
 
 export class GetById${entityName}UseCase {
@@ -201,7 +201,7 @@ export class GetById${entityName}UseCase {
  */
 
 import { Inject, Logger } from '@nestjs/common';
-import { I${entityName}RepositoryName, I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
+import { I${entityName}RepositoryName, type I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
 import { ${entityName}Entity } from 'src/${entity.name}/domain/entities/${entityNameLower}.entity';
 
 export class GetAll${entityName}UseCase {
@@ -229,7 +229,7 @@ export class GetAll${entityName}UseCase {
 
 import { Inject, Logger, NotFoundException } from '@nestjs/common';
 import { Update${entityName}Dto } from 'src/${entity.name}/application/dtos/${entity.name}.dto';
-import { I${entityName}RepositoryName, I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
+import { I${entityName}RepositoryName, type I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
 import { ${entityName}Entity } from 'src/${entity.name}/domain/entities/${entityNameLower}.entity';
 
 export class Update${entityName}UseCase {
@@ -269,7 +269,7 @@ export class Update${entityName}UseCase {
  */
 
 import { Inject, Logger, NotFoundException } from '@nestjs/common';
-import { I${entityName}RepositoryName, I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
+import { I${entityName}RepositoryName, type I${entityName}Repository } from 'src/${entity.name}/domain/interfaces/${entity.name}.repository.interface';
 
 export class Delete${entityName}UseCase {
   private readonly logger = new Logger(Delete${entityName}UseCase.name);
@@ -302,7 +302,7 @@ export class Delete${entityName}UseCase {
           }.use-case.ts`,
           contente: content.trim(),
         });
-      });
+      }
 
       // 5. DTOs
       const DtoFileContent = await generateDto(entity, useSwagger);
@@ -419,7 +419,7 @@ export class ${entityNameCapitalized}Adapter {
       const controllerContente = await generateController(
         entity.name,
         entityPath,
-        useSwagger
+        useSwagger,
       );
       await createFile({
         path: `${entityPath}/presentation/controllers/${entityNameLower}.controller.ts`,
@@ -438,13 +438,13 @@ export class ${entityNameCapitalized}Adapter {
       } else if (dbConfig.orm === "typeorm") {
         extraImports = `import { ${entityNameCapitalized} } from 'src/entities/${entityNameCapitalized}.entity';\nimport { TypeOrmModule } from '@nestjs/typeorm';`;
         importsBlock.push(
-          `TypeOrmModule.forFeature([${entityNameCapitalized}])`
+          `TypeOrmModule.forFeature([${entityNameCapitalized}])`,
         );
       } else if (dbConfig.orm === "mongoose") {
         extraImports = `import { MongooseModule } from '@nestjs/mongoose';
 import { ${entityNameCapitalized}, ${entityNameCapitalized}Schema } from '${entityPath}/infrastructure/persistence/mongoose/${entityNameLower}.schema';`;
         importsBlock.push(
-          `MongooseModule.forFeature([{ name: ${entityNameCapitalized}.name, schema: ${entityNameCapitalized}Schema }])`
+          `MongooseModule.forFeature([{ name: ${entityNameCapitalized}.name, schema: ${entityNameCapitalized}Schema }])`,
         );
       }
 
@@ -460,7 +460,7 @@ import { ${entityNameCapitalized}, ${entityNameCapitalized}Schema } from '${enti
       // Always necessary providers
       providersBlock.push(
         `{
-        provide: 'I${entityNameCapitalized}Repository',
+        provide: I${entityNameCapitalized}RepositoryName,
         useClass: ${entityNameCapitalized}Repository,
         }`,
         `${entityNameCapitalized}Service`,
@@ -469,7 +469,7 @@ import { ${entityNameCapitalized}, ${entityNameCapitalized}Schema } from '${enti
         `GetById${entityNameCapitalized}UseCase`,
         `GetAll${entityNameCapitalized}UseCase`,
         `Delete${entityNameCapitalized}UseCase`,
-        `${entityNameCapitalized}Mapper`
+        `${entityNameCapitalized}Mapper`,
       );
 
       await createFile({
@@ -494,6 +494,8 @@ import { GetById${entityNameCapitalized}UseCase } from '${entityPath}/applicatio
 import { GetAll${entityNameCapitalized}UseCase } from '${entityPath}/application/use-cases/getAll-${entityNameLower}.use-case';
 import { Delete${entityNameCapitalized}UseCase } from '${entityPath}/application/use-cases/delete-${entityNameLower}.use-case';
 import { ${entityNameCapitalized}Mapper } from '${entityPath}/infrastructure/mappers/${entityNameLower}.mapper';
+import { I${entityNameCapitalized}RepositoryName } from './domain/interfaces/${entityNameLower}.repository.interface';
+
 
 @Module({
   imports: [
@@ -506,7 +508,7 @@ import { ${entityNameCapitalized}Mapper } from '${entityPath}/infrastructure/map
     ${providersBlock.join(",\n    ")}
   ],
   exports: [
-    ${entityNameCapitalized}Service, 'I${entityNameCapitalized}Repository'
+    ${entityNameCapitalized}Service, I${entityNameCapitalized}RepositoryName
   ]
 })
 export class ${entityNameCapitalized}Module {}
@@ -544,7 +546,7 @@ import { APP_INTERCEPTOR } from '@nestjs/core';`,
     logSuccess(`Structure generated successfully!`);
   } catch (error) {
     logError(
-      `Process encountered an error during Clean Architecture setup: ${error}`
+      `Process encountered an error during Clean Architecture setup: ${error}`,
     );
     throw error;
   }

package/utils/configs/setupLightArchitecture.js

@@ -32,7 +32,7 @@ async function setupLightArchitecture(inputs) {
 
     // Générer l'enum Role si l'entité User existe
     const hasUserEntity = entitiesData.entities.some(
-      (entity) => entity.name.toLowerCase() === "user"
+      (entity) => entity.name.toLowerCase() === "user",
     );
 
     if (hasUserEntity) {
@@ -80,7 +80,7 @@ async function setupLightArchitecture(inputs) {
         const mongooseSchemaContent = await generateMongooseSchemaFileContent(
           entity,
           entitiesData,
-          mode
+          mode,
         );
         await createFile({
           path: `${entityPath}/entities/${entityNameLower}.schema.ts`,
@@ -104,7 +104,7 @@ async function setupLightArchitecture(inputs) {
         entityNameCapitalized,
         entityNameLower,
         dbConfig.orm,
-        entity
+        entity,
       );
       await createFile({
         path: `${entityPath}/repositories/${entityNameLower}.repository.ts`,
@@ -113,7 +113,7 @@ async function setupLightArchitecture(inputs) {
 
       const serviceContent = generateLightService(
         entityNameCapitalized,
-        entityNameLower
+        entityNameLower,
       );
       await createFile({
         path: `${entityPath}/services/${entityNameLower}.service.ts`,
@@ -123,7 +123,7 @@ async function setupLightArchitecture(inputs) {
       const controllerContent = generateLightController(
         entityNameCapitalized,
         entityNameLower,
-        useSwagger
+        useSwagger,
       );
       await createFile({
         path: `${entityPath}/controllers/${entityNameLower}.controller.ts`,
@@ -135,7 +135,7 @@ async function setupLightArchitecture(inputs) {
         entityNameLower,
         entityPath,
         dbConfig.orm,
-        useAuth
+        useAuth,
       );
       await createFile({
         path: `${entityPath}/${entityNameLower}.module.ts`,
@@ -641,7 +641,7 @@ function generateLightModule(
   entityLower,
   entityPath,
   orm,
-  useAuth = false
+  useAuth = false,
 ) {
   let importsBlock = [];
   let providersBlock = [`${entityName}Service`, `${entityName}Repository`];
@@ -659,7 +659,7 @@ import { TypeOrmModule } from '@nestjs/typeorm';`;
     extraImports = `import { MongooseModule } from '@nestjs/mongoose';
 import { ${entityName}, ${entityName}Schema } from '${entityPath}/entities/${entityLower}.schema';`;
     importsBlock.push(
-      `MongooseModule.forFeature([{ name: ${entityName}.name, schema: ${entityName}Schema }])`
+      `MongooseModule.forFeature([{ name: ${entityName}.name, schema: ${entityName}Schema }])`,
     );
   }
 
@@ -692,4 +692,10 @@ function decapitalize(str) {
   return str.charAt(0).toLowerCase() + str.slice(1);
 }
 
-module.exports = { setupLightArchitecture };
+module.exports = {
+  setupLightArchitecture,
+  generateLightRepository,
+  generateLightService,
+  generateLightController,
+  generateLightModule,
+};

package/utils/file-system.js

@@ -0,0 +1,75 @@
+/**
+ * utils/file-system.js
+ *
+ * Fonctions d'accès au système de fichiers utilisées par tous les générateurs.
+ * Extraites de userInput.js pour centraliser les opérations I/O.
+ *
+ * Les fichiers qui importent depuis userInput.js continuent de fonctionner
+ * sans modification grâce aux ré-exports dans userInput.js.
+ */
+
+const fs = require("fs");
+
+/**
+ * Crée un répertoire de manière récursive s'il n'existe pas déjà.
+ * @param {string} directoryPath - Le chemin du répertoire à créer.
+ */
+async function createDirectory(directoryPath) {
+  try {
+    if (!fs.existsSync(directoryPath)) {
+      fs.mkdirSync(directoryPath, { recursive: true });
+    }
+  } catch (error) {
+    console.error(
+      `Erreur lors de la création du dossier ${directoryPath}:`,
+      error,
+    );
+  }
+}
+
+/**
+ * Crée un fichier avec le contenu fourni.
+ * Si le fichier existe déjà :
+ *   - Si `fileData.overwrite === false` : skip silencieusement
+ *   - Sinon : écrase le fichier existant
+ *
+ * @param {{ path: string, contente: string, overwrite?: boolean }} fileData
+ */
+async function createFile(fileData) {
+  try {
+    if (!fs.existsSync(fileData.path)) {
+      fs.writeFileSync(`${fileData.path}`, `${fileData.contente}`);
+    } else {
+      if (fileData.overwrite === false) {
+        console.log(`File already exists, skipping: ${fileData.path}`);
+        return;
+      }
+      console.log(`Existing file : ${fileData.path}`);
+      fs.writeFileSync(`${fileData.path}`, `${fileData.contente}`);
+    }
+  } catch (error) {
+    console.error(`Erreur creating file ${fileData.path}:`, error);
+  }
+}
+
+/**
+ * Met à jour un fichier existant en remplaçant un pattern par un remplacement.
+ * Utilise `String.prototype.replace` : supporte les chaînes et les RegExp.
+ *
+ * @param {{ path: string, pattern: string|RegExp, replacement: string }} options
+ */
+async function updateFile({ path, pattern, replacement }) {
+  try {
+    let mainTs = fs.readFileSync(path, "utf8");
+    const updatedContent = mainTs.replace(pattern, replacement);
+    fs.writeFileSync(path, updatedContent, "utf-8");
+  } catch (error) {
+    console.error(` Error updating file ${path}:`, error);
+  }
+}
+
+module.exports = {
+  createDirectory,
+  createFile,
+  updateFile,
+};

package/utils/file-utils/saveProjectConfig.js

@@ -0,0 +1,36 @@
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * Lit le package.json, fusionne les scripts et les dépendances, et réécrit le fichier.
+ *
+ * @param {object} inputs Les inputs du CLI (pour le chemin du projet et le nom)
+ *
+ */
+async function saveProjectConfig(inputs) {
+  const configDir = path.join(process.cwd(), ".nestcraftx");
+  const configFile = path.join(configDir, ".nestcraftxrc");
+
+  const configData = {
+    name: inputs.projectName,
+    mode: inputs.mode,
+    orm: inputs.dbConfig.orm,
+    database: inputs.selectedDB,
+    auth: inputs.useAuth,
+    swagger: inputs.useSwagger,
+    packageManager: inputs.packageManager,
+    docker: inputs.useDocker,
+    generatedAt: new Date().toISOString(),
+  };
+
+  try {
+    if (!fs.existsSync(configDir)) {
+      fs.mkdirSync(configDir, { recursive: true });
+    }
+    fs.writeFileSync(configFile, JSON.stringify(configData, null, 2));
+  } catch (error) {
+    logWarning("Could not save project configuration file.");
+  }
+}
+
+module.exports = { saveProjectConfig };