Upgrade package and basic configuration

Author: cham11ng

.eslintrc

@@ -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"
   }
 }

SECURITY.md

@@ -24,4 +24,4 @@ services:
       - postgres
     ports:
       - "8000:8000"
-    command: sh -c "yarn && yarn start"
+    command: sh -c "yarn && yarn dev"

docker-compose.yml

@@ -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": {
@@ -15,7 +15,7 @@
     "node": ">= 16.5.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,54 @@
     "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",
+    "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/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"
   }
 }

package.json

@@ -1,17 +1,16 @@
 {
   "compilerOptions": {
-    "target": "es5",
-    "sourceMap": true,
-    "outDir": "./build",
-    "declaration": true,
+    "target": "ESNext",
     "module": "commonjs",
-    "importHelpers": true,
-    "removeComments": true,
-    "downlevelIteration": true,
-    "lib": ["es2015", "es2016", "es2017"],
-
+    "lib": ["ESNext"],
+    "outDir": "./build",
+    "rootDir": "./src",
     "strict": true,
-    "alwaysStrict": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "sourceMap": true,
     "noImplicitAny": true,
     "noImplicitThis": true,
     "noUnusedLocals": true,
@@ -20,18 +19,10 @@
     "noUnusedParameters": true,
     "strictFunctionTypes": true,
     "noFallthroughCasesInSwitch": true,
-
     "baseUrl": "./",
-    "esModuleInterop": true,
-    "preserveSymlinks": true,
-    "resolveJsonModule": true,
-    "moduleResolution": "node",
-    "types": ["node", "express", "jest"],
-    "allowSyntheticDefaultImports": true,
     "paths": {
       "*": ["src/types/*"]
     },
-
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true
   },