modify: 린팅

Author: Nuung

README.md

@@ -41,8 +41,8 @@ pnpm dev
 ```bash
 pnpm dev  # 개발 서버 실행
 pnpm test  # 테스트 실행
-pnpm lint  # 린트 검사
-pnpm lint:fix  # 린트 자동 수정
+pnpm lint  # 린트 검사 (eslint + prettier)
+pnpm lint-staged  # 린트 자동 수정
 
 pnpm build # 프로젝트 빌드
 pnpm start # 빌드된 프로젝트 시작

package.json

@@ -1,27 +1,38 @@
 {
   "name": "velog-dashboard",
   "version": "1.0.0",
-  "description": "",
+  "description": "Velog Dashboard Project, velog의 모든 게시글, 통계 데이터를 한 눈에 편하게 확인할 수 있는 대시보드입니다.",
   "main": "index.js",
   "scripts": {
     "dev": "tsx watch src/index.ts",
     "build": "tsc && tsc-alias -p tsconfig.json",
-    "lint": "eslint src/**/*.ts",
-    "lint:fix": "eslint src/ --fix",
-    "format": "prettier --write src/**/*.ts",
+    "lint": "eslint src/**/*.ts && prettier --check src/**/*.ts",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
     "start": "node dist/index.js"
   },
   "lint-staged": {
-    "*.{ts,tsx}": [
+    ".{ts,tsx}": [
       "eslint --fix",
       "prettier --write"
     ]
   },
-  "keywords": [],
-  "author": "",
+  "keywords": [
+    "velog",
+    "dashboard",
+    "analytics",
+    "blog",
+    "monitoring",
+    "typescript",
+    "express",
+    "node.js",
+    "redis",
+    "postgresql",
+    "api",
+    "swagger"
+  ],
+  "author": "Nuung",
   "license": "ISC",
   "dependencies": {
     "@sentry/node": "^9.36.0",
@@ -67,4 +78,4 @@
     "typescript-eslint": "^8.15.0",
     "typescript-transform-paths": "^3.5.3"
   }
-}
+}

src/configs/cache.config.ts

@@ -3,7 +3,6 @@ import logger from '@/configs/logger.config';
 import { ICache, CacheConfig } from '@/modules/cache/cache.type';
 import { RedisCache } from '@/modules/cache/redis.cache';
 
-
 const cacheConfig: CacheConfig = {
   host: process.env.REDIS_HOST || '152.67.198.7',
   port: parseInt(process.env.REDIS_PORT || '6379'),
@@ -60,4 +59,4 @@ export const getCacheStatus = async (): Promise<boolean> => {
     logger.warn('Cache health check failed:', error);
     return false;
   }
-};
+};

src/configs/sentry.config.ts

@@ -25,10 +25,7 @@ export const initSentry = () => {
       enabled: true,
 
       // Capture 100% of the transactions for performance monitoring
-      integrations: [
-        Sentry.httpIntegration(),
-        Sentry.expressIntegration(),
-      ],
+      integrations: [Sentry.httpIntegration(), Sentry.expressIntegration()],
     });
 
     sentryInitialized = true;
@@ -41,4 +38,4 @@ export const initSentry = () => {
 // Sentry 상태 확인 함수
 export const getSentryStatus = (): boolean => {
   return sentryInitialized;
-};
+};

src/controllers/user.controller.ts

@@ -12,7 +12,7 @@ type Token10 = string & { __lengthBrand: 10 };
 const THREE_WEEKS_IN_MS = 21 * 24 * 60 * 60 * 1000;
 
 export class UserController {
-  constructor(private userService: UserService) { }
+  constructor(private userService: UserService) {}
 
   /**
    * 환경 및 쿠키 삭제 여부에 따라 쿠키 옵션을 생성합니다.

src/controllers/webhook.controller.ts

@@ -6,18 +6,14 @@ import { BadRequestError } from '@/exception';
 
 export class WebhookController {
   private readonly STATUS_EMOJI = {
-    'unresolved': '🔴',
-    'resolved': '✅',
-    'ignored': '🔇',
+    unresolved: '🔴',
+    resolved: '✅',
+    ignored: '🔇',
   } as const;
 
-  handleSentryWebhook: RequestHandler = async (
-    req: Request,
-    res: Response,
-    next: NextFunction,
-  ): Promise<void> => {
+  handleSentryWebhook: RequestHandler = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
     try {
-      if (req.body?.action !== "created") { 
+      if (req.body?.action !== 'created') {
         const response = new BadRequestError('Sentry 웹훅 처리에 실패했습니다');
         res.status(400).json(response);
         return;
@@ -37,9 +33,12 @@ export class WebhookController {
   };
 
   private formatSentryMessage(sentryData: SentryWebhookData): string {
-    const { data: { issue } } = sentryData;
+    const {
+      data: { issue },
+    } = sentryData;
 
-    if(!issue.status || !issue.title || !issue.culprit || !issue.id) throw new BadRequestError('Sentry 웹훅 처리에 실패했습니다');
+    if (!issue.status || !issue.title || !issue.culprit || !issue.id)
+      throw new BadRequestError('Sentry 웹훅 처리에 실패했습니다');
 
     const { status, title: issueTitle, culprit, permalink, id } = issue;
     const statusEmoji = this.STATUS_EMOJI[status as keyof typeof this.STATUS_EMOJI];
@@ -54,4 +53,4 @@ export class WebhookController {
 
     return message;
   }
-} 
+}

src/middlewares/auth.middleware.ts

@@ -4,7 +4,7 @@ import logger from '@/configs/logger.config';
 import pool from '@/configs/db.config';
 import { CustomError, DBError, InvalidTokenError } from '@/exception';
 import { VelogJWTPayload, User } from '@/types';
-import crypto from "crypto";
+import crypto from 'crypto';
 
 /**
  * 요청에서 토큰을 추출하는 함수
@@ -69,36 +69,37 @@ const verifyBearerTokens = () => {
 
 /**
  * Sentry 웹훅 요청의 시그니처 헤더를 검증합니다.
- * HMAC SHA256과 Sentry의 Client Secret를 사용하여 요청 본문을 해시화하고, 
+ * HMAC SHA256과 Sentry의 Client Secret를 사용하여 요청 본문을 해시화하고,
  * Sentry에서 제공하는 시그니처 헤더와 비교하여 요청의 무결성을 확인합니다.
  */
 function verifySentrySignature() {
   return (req: Request, res: Response, next: NextFunction) => {
     try {
-      if (!process.env.SENTRY_CLIENT_SECRET) throw new Error("SENTRY_CLIENT_SECRET가 env에 없습니다");
-      
-      const hmac = crypto.createHmac("sha256", process.env.SENTRY_CLIENT_SECRET);
-      
+      if (!process.env.SENTRY_CLIENT_SECRET) throw new Error('SENTRY_CLIENT_SECRET가 env에 없습니다');
+
+      const hmac = crypto.createHmac('sha256', process.env.SENTRY_CLIENT_SECRET);
+
       // Raw body 사용 - Express에서 파싱되기 전의 원본 데이터 필요
       // req.rawBody가 없다면 fallback으로 JSON.stringify 사용 (완벽하지 않음)
       // @ts-expect-error - rawBody는 커스텀 미들웨어에서 추가되는 속성
       const bodyToVerify = req.rawBody || JSON.stringify(req.body);
-      const sentrySignature = req.headers["sentry-hook-signature"];
-      
-      if (!bodyToVerify) throw new Error("요청 본문이 없습니다.");    
-      if (!sentrySignature) throw new Error("시그니처 헤더가 없습니다.");
-  
-      hmac.update(bodyToVerify, "utf8");
-      const digest = hmac.digest("hex");
-  
-      if (digest !== sentrySignature) throw new CustomError("유효하지 않은 시그니처 헤더입니다.", "INVALID_SIGNATURE", 400);
-      
+      const sentrySignature = req.headers['sentry-hook-signature'];
+
+      if (!bodyToVerify) throw new Error('요청 본문이 없습니다.');
+      if (!sentrySignature) throw new Error('시그니처 헤더가 없습니다.');
+
+      hmac.update(bodyToVerify, 'utf8');
+      const digest = hmac.digest('hex');
+
+      if (digest !== sentrySignature)
+        throw new CustomError('유효하지 않은 시그니처 헤더입니다.', 'INVALID_SIGNATURE', 400);
+
       next();
     } catch (error) {
       logger.error('시그니처 검증 중 오류가 발생하였습니다. : ', error);
       next(error);
     }
-  }
+  };
 }
 
 /**

src/middlewares/errorHandling.middleware.ts

@@ -16,10 +16,10 @@ export const errorHandlingMiddleware: ErrorRequestHandler = (
       .json({ success: false, message: err.message, error: { code: err.code, statusCode: err.statusCode } });
     return;
   }
-  
+
   Sentry.captureException(err);
   logger.error('Internal Server Error');
-  
+
   res.status(500).json({
     success: false,
     message: '서버 내부 에러가 발생하였습니다.',

src/repositories/user.repository.ts

@@ -5,7 +5,7 @@ import { QRLoginToken } from '@/types/models/QRLoginToken.type';
 import { DBError } from '@/exception';
 
 export class UserRepository {
-  constructor(private readonly pool: Pool) { }
+  constructor(private readonly pool: Pool) {}
 
   async findByUserId(id: number): Promise<User> {
     try {
@@ -42,7 +42,14 @@ export class UserRepository {
     }
   }
 
-  async updateTokens(uuid: string, email: string | null, username: string | null, thumbnail: string | null, encryptedAccessToken: string, encryptedRefreshToken: string): Promise<User> {
+  async updateTokens(
+    uuid: string,
+    email: string | null,
+    username: string | null,
+    thumbnail: string | null,
+    encryptedAccessToken: string,
+    encryptedRefreshToken: string,
+  ): Promise<User> {
     try {
       const query = `
         UPDATE "users_user"

src/routes/webhook.router.ts

@@ -50,4 +50,4 @@ const webhookController = new WebhookController();
  */
 router.post('/webhook/sentry', authMiddleware.verifySignature, webhookController.handleSentryWebhook);
 
-export default router; 
+export default router;