Update packages, add types, remove unused packages, add new helpers, Migrate Eslint v8-->v9

Author: Vladinho10

.eslintignore

@@ -64,6 +64,8 @@ envs/.env.prod.local
 
 # intelij .idea folder
 .idea/
+# visual studio code .vscode folder
+.vscode/
 
 # mac stupid files
 .DS_Store

.eslintrc

@@ -8,6 +8,7 @@
 * [Architecture guide](#architecture-guide)
 
 ### General info
+10.02.25. Updates. Migrate to Eslint v9
 25.09.22. Updates. We create a new version of the template. It is already written in Typescript !
 12.03.21 Updates. Great news ! :fire: :heart: \
 In this template every time we manually create 7 files for one CRUD logic. Now you can create your CRUD new files at once just using `rest-resource-file-generator` npm module made by me :tophat: \
@@ -22,14 +23,14 @@ If you haven't, these are their links for installing.
 
 ### Technologies
 Program/lib | version | command for checking\
-Git | 2.39.3 | `git --version`\
-Node.js | v20.8.0 | `node -v` \
-Express | ^4.19.2 | see in app package.json\
-MongoDB | v7.0.2 | `mongosh` (on MacOS)\
-Mongoose | ^8.2.4 | see in this app package.json\
-Mocha | ^10.4.0 | see in this app package.json\
-Eslint | ^8.57.0 | see in this app package.json\
-Yarn | 1.22.19 | `yarn -v`
+Git | 2.39.5 | `git --version`\
+Node.js | v20.18.1 | `node -v` \
+Express | ^4.21.2 | see in app package.json\
+MongoDB | v7.0.2 | `mongosh`, then `db.version()` (on MacOS)\
+Mongoose | ^8.10.0 | see in this app package.json\
+Mocha | ^11.1.0 | see in this app package.json\
+Eslint | ^9.20.0 | see in this app package.json\
+Yarn | 1.22.22 | `yarn -v`
 
 ### Setup
 1. Clone this repository\

.gitignore

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

README.md

@@ -4,14 +4,24 @@ import SMTPTransport from 'nodemailer/lib/smtp-transport';
 
 const rootPath = process.cwd();
 dotEnvFlow.config({ path: `${rootPath}/envs` });
+export const port: number = +process.env.PORT;
+
+if (Number.isNaN(port)) {
+    throw new Error('The port is NaN');
+}
 
 export const db = {
     uri: process.env.MONGO_URL,
 };
-export const port: string = process.env.PORT;
+
+export const nodeEnv = process.env.NODE_ENV;
+export const isProd = nodeEnv === 'prod';
+export const isStage = nodeEnv === 'stage';
+export const isLocal = nodeEnv === 'local';
 export const jwtSecret = `${process.env.JWT_SECRET}`;
 export const files = `${rootPath}/files`;
 export const uploads = `${rootPath}/uploads`;
+
 export const mailOptions: SMTPTransport.Options = {
     host: process.env.SMTP_HOST,
     port: +process.env.SMTP_PORT,

SECURITY.md

@@ -1,4 +1,4 @@
-import * as httpStatus from 'http-status';
+import httpStatus from 'http-status';
 
 const oftenUseCodes = {
     ok: httpStatus.OK,

configs/index.ts

@@ -4,10 +4,14 @@ import { CustomResponse } from '../middlewares/respond';
 
 export class RootCtrl {
     static async getMany(req: Request, res: CustomResponse) {
-        return res.send({ message: 'get all data' });
+        res.send({ message: 'get all data' });
+
+        return;
     }
     static async post(req: Request, res: CustomResponse) {
-        return res.created({ message: 'create new data' });
+        res.created({ message: 'create new data' });
+
+        return;
     }
     static async showEjs(req: Request, res: CustomResponse) {
         globalThis.io.on('connection', socket => {
@@ -25,5 +29,7 @@ export class RootCtrl {
             origin: `${req.protocol}://${req.get('host')}`,
             name: req.query.name || 'Eva',
         });
+
+        return;
     }
 }

constants/general.ts

@@ -12,56 +12,80 @@ export class UserCtrl {
 
         const users = await UserSrv.readMany(findCriteria, options);
 
-        return res.send({
+        res.send({
             data: users,
             limit: users.length,
         });
+
+        return;
     }
     static async getOne(req: Request, res: CustomResponse) {
         const user = await UserSrv.readOne({ _id: req.params._id });
 
-        return res.send({
+        res.send({
             data: user,
         });
+
+        return;
     }
     static async post(req: Request, res: CustomResponse) {
         const { body } = req;
         const create = Array.isArray(body) ? UserSrv.createMany : UserSrv.createOne;
 
         const data = await create(body);
 
-        return res.created({
+        res.created({
             data,
         });
+
+        return;
     }
     static async putOne(req: Request, res: CustomResponse) {
         const user = await UserSrv.updateOne(req.params._id, req.body); // change data
 
-        return user
-            ? res.accepted({ data: user })
-            : res.notFound({ errors: [{ message: 'resource not found' }] });
+        if (user) {
+            res.accepted({ data: user });
+        } else {
+            res.notFound({ errors: [{ message: 'resource not found' }] });
+        }
     }
+
     static async putMany(req: Request, res: CustomResponse) {
         const isModified = await UserSrv.updateMany(req.body);
 
-        return isModified
-            ? res.accepted({ data: { message: 'updated user by id' } })
-            : res.notFound({ errors: [{ message: 'resource not found' }] });
+        if (isModified) {
+            res.accepted({ data: { message: 'updated user by id' } });
+        } else {
+            res.notFound({ errors: [{ message: 'resource not found' }] });
+        }
     }
+
     static async removeOne(req: Request, res: CustomResponse) {
-        const isDeleted  = await UserSrv.deleteOne({ _id: req.params._id });
+        const isDeleted = await UserSrv.deleteOne({ _id: req.params._id });
 
-        return isDeleted ? res.noContent() : res.notFound({ errors: [{ message: 'resource not found' }] });
+        if (isDeleted) {
+            res.noContent();
+        } else {
+            res.notFound({ errors: [{ message: 'resource not found' }] });
+        }
     }
+
     static async removeMany(req: Request, res: CustomResponse) {
         const isDeleted = await UserSrv.deleteMany(req.body.ids);
 
-        return  isDeleted ? res.noContent() : res.notFound({ errors: [{ message: 'resource not found' }] });
+        if (isDeleted) {
+            res.noContent();
+        } else {
+            res.notFound({ errors: [{ message: 'resource not found' }] });
+        }
     }
+
     static async showEjs(req: Request, res: CustomResponse) {
         res.render('users-page', {
             origin: `${req.protocol}://${req.get('host')}`,
             name: 'Users',
         });
+
+        return;
     }
 }