Added JsConfig With Paths & Module-Aliases

src/app.js

@@ -4,7 +4,7 @@
  * Date : 29-Sep-2021
  * Description : Start file of a user service
  */
-
+require('module-alias/register')
 const express = require('express')
 const bodyParser = require('body-parser')
 const cors = require('cors')
@@ -19,12 +19,12 @@ if (!environmentData.success) {
 	process.exit()
 }
 
-require('./configs')
+require('@configs')
 
 const app = express()
 
 // Health check
-require('./health-checks')(app)
+require('@health-checks')(app)
 
 app.use(cors())
 

src/controllers/v1/account.js

@@ -6,11 +6,11 @@
  */
 
 // Dependencies
-const accountHelper = require('../../services/helper/account')
+const accountHelper = require('@services/helper/account')
 const csv = require('csvtojson')
-const common = require('../../constants/common')
-const apiResponses = require('../../constants/api-responses')
-const httpStatusCode = require('../../generics/http-status')
+const common = require('@constants/common')
+const apiResponses = require('@constants/api-responses')
+const httpStatusCode = require('@generics/http-status')
 
 module.exports = class Account {
 	/**

src/controllers/v1/cloud-services/file.js

@@ -5,7 +5,7 @@
  * Description : Google cloud services methods.
  */
 
-const filesHelper = require('../../../services/helper/files')
+const filesHelper = require('@services/helper/files')
 
 module.exports = class File {
 	/**

src/controllers/v1/form.js

@@ -6,7 +6,7 @@
  */
 
 // Dependencies
-const formsHelper = require('../../services/helper/form')
+const formsHelper = require('@services/helper/form')
 
 module.exports = class Form {
 	/**

src/controllers/v1/mentors.js

@@ -6,8 +6,7 @@
  */
 
 // Dependencies
-const mentorsHelper = require('../../services/helper/mentors')
-
+const mentorsHelper = require('@services/helper/mentors')
 module.exports = class Mentors {
 	/**
 	 * List of mentors

src/controllers/v1/profile.js

@@ -6,7 +6,7 @@
  */
 
 // Dependencies
-const profileHelper = require('../../services/helper/profile')
+const profileHelper = require('@services/helper/profile')
 
 module.exports = class Profile {
 	/**

src/controllers/v1/systemUsers.js

@@ -6,7 +6,7 @@
  */
 
 // Dependencies
-const systemUsersHelper = require('../../services/helper/systemUsers')
+const systemUsersHelper = require('@services/helper/systemUsers')
 
 module.exports = class SystemUsers {
 	/**

src/controllers/v1/userentity.js

@@ -6,7 +6,7 @@
  */
 
 // Dependencies
-const userEntityHelper = require('../../services/helper/userentity')
+const userEntityHelper = require('@services/helper/userentity')
 
 module.exports = class UserEntity {
 	/**

src/jsconfig.json

@@ -0,0 +1,23 @@
+{
+	"compilerOptions": {
+		"module": "commonjs",
+		"target": "es6",
+		"baseUrl": "./",
+		"moduleResolution": "node",
+		"resolveJsonModule": true,
+		"paths": {
+			"@configs*": ["./configs*"],
+			"@constants*": ["./constants*"],
+			"@controllers*": ["./controllers*"],
+			"@db*": ["./db*"],
+			"@generics*": ["./generics*"],
+			"@health-checks*": ["./health-checks*"],
+			"@middlewares*": ["./middlewares*"],
+			"@public*": ["./public*"],
+			"@routes*": ["./routes*"],
+			"@services*": ["./services*"],
+			"@validators*": ["./validators*"]
+		}
+	},
+	"exclude": ["node_modules"]
+}

src/middlewares/authenticator.js

@@ -7,10 +7,10 @@
 
 const jwt = require('jsonwebtoken')
 
-const httpStatusCode = require('../generics/http-status')
-const apiResponses = require('../constants/api-responses')
-const common = require('../constants/common')
-const UsersData = require('../db/users/queries')
+const httpStatusCode = require('@generics/http-status')
+const apiResponses = require('@constants/api-responses')
+const common = require('@constants/common')
+const UsersData = require('@db/users/queries')
 
 module.exports = async function (req, res, next) {
 	try {

src/middlewares/validator.js

@@ -8,7 +8,7 @@ const fs = require('fs')
 
 module.exports = (req, res, next) => {
 	try {
-		require(`../validators/${req.params.version}/${req.params.controller}`)[req.params.method](req)
+		require(`@validators/${req.params.version}/${req.params.controller}`)[req.params.method](req)
 	} catch (error) {}
 	next()
 }

src/package.json

@@ -32,6 +32,7 @@
 		"json2csv": "^5.0.6",
 		"jsonwebtoken": "^8.5.1",
 		"kafka-node": "^5.0.0",
+		"module-alias": "^2.2.2",
 		"moment": "^2.29.1",
 		"moment-timezone": "^0.5.34",
 		"mongodb": "^4.1.2",
@@ -61,5 +62,19 @@
 	"lint-staged": {
 		"../*": "prettier --ignore-unknown --write",
 		"*": "prettier --ignore-unknown --write"
+	},
+	"_moduleAliases": {
+		"@root": ".",
+		"@configs": "configs",
+		"@constants": "constants",
+		"@controllers": "controllers",
+		"@db": "db",
+		"@generics": "generics",
+		"@health-checks": "health-checks",
+		"@middlewares": "middlewares",
+		"@public": "public",
+		"@routes": "routes",
+		"@services": "services",
+		"@validators": "validators"
 	}
 }

src/routes/index.js

@@ -5,9 +5,9 @@
  * Description : Routes for available service
  */
 
-const validator = require('../middlewares/validator')
-const authenticator = require('../middlewares/authenticator')
-const pagination = require('../middlewares/pagination')
+const validator = require('@middlewares/validator')
+const authenticator = require('@middlewares/authenticator')
+const pagination = require('@middlewares/pagination')
 const expressValidator = require('express-validator')
 const fs = require('fs')
 
@@ -51,12 +51,12 @@ module.exports = (app) => {
 						'.js'
 				)
 				if (folderExists) {
-					controller = require(`../controllers/${req.params.version}/${req.params.controller}/${req.params.file}`)
+					controller = require(`@controllers/${req.params.version}/${req.params.controller}/${req.params.file}`)
 				} else {
-					controller = require(`../controllers/${req.params.version}/${req.params.controller}`)
+					controller = require(`@controllers/${req.params.version}/${req.params.controller}`)
 				}
 			} else {
-				controller = require(`../controllers/${req.params.version}/${req.params.controller}`)
+				controller = require(`@controllers/${req.params.version}/${req.params.controller}`)
 			}
 			controllerResponse = new controller()[req.params.method]
 				? await new controller()[req.params.method](req)

src/services/helper/account.js

@@ -10,16 +10,16 @@ const bcryptJs = require('bcryptjs')
 const jwt = require('jsonwebtoken')
 const ObjectId = require('mongoose').Types.ObjectId
 
-const utilsHelper = require('../../generics/utils')
-const httpStatusCode = require('../../generics/http-status')
-const apiResponses = require('../../constants/api-responses')
-const common = require('../../constants/common')
-const usersData = require('../../db/users/queries')
-const notificationTemplateData = require('../../db/notification-template/query')
-const kafkaCommunication = require('../../generics/kafka-communication')
-const redisCommunication = require('../../generics/redis-communication')
-const systemUserData = require('../../db/systemUsers/queries')
-const FILESTREAM = require('../../generics/file-stream')
+const utilsHelper = require('@generics/utils')
+const httpStatusCode = require('@generics/http-status')
+const apiResponses = require('@constants/api-responses')
+const common = require('@constants/common')
+const usersData = require('@db/users/queries')
+const notificationTemplateData = require('@db/notification-template/query')
+const kafkaCommunication = require('@generics/kafka-communication')
+const redisCommunication = require('@generics/redis-communication')
+const systemUserData = require('@db/systemUsers/queries')
+const FILESTREAM = require('@generics/file-stream')
 
 module.exports = class AccountHelper {
 	/**

src/services/helper/files.js

@@ -6,11 +6,11 @@
  */
 
 // Dependencies
-const cloudServices = require('../../generics/cloud-services')
-const apiResponses = require('../../constants/api-responses')
-const httpStatusCode = require('../../generics/http-status')
-const common = require('../../constants/common')
-const utils = require('../../generics/utils')
+const cloudServices = require('@generics/cloud-services')
+const apiResponses = require('@constants/api-responses')
+const httpStatusCode = require('@generics/http-status')
+const common = require('@constants/common')
+const utils = require('@generics/utils')
 
 module.exports = class FilesHelper {
 	/**

src/services/helper/form.js

@@ -6,10 +6,10 @@
  */
 
 // Dependencies
-const httpStatusCode = require('../../generics/http-status')
-const apiResponses = require('../../constants/api-responses')
-const common = require('../../constants/common')
-const formsData = require('../../db/forms/queries')
+const httpStatusCode = require('@generics/http-status')
+const apiResponses = require('@constants/api-responses')
+const common = require('@constants/common')
+const formsData = require('@db/forms/queries')
 
 module.exports = class FormsHelper {
 	/**

src/services/helper/mentors.js

@@ -6,12 +6,12 @@
  */
 
 // Dependencies
-const usersData = require('../../db/users/queries')
-const apiResponses = require('../../constants/api-responses')
-const common = require('../../constants/common')
-const httpStatusCode = require('../../generics/http-status')
-const cloudServices = require('../../generics/cloud-services')
-const utilsHelper = require('../../generics/utils')
+const usersData = require('@db/users/queries')
+const apiResponses = require('@constants/api-responses')
+const common = require('@constants/common')
+const httpStatusCode = require('@generics/http-status')
+const cloudServices = require('@generics/cloud-services')
+const utilsHelper = require('@generics/utils')
 
 module.exports = class MentorsHelper {
 	/**

src/services/helper/profile.js

@@ -8,11 +8,11 @@
 // Dependencies
 const ObjectId = require('mongoose').Types.ObjectId
 
-const utilsHelper = require('../../generics/utils')
-const httpStatusCode = require('../../generics/http-status')
-const apiResponses = require('../../constants/api-responses')
-const common = require('../../constants/common')
-const usersData = require('../../db/users/queries')
+const utilsHelper = require('@generics/utils')
+const httpStatusCode = require('@generics/http-status')
+const apiResponses = require('@constants/api-responses')
+const common = require('@constants/common')
+const usersData = require('@db/users/queries')
 
 module.exports = class ProfileHelper {
 	/**
@@ -27,12 +27,12 @@ module.exports = class ProfileHelper {
 	static async update(bodyData, _id) {
 		bodyData.updatedAt = new Date().getTime()
 		try {
-			if (bodyData.hasOwnProperty("email")) {
+			if (bodyData.hasOwnProperty('email')) {
 				return common.failureResponse({
-				message: apiResponses.EMAIL_UPDATE_FAILED,
-				statusCode: httpStatusCode.bad_request,
-				responseCode: "CLIENT_ERROR",
-				});
+					message: apiResponses.EMAIL_UPDATE_FAILED,
+					statusCode: httpStatusCode.bad_request,
+					responseCode: 'CLIENT_ERROR',
+				})
 			}
 			await usersData.updateOneUser({ _id: ObjectId(_id) }, bodyData)
 			return common.successResponse({

src/services/helper/systemUsers.js

@@ -6,11 +6,11 @@
  */
 
 // Dependencies
-const utilsHelper = require('../../generics/utils')
-const httpStatusCode = require('../../generics/http-status')
-const apiResponses = require('../../constants/api-responses')
-const common = require('../../constants/common')
-const systemUserData = require('../../db/systemUsers/queries')
+const utilsHelper = require('@generics/utils')
+const httpStatusCode = require('@generics/http-status')
+const apiResponses = require('@constants/api-responses')
+const common = require('@constants/common')
+const systemUserData = require('@db/systemUsers/queries')
 
 module.exports = class SystemUsersHelper {
 	/**

src/services/helper/userentity.js

@@ -8,11 +8,11 @@
 // Dependencies
 const ObjectId = require('mongoose').Types.ObjectId
 
-const utilsHelper = require('../../generics/utils')
-const httpStatusCode = require('../../generics/http-status')
-const apiResponses = require('../../constants/api-responses')
-const common = require('../../constants/common')
-const userEntitiesData = require('../../db/userentities/query')
+const utilsHelper = require('@generics/utils')
+const httpStatusCode = require('@generics/http-status')
+const apiResponses = require('@constants/api-responses')
+const common = require('@constants/common')
+const userEntitiesData = require('@db/userentities/query')
 
 module.exports = class UserEntityHelper {
 	/**

src/test/accountController.spec.js

@@ -1,3 +1,4 @@
+require('module-alias/register')
 const chai = require('chai')
 const sinon = require('sinon')
 const expect = chai.expect
@@ -8,8 +9,8 @@ global.db = {
 		return
 	},
 }
-const accountService = require('../services/helper/account')
-let controller = require('../controllers/v1/account')
+const accountService = require('@services/helper/account')
+let controller = require('@controllers/v1/account')
 
 let mockData = require('./mock')