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 git@github.com: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"