nodejs-quickstart-structure 1.3.2 → 1.3.5

package/bin/index.js

@@ -50,7 +50,7 @@ program
             await generateProject(answers);
 
             console.log(chalk.green('\n✔ Project generated successfully!'));
-            console.log(chalk.cyan(`\nNext steps:\n  cd ${answers.projectName}\n  npm install\n  docker-compose up\n-----------------------\nStart the app manually:\n  npm install\n  npm run dev`));
+            console.log(chalk.cyan(`\nNext steps:\n  cd ${answers.projectName}\n  npm install\n  docker-compose up\n-----------------------\nStart the app manually:\n  cd ${answers.projectName}\n  npm install\n  npm run dev`));
 
         } catch (error) {
             console.error(chalk.red('Error generating project:'), error);

package/lib/generator.js

@@ -126,6 +126,24 @@ export const generateProject = async (config) => {
         const kafkaSource = path.join(templatesDir, 'common', 'kafka', langExt);
         await fs.copy(kafkaSource, path.join(targetDir, 'src'));
 
+        // Render Kafka Service with dynamic logger path
+        const kafkaServiceFileName = `kafkaService.${langExt}`;
+        const kafkaServiceTemplate = path.join(targetDir, 'src', 'services', `${kafkaServiceFileName}.ejs`);
+        
+        if (await fs.pathExists(kafkaServiceTemplate)) {
+            const loggerPath = architecture === 'Clean Architecture' ? '../log/logger' : '../utils/logger';
+            // Note: For MVC, it's relative to src/services (../utils/logger). Wait, ../utils/logger means src/utils/logger.
+            // src/services/kafka.ts -> ../utils/logger -> src/utils/logger. Correct.
+            // But wait, generated code for MVC usually puts it in src/services.
+            // Let's re-verify MVC structure for logger.
+            // In MVC, logger is usually in src/utils/logger.ts?
+            // Let's check where logger is copied for MVC.
+            
+            const content = ejs.render(await fs.readFile(kafkaServiceTemplate, 'utf-8'), { loggerPath });
+            await fs.writeFile(path.join(targetDir, 'src', 'services', kafkaServiceFileName), content);
+            await fs.remove(kafkaServiceTemplate);
+        }
+
         if (architecture === 'Clean Architecture') {
             // Clean Architecture Restructuring
             await fs.ensureDir(path.join(targetDir, 'src/infrastructure/messaging'));
@@ -240,8 +258,10 @@ export const generateProject = async (config) => {
     // MVC TS
     const swaggerMvcTs = path.join(targetDir, 'src', 'config', 'swagger.ts.ejs');
     if (await fs.pathExists(swaggerMvcTs)) {
-        const content = ejs.render(await fs.readFile(swaggerMvcTs, 'utf-8'), { communication });
-        await fs.writeFile(path.join(targetDir, 'src', 'config', 'swagger.ts'), content);
+        if (communication === 'REST APIs') {
+            const content = ejs.render(await fs.readFile(swaggerMvcTs, 'utf-8'), { communication });
+            await fs.writeFile(path.join(targetDir, 'src', 'config', 'swagger.ts'), content);
+        }
         await fs.remove(swaggerMvcTs);
     }
     // Clean Architecture TS
@@ -249,8 +269,10 @@ export const generateProject = async (config) => {
     // Note: In Clean Arch, it might be in src/infrastructure/webserver or src/config depending on refactor.
     // Based on previous moves, we saw it in src/config for TS.
     if (await fs.pathExists(swaggerCleanTs)) {
-        const content = ejs.render(await fs.readFile(swaggerCleanTs, 'utf-8'), { communication });
-        await fs.writeFile(path.join(targetDir, 'src', 'config', 'swagger.ts'), content);
+        if (communication === 'REST APIs') {
+            const content = ejs.render(await fs.readFile(swaggerCleanTs, 'utf-8'), { communication });
+            await fs.writeFile(path.join(targetDir, 'src', 'config', 'swagger.ts'), content);
+        }
         await fs.remove(swaggerCleanTs);
     }
 

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "nodejs-quickstart-structure",
-  "version": "1.3.2",
-  "type": "module",
-  "description": "A CLI to scaffold Node.js microservices with MVC or Clean Architecture",
-  "main": "bin/index.js",
-  "bin": {
-    "nodejs-quickstart": "./bin/index.js"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "test:e2e": "npm run test:e2e:windows",
-    "test:e2e:windows": "node scripts/validate-windows.js",
-    "test:e2e:linux": "node scripts/validate-linux.js"
-  },
-  "keywords": [
-    "nodejs",
-    "cli",
-    "scaffold",
-    "mvc",
-    "clean-architecture"
-  ],
-  "author": "Pau Dang <phucdangb1400718@gmail.com>",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/paudang/nodejs-quickstart-structure.git"
-  },
-  "bugs": {
-    "url": "https://github.com/paudang/nodejs-quickstart-structure/issues"
-  },
-  "homepage": "https://github.com/paudang/nodejs-quickstart-structure#readme",
-  "license": "ISC",
-  "dependencies": {
-    "chalk": "^5.4.1",
-    "commander": "^13.1.0",
-    "ejs": "^3.1.10",
-    "fs-extra": "^11.3.0",
-    "inquirer": "^12.4.1"
-  }
+{
+  "name": "nodejs-quickstart-structure",
+  "version": "1.3.5",
+  "type": "module",
+  "description": "A CLI to scaffold Node.js microservices with MVC or Clean Architecture",
+  "main": "bin/index.js",
+  "bin": {
+    "nodejs-quickstart": "./bin/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "test:e2e": "npm run test:e2e:windows",
+    "test:e2e:windows": "node scripts/validate-windows.js",
+    "test:e2e:linux": "node scripts/validate-linux.js"
+  },
+  "keywords": [
+    "nodejs",
+    "cli",
+    "scaffold",
+    "mvc",
+    "clean-architecture"
+  ],
+  "author": "Pau Dang <phucdangb1400718@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/paudang/nodejs-quickstart-structure.git"
+  },
+  "bugs": {
+    "url": "https://github.com/paudang/nodejs-quickstart-structure/issues"
+  },
+  "homepage": "https://github.com/paudang/nodejs-quickstart-structure#readme",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
+    "ejs": "^3.1.10",
+    "fs-extra": "^11.3.0",
+    "inquirer": "^12.4.1"
+  }
 }

package/templates/clean-architecture/js/src/index.js.ejs

@@ -26,10 +26,10 @@ const syncDatabase = async () => {
             });
             <% } -%>
             break;
-        } catch (err) {
-            logger.error('Database sync failed:', err);
+        } catch (error) {
+            logger.error('Error syncing database:', error);
             retries -= 1;
-            logger.info(`Retries left: ${retries}. Waiting 5s...`);
+            logger.info(`Retries left: ${retries}`);
             await new Promise(res => setTimeout(res, 5000));
         }
     }

package/templates/clean-architecture/js/src/infrastructure/log/logger.js

@@ -13,10 +13,10 @@ const logger = winston.createLogger({
   ],
 });
 
-if (process.env.NODE_ENV !== 'production') {
-  logger.add(new winston.transports.Console({
-    format: winston.format.simple(),
-  }));
-}
+logger.add(new winston.transports.Console({
+  format: process.env.NODE_ENV !== 'production'
+    ? winston.format.simple()
+    : winston.format.json(),
+}));
 
 module.exports = logger;

package/templates/clean-architecture/js/src/infrastructure/webserver/server.js.ejs

@@ -1,6 +1,7 @@
 const express = require('express');
 const cors = require('cors');
 require('dotenv').config();
+const logger = require('../log/logger');
 <% if (communication === 'REST APIs') { %>const apiRoutes = require('../../interfaces/routes/api');<% } -%>
 <% if (communication === 'REST APIs') { -%>
 const swaggerUi = require('swagger-ui-express');
@@ -26,7 +27,7 @@ const startServer = (port) => {
     });
 
     app.listen(port, () => {
-        console.log(`Server running on port ${port}`);
+        logger.info(`Server running on port ${port}`);
     });
 };
 

package/templates/clean-architecture/js/src/interfaces/controllers/UserController.js

@@ -2,6 +2,7 @@ const CreateUser = require('../../usecases/CreateUser');
 const GetAllUsers = require('../../usecases/GetAllUsers');
 const UserRepository = require('../../infrastructure/repositories/UserRepository');
 const HTTP_STATUS = require('../../utils/httpCodes');
+const logger = require('../../infrastructure/log/logger');
 
 class UserController {
     constructor() {
@@ -13,7 +14,10 @@ class UserController {
     getUsers(req, res) {
         this.getAllUsersUseCase.execute()
             .then(users => res.json(users))
-            .catch(err => res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: err.message }));
+            .catch(err => {
+                logger.error('Error getting users:', err);
+                res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: err.message });
+            });
     }
 
     async createUser(req, res) {
@@ -22,6 +26,7 @@ class UserController {
             const user = await this.createUserUseCase.execute(name, email);
             res.status(HTTP_STATUS.CREATED).json(user);
         } catch (error) {
+            logger.error('Error creating user:', error);
             res.status(HTTP_STATUS.BAD_REQUEST).json({ error: error.message });
         }
     }

package/templates/clean-architecture/ts/src/index.ts.ejs

@@ -61,10 +61,10 @@ const syncDatabase = async () => {
 <%_ } -%>
             });
             break;
-        } catch (err) {
-            logger.error('Database sync failed:', err);
+        } catch (error) {
+            logger.error('Error syncing database:', error);
             retries -= 1;
-            logger.info(`Retries left: ${retries}. Waiting 5s...`);
+            logger.info(`Retries left: ${retries}`);
             await new Promise(res => setTimeout(res, 5000));
         }
     }

package/templates/clean-architecture/ts/src/infrastructure/log/logger.ts

@@ -13,10 +13,10 @@ const logger = winston.createLogger({
   ],
 });
 
-if (process.env.NODE_ENV !== 'production') {
-  logger.add(new winston.transports.Console({
-    format: winston.format.simple(),
-  }));
-}
+logger.add(new winston.transports.Console({
+  format: process.env.NODE_ENV !== 'production'
+    ? winston.format.simple()
+    : winston.format.json(),
+}));
 
 export default logger;

package/templates/clean-architecture/ts/src/interfaces/controllers/userController.ts

@@ -3,6 +3,7 @@ import { UserRepository } from '../../infrastructure/repositories/UserRepository
 import CreateUser from '../../usecases/createUser';
 import GetAllUsers from '../../usecases/getAllUsers';
 import { HTTP_STATUS } from '../../utils/httpCodes';
+import logger from '../../infrastructure/log/logger';
 
 export class UserController {
     private createUserUseCase: CreateUser;
@@ -20,7 +21,7 @@ export class UserController {
             const user = await this.createUserUseCase.execute(name, email);
             res.status(HTTP_STATUS.CREATED).json(user);
         } catch (error) {
-            console.error('UserController Error:', error);
+            logger.error('UserController Error:', error);
             if (error instanceof Error) {
                 res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: error.message });
             } else {
@@ -34,7 +35,7 @@ export class UserController {
             const users = await this.getAllUsersUseCase.execute();
             res.json(users);
         } catch (error) {
-            console.error('UserController Error:', error);
+            logger.error('UserController Error:', error);
             if (error instanceof Error) {
                 res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: error.message });
             } else {

package/templates/common/kafka/js/services/{kafkaService.js → kafkaService.js.ejs}

@@ -1,4 +1,5 @@
 const { kafka } = require('../config/kafka');
+const logger = require('<%= loggerPath %>');
 
 const producer = kafka.producer();
 const consumer = kafka.consumer({ groupId: 'test-group' });
@@ -10,7 +11,7 @@ const connectKafka = async () => {
 
     await consumer.run({
         eachMessage: async ({ topic, partition, message }) => {
-            console.log({
+            logger.info({
                 value: message.value.toString(),
             });
         },

package/templates/common/kafka/ts/services/{kafkaService.ts → kafkaService.ts.ejs}

@@ -1,5 +1,6 @@
 import { kafka } from '../config/kafka';
 import { EachMessagePayload, Producer, Consumer } from 'kafkajs';
+import logger from '<%= loggerPath %>';
 
 export class KafkaService {
     private producer: Producer;
@@ -17,7 +18,7 @@ export class KafkaService {
 
         await this.consumer.run({
             eachMessage: async ({ topic, partition, message }: EachMessagePayload) => {
-                console.log({
+                logger.info({
                     value: message.value?.toString(),
                 });
             },

package/templates/mvc/js/src/controllers/userController.js.ejs

@@ -1,12 +1,14 @@
 const User = require('../models/User');
 const HTTP_STATUS = require('../utils/httpCodes');
+const logger = require('../utils/logger');
 
 const getUsers = async (req, res) => {
   try {
     const users = await User.findAll();
     res.json(users);
   } catch (error) {
-    res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: error.message });
+    logger.error('Error fetching users:', error);
+    res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: 'Internal Server Error' });
   }
 };
 

package/templates/mvc/js/src/utils/logger.js

@@ -21,10 +21,10 @@ const logger = winston.createLogger({
 // If we're not in production then log to the `console` with the format:
 // `${info.level}: ${info.message} JSON.stringify({ ...rest }) `
 //
-if (process.env.NODE_ENV !== 'production') {
-  logger.add(new winston.transports.Console({
-    format: winston.format.simple(),
-  }));
-}
+logger.add(new winston.transports.Console({
+  format: process.env.NODE_ENV !== 'production'
+    ? winston.format.simple()
+    : winston.format.json(),
+}));
 
 module.exports = logger;

package/templates/mvc/ts/src/controllers/userController.ts.ejs

@@ -1,6 +1,7 @@
 import { Request, Response } from 'express';
 import User from '../models/User';
 import { HTTP_STATUS } from '../utils/httpCodes';
+import logger from '../utils/logger';
 
 export class UserController {
     async getUsers(req: Request, res: Response) {
@@ -8,6 +9,7 @@ export class UserController {
             const users = await User.findAll();
             res.json(users);
         } catch (error) {
+            logger.error('Error fetching users:', error);
             if (error instanceof Error) {
                 res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: error.message });
             } else {
@@ -22,6 +24,7 @@ export class UserController {
             const user = await User.create({ name, email });
             res.status(HTTP_STATUS.CREATED).json(user);
         } catch (error) {
+            logger.error('Error creating user:', error);
             if (error instanceof Error) {
                 res.status(HTTP_STATUS.INTERNAL_SERVER_ERROR).json({ error: error.message });
             } else {

package/templates/mvc/ts/src/index.ts.ejs

@@ -80,10 +80,10 @@ const syncDatabase = async () => {
 <%_ } -%>
             });
             break;
-        } catch (err) {
-            logger.error('Database sync failed:', err);
+        } catch (error) {
+            logger.error('Error syncing database:', error);
             retries -= 1;
-            logger.info(`Retries left: ${retries}. Waiting 5s...`);
+            logger.info(`Retries left: ${retries}`);
             await new Promise(res => setTimeout(res, 5000));
         }
     }

package/templates/mvc/ts/src/utils/logger.ts

@@ -13,10 +13,10 @@ const logger = winston.createLogger({
   ],
 });
 
-if (process.env.NODE_ENV !== 'production') {
-  logger.add(new winston.transports.Console({
-    format: winston.format.simple(),
-  }));
-}
+logger.add(new winston.transports.Console({
+  format: process.env.NODE_ENV !== 'production'
+    ? winston.format.simple()
+    : winston.format.json(),
+}));
 
 export default logger;

package/templates/mvc/js/src/controllers/userController.js

@@ -1,14 +0,0 @@
-exports.getUsers = (req, res) => {
-    res.json([
-        { id: 1, name: 'John Doe' },
-        { id: 2, name: 'Jane Doe' }
-    ]);
-};
-
-exports.createUser = (req, res) => {
-    const { name, email } = req.body;
-    res.status(201).json({
-        message: 'User created successfully',
-        user: { name, email }
-    });
-};