build: Update husky to version 9.1.4 and add prepare script for husky

Author: wajeht

.github/workflows/ci.yml

@@ -0,0 +1,161 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+env:
+  # app
+  APP_PORT: 80
+  APP_ENV: 'development'
+  APP_URL: 'localhost'
+
+  # redis
+  REDIS_HOST: 'redis'
+  REDIS_PORT: 6379
+  REDIS_PASSWORD: 'password'
+
+  # database
+  DB_PORT: 5432
+  DB_HOST: 'postgres'
+  DB_USERNAME: 'username'
+  DB_PASSWORD: 'password'
+  DB_DATABASE: 'database'
+
+  # email
+  EMAIL_HOST: 'mailhot'
+  EMAIL_PORT: 1025
+  EMAIL_ALIAS: 'mail@jaw.dev'
+  EMAIL_AUTH_EMAIL: 'name@email.com'
+  EMAIL_AUTH_PASS: 'password'
+
+  # twilio
+  TWILIO_ACCOUNT_SID: ''
+  TWILIO_AUTH_TOKEN: ''
+  TWILIO_FROM_PHONE_NUMBER: ''
+  TWILIO_PHONE_NUMBER: ''
+
+jobs:
+  test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Create .env file from .env.example
+        run: cp .env.example .env
+
+      - name: Install dependencies
+        run: npm i
+
+      - name: Test codes
+        run: npm run test:coverage
+
+  lint:
+    name: ESLint
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm i
+
+      - name: Lint codes
+        run: npm run lint
+
+  format:
+    needs: [lint, test]
+    name: Prettier format
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm i
+
+      - name: Format codes
+        run: npm run format
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: 'style: format codes'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  # deploy:
+  #   needs: [test, lint, format]
+  #   name: Deploy to Production
+  #   runs-on: ubuntu-latest
+  #   if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+  #   environment:
+  #     name: production
+  #     url: https://commit.jaw.dev/
+
+  #   steps:
+  #     - name: Check out repository
+  #       uses: actions/checkout@v3
+
+  #     - name: Set up Docker Buildx
+  #       uses: docker/setup-buildx-action@v2
+
+  #     - name: Login to Container Registry
+  #       uses: docker/login-action@v2
+  #       with:
+  #         registry: ghcr.io
+  #         username: ${{ github.repository_owner }}
+  #         password: ${{ secrets.GH_TOKEN }}
+
+  #     - name: Preset Image Name
+  #       run: echo "IMAGE_URL=$(echo ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name }}:$(echo ${{ github.sha }} | cut -c1-7) | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
+
+  #     - name: Build and push Docker Image
+  #       uses: docker/build-push-action@v4
+  #       with:
+  #         context: .
+  #         file: ./Dockerfile.prod
+  #         push: true
+  #         tags: ${{ env.IMAGE_URL }}
+
+  #     - name: Deploy Image to Server
+  #       uses: caprover/deploy-from-github@v1.1.2
+  #       with:
+  #         server: '${{ secrets.CAPROVER_SERVER }}'
+  #         app: '${{ secrets.APP_NAME }}'
+  #         token: '${{ secrets.APP_TOKEN }}'
+  #         image: ${{ env.IMAGE_URL }}

.husky/pre-push

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run format
+npm run lint
+npm run test

docs/contribution.md

@@ -0,0 +1 @@
+# 🤝 Contribution

docs/development.md

@@ -0,0 +1 @@
+# 💻 Development

package-lock.json

@@ -4,6 +4,7 @@
 	"description": "send notification to discord, email, and sms",
 	"main": "index.js",
 	"scripts": {
+		"prepare": "husky",
 		"start": "node --no-warnings ./dist/src/server.js",
 		"dev": "tsx watch --no-warnings --clear-screen=false ./src/server.ts",
 		"build": "tsc",
@@ -60,6 +61,7 @@
 		"@typescript-eslint/parser": "^7.16.1",
 		"eslint-config-prettier": "^9.1.0",
 		"eslint-plugin-prettier": "^5.2.1",
+		"husky": "^9.1.4",
 		"ioredis-mock": "^8.9.0",
 		"prettier": "^3.3.3",
 		"tsx": "^4.16.5",