Merge pull request #81 from cham11ng/upgrade

Upgrade packages

Author: cham11ng

.dockerignore

@@ -5,13 +5,13 @@ root = true
 
 # Unix-style newlines with a newline ending every file
 [*]
-end_of_line = lf
 charset = utf-8
-insert_final_newline = true
-indent_style = space
+end_of_line = lf
 indent_size = 2
-
-# Matches the exact files either package.json or .travis.yml
-[{package.json,.travis.yml}]
 indent_style = space
-indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[Makefile]
+indent_size = 4
+indent_style = tab

.editorconfig

@@ -1,26 +1,27 @@
 {
   "root": true,
   "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "security",
-    "@typescript-eslint"
-  ],
+  "plugins": ["sonarjs", "simple-import-sort", "jsdoc"],
   "parserOptions": {
-    "ecmaVersion": 2018,            // Allows for the parsing of modern ECMAScript features
-    "sourceType": "module"          // Allows for the use of imports
+    "ecmaVersion": "latest",
+    "sourceType": "module"
   },
   "ignorePatterns": ["./node_modules/*"],
   "extends": [
     "eslint:recommended",
-    "plugin:security/recommended",
     "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/eslint-recommended"
+    "plugin:sonarjs/recommended",
+    "plugin:jsdoc/recommended-typescript"
   ],
   "rules": {
     "no-error-on-unmatched-pattern": "off",
-    "@typescript-eslint/no-explicit-any": "off", // TODO: Remove this.
-    "no-return-await": "off", 
-    "no-shadow": "off",
-    "@typescript-eslint/no-shadow": ["error"]
+    "@typescript-eslint/no-explicit-any": "warn",
+    "sonarjs/cognitive-complexity": "off",
+    "@typescript-eslint/no-shadow": ["error"],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "simple-import-sort/imports": "warn",
+    "jsdoc/no-types": "off",
+    "jsdoc/tag-lines": "off",
+    "jsdoc/require-returns-description": "off"
   }
 }

.eslintrc

@@ -2,15 +2,15 @@ name: Starter CI
 
 on:
   push:
-    branches: [dev, master]
+    branches: [dev, main]
   pull_request:
-    branches: [dev, master]
+    branches: [dev, main]
 
 jobs:
   build:
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [20.x]
         platform: [ubuntu-latest]
 
     runs-on: ${{ matrix.platform }}

.github/workflows/ci.yml

@@ -1,5 +1,11 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx sync-dotenv
 yarn lint-staged
+
+# check if the .env file exist
+if [ ! -f .env ]; then
+  exit 0
+fi
+
+npx sync-dotenv

.husky/pre-commit

@@ -2,7 +2,7 @@
   "semi": true,
   "trailingComma": "none",
   "singleQuote": true,
-  "printWidth": 80,
+  "printWidth": 120,
   "parser": "typescript",
   "tabWidth": 2
 }

.prettierrc

@@ -1,4 +1,4 @@
-.PHONY: help prepare-dev test lint run
+.PHONY: help clean
 .DEFAULT_GOAL := help
 
 define BROWSER_PYSCRIPT
@@ -22,7 +22,9 @@ endef
 export PRINT_HELP_PYSCRIPT
 
 clean: ## Remove log file.
-	rm -rf logs/**.log logs/**.json build
+	@rm -rf logs/*.{log,json}
+	@rm -rf build
+	@echo "Clean Successful."
 
-help:
+help: ## Help
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

Makefile

@@ -19,18 +19,19 @@ Starter for Node.js Express API in Typescript with jsonwebtoken, joi, Knex, Obje
 Clone the repository, install the dependencies.
 
 ```bash
+# Clone repository
 $ git clone [email protected]:cham11ng/typescript-api-starter.git <application-name>
 
 $ cd <application-name>
 
-$ cp .env.example .env # Update database credentials
+# Update database credentials
+$ cp .env.example .env
 
 $ yarn migrate
 ```
 
-Load fake data in database.
-
 ```bash
+# Load fake data in database.
 $ yarn load:fake <FactoryName> <Number>
 ```
 
@@ -41,9 +42,11 @@ $ yarn load:fake <FactoryName> <Number>
 Start the application.
 
 ```bash
-$ yarn build # For production
+# For production
+$ yarn build
 
-$ yarn start # For development
+# For development
+$ yarn dev
 ```
 
 <p align="center">

README.md

@@ -14,7 +14,7 @@ services:
       POSTGRES_PASSWORD: ${DB_PASSWORD:-secret}
 
   api:
-    image: "node:16-alpine"
+    image: "node:latest"
     env_file: '.env.docker'
     container_name: "starter-api"
     volumes:
@@ -24,4 +24,4 @@ services:
       - postgres
     ports:
       - "8000:8000"
-    command: sh -c "yarn && yarn start"
+    command: bash -c "yarn && yarn dev"

SECURITY.md

@@ -1,6 +1,6 @@
 {
   "name": "typescript-api-starter",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Starter for Node.js express API with Typescript",
   "main": "index.js",
   "repository": {
@@ -12,10 +12,10 @@
     "email": "[email protected]"
   },
   "engines": {
-    "node": ">= 16.5.0"
+    "node": ">= 20.9.0"
   },
   "scripts": {
-    "start": "concurrently 'npx tsc --watch' 'nodemon -q build/index.js'",
+    "dev": "concurrently 'npx tsc --watch' 'nodemon -q build/index.js'",
     "transpile": "tsc",
     "clean": "rimraf build",
     "sync-env": "sync-dotenv",
@@ -52,52 +52,56 @@
     "typescript"
   ],
   "dependencies": {
-    "bcrypt": "^5.0.1",
+    "bcrypt": "^5.1.1",
     "cors": "^2.8.5",
-    "date-fns": "^2.11.1",
-    "dotenv": "^16.0.1",
+    "date-fns": "^3.6.0",
+    "dotenv": "^16.4.5",
     "express": "4.19.2",
-    "helmet": "^5.1.0",
-    "http-status-codes": "^2.1.4",
-    "joi": "^17.6.0",
-    "jsonwebtoken": "^9.0.0",
-    "knex": "^2.4.0",
-    "morgan": "^1.10.0",
-    "nodemailer": "^6.9.9",
+    "express-rate-limiter": "^1.3.1",
+    "helmet": "^7.1.0",
+    "http-status-codes": "^2.3.0",
+    "joi": "^17.12.2",
+    "jsonwebtoken": "^9.0.2",
+    "knex": "^3.1.0",
+    "nodemailer": "^6.9.13",
     "nodemailer-markdown": "^1.0.3",
-    "objection": "^3.0.1",
-    "pg": "^8.6.0",
-    "winston": "^3.3.3",
-    "winston-daily-rotate-file": "^4.5.5"
+    "objection": "^3.1.4",
+    "pg": "^8.11.3",
+    "winston": "^3.13.0",
+    "winston-daily-rotate-file": "^5.0.0"
   },
   "devDependencies": {
-    "@faker-js/faker": "^7.3.0",
-    "@types/bcrypt": "^5.0.0",
-    "@types/cors": "^2.8.12",
-    "@types/express": "^4.17.13",
-    "@types/jest": "^28.1.3",
-    "@types/jsonwebtoken": "^8.5.4",
-    "@types/morgan": "^1.9.3",
-    "@types/node": "^18.0.0",
-    "@types/nodemailer": "^6.4.4",
-    "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.30.0",
-    "@typescript-eslint/parser": "^5.30.0",
-    "chalk": "^4.1.1",
-    "concurrently": "^7.2.2",
-    "eslint": "^8.18.0",
-    "eslint-plugin-security": "^1.4.0",
-    "husky": "^8.0.1",
-    "jest": "^28.1.2",
-    "lint-staged": "^13.0.3",
-    "nodemon": "^2.0.12",
-    "prettier": "^2.3.2",
-    "rimraf": "^3.0.2",
-    "supertest": "^6.1.4",
-    "sync-dotenv": "^2.6.2",
-    "ts-jest": "^28.0.5",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.4.0",
-    "typescript": "^4.8.4"
+    "@faker-js/faker": "^8.4.1",
+    "@types/bcrypt": "^5.0.2",
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/express-rate-limit": "^6.0.0",
+    "@types/jest": "^29.5.12",
+    "@types/jsonwebtoken": "^9.0.6",
+    "@types/node": "^20.11.30",
+    "@types/nodemailer": "^6.4.14",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^7.4.0",
+    "@typescript-eslint/parser": "^7.4.0",
+    "chalk": "^5.3.0",
+    "concurrently": "^8.2.2",
+    "eslint": "^8.57.0",
+    "eslint-plugin-jsdoc": "^48.2.2",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-security": "^2.1.1",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
+    "eslint-plugin-sonarjs": "^0.25.0",
+    "husky": "^9.0.11",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.2",
+    "nodemon": "^3.1.0",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "supertest": "^6.3.4",
+    "sync-dotenv": "^2.7.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.4.3"
   }
 }

docker-compose.yml

@@ -1,11 +1,17 @@
 import chalk from 'chalk';
 
-import * as fake from '../src/utils/fake';
 import { bindModel } from '../src/config/db';
 import factories, { FactoryType } from '../src/database/factories';
+import * as fake from '../src/utils/fake';
 
 const { info } = console;
 
+/**
+ * Print the data in JSON format.
+ *
+ * @param data - Data to print.
+ * @returns {void}
+ */
 function print<T>(data: T): void {
   const jsonData = JSON.stringify(data, null, ' ');
 

package.json

@@ -1,13 +1,13 @@
 import cors from 'cors';
-import helmet from 'helmet';
 import express from 'express';
+import helmet from 'helmet';
 
-import routes from './routes';
 import { bindModel } from './config/db';
-import logHandler from './middlewares/logHandler';
+import genericErrorHandler from './middlewares/genericErrorHandler';
 import notFoundHandler from './middlewares/notFoundHandler';
+import rateLimitMiddleware from './middlewares/rateLimitHandler';
 import transactionHandler from './middlewares/transactionHandler';
-import genericErrorHandler from './middlewares/genericErrorHandler';
+import routes from './routes';
 
 const app: express.Application = express();
 
@@ -16,7 +16,7 @@ bindModel();
 app.use(cors());
 app.use(helmet());
 app.use(transactionHandler);
-app.use(logHandler);
+app.use(rateLimitMiddleware);
 app.use(express.json({ limit: '300kb' }));
 app.use(express.urlencoded({ extended: true }));
 

scripts/fake-loader.ts

@@ -1,5 +1,5 @@
 import Knex from 'knex';
-import { Model, knexSnakeCaseMappers } from 'objection';
+import { knexSnakeCaseMappers, Model } from 'objection';
 
 import config from './config';