coding-standards

name	coding-standards
description	TypeScript, JavaScript, React 및 Node.js 개발을 위한 보편적인 코딩 표준, 모범 사례 및 패턴.
metadata	{"origin":"ECC"}

코딩 표준 및 모범 사례 (Coding Standards & Best Practices)

모든 프로젝트에 적용 가능한 보편적인 코딩 표준입니다.

활성화 시기

• 새 프로젝트 또는 모듈을 시작할 때
• 품질 및 유지보수성을 위해 코드를 검토할 때
• 컨벤션에 따라 기존 코드를 리팩터링할 때
• 명명 규칙, 포매팅 또는 구조적 일관성을 강제할 때
• 린팅(linting), 포매팅 또는 타입 체크 규칙을 설정할 때
• 새로운 기여자에게 코딩 컨벤션을 안내할 때

코드 품질 원칙

1. 가독성 우선 (Readability First)

• 코드는 쓰는 시간보다 읽는 시간이 더 많습니다.
• 변수와 함수 이름은 명확해야 합니다.
• 주석보다는 자기 문서화(self-documenting)되는 코드를 선호합니다.
• 일관된 포매팅을 유지합니다.

2. KISS (Keep It Simple, Stupid)

• 작동하는 가장 단순한 솔루션을 선택합니다.
• 과도한 엔지니어링(over-engineering)을 피합니다.
• 조급한 최적화(premature optimization)를 하지 않습니다.
• 영리한 코드보다 이해하기 쉬운 코드가 더 좋습니다.

3. DRY (Don't Repeat Yourself)

• 공통 로직은 함수로 추출합니다.
• 재사용 가능한 컴포넌트를 만듭니다.
• 모듈 간에 유틸리티를 공유합니다.
• 복사-붙여넣기 방식의 프로그래밍을 피합니다.

4. YAGNI (You Aren't Gonna Need It)

• 실제로 필요하기 전에는 기능을 만들지 않습니다.
• 추측에 근거한 일반화(speculative generality)를 피합니다.
• 복잡성은 꼭 필요할 때만 추가합니다.
• 단순하게 시작하고 필요할 때 리팩터링합니다.

TypeScript/JavaScript 표준

변수 명명 (Variable Naming)

// 통과: 좋음: 설명적인 이름
const marketSearchQuery = 'election'
const isUserAuthenticated = true
const totalRevenue = 1000

// 실패: 나쁨: 불분명한 이름
const q = 'election'
const flag = true
const x = 1000

함수 명명 (Function Naming)

// 통과: 좋음: 동사-명사 패턴
async function fetchMarketData(marketId: string) { }
function calculateSimilarity(a: number[], b: number[]) { }
function isValidEmail(email: string): boolean { }

// 실패: 나쁨: 불분명하거나 명사만 사용
async function market(id: string) { }
function similarity(a, b) { }
function email(e) { }

불변성 패턴 (Immutability Pattern) (중요)

// 통과: 항상 스프레드(spread) 연산자 사용
const updatedUser = {
  ...user,
  name: 'New Name'
}

const updatedArray = [...items, newItem]

// 실패: 절대로 직접 수정하지 않음
user.name = 'New Name'  // 나쁨
items.push(newItem)     // 나쁨

에러 처리 (Error Handling)

// 통과: 좋음: 포괄적인 에러 처리
async function fetchData(url: string) {
  try {
    const response = await fetch(url)

    if (!response.ok) {
      throw new Error(`HTTP ${response.status}: ${response.statusText}`)
    }

    return await response.json()
  } catch (error) {
    console.error('데이터 페칭 실패:', error)
    throw new Error('데이터를 가져오지 못했습니다.')
  }
}

// 실패: 나쁨: 에러 처리 없음
async function fetchData(url) {
  const response = await fetch(url)
  return response.json()
}

Async/Await 모범 사례

// 통과: 좋음: 가능한 경우 병렬 실행
const [users, markets, stats] = await Promise.all([
  fetchUsers(),
  fetchMarkets(),
  fetchStats()
])

// 실패: 나쁨: 불필요한 순차 실행
const users = await fetchUsers()
const markets = await fetchMarkets()
const stats = await fetchStats()

타입 안정성 (Type Safety)

// 통과: 좋음: 적절한 타입 사용
interface Market {
  id: string
  name: string
  status: 'active' | 'resolved' | 'closed'
  created_at: Date
}

function getMarket(id: string): Promise<Market> {
  // 구현 내용
}

// 실패: 나쁨: 'any' 사용
function getMarket(id: any): Promise<any> {
  // 구현 내용
}

React 모범 사례

컴포넌트 구조

// 통과: 좋음: 타입이 포함된 함수형 컴포넌트
interface ButtonProps {
  children: React.ReactNode
  onClick: () => void
  disabled?: boolean
  variant?: 'primary' | 'secondary'
}

export function Button({
  children,
  onClick,
  disabled = false,
  variant = 'primary'
}: ButtonProps) {
  return (
    <button
      onClick={onClick}
      disabled={disabled}
      className={`btn btn-${variant}`}
    >
      {children}
    </button>
  )
}

// 실패: 나쁨: 타입 없음, 불분명한 구조
export function Button(props) {
  return <button onClick={props.onClick}>{props.children}</button>
}

커스텀 훅 (Custom Hooks)

// 통과: 좋음: 재사용 가능한 커스텀 훅
export function useDebounce<T>(value: T, delay: number): T {
  const [debouncedValue, setDebouncedValue] = useState<T>(value)

  useEffect(() => {
    const handler = setTimeout(() => {
      setDebouncedValue(value)
    }, delay)

    return () => clearTimeout(handler)
  }, [value, delay])

  return debouncedValue
}

// 사용 예시
const debouncedQuery = useDebounce(searchQuery, 500)

상태 관리 (State Management)

// 통과: 좋음: 올바른 상태 업데이트
const [count, setCount] = useState(0)

// 이전 상태를 기반으로 하는 함수형 업데이트
setCount(prev => prev + 1)

// 실패: 나쁨: 직접 상태 참조
setCount(count + 1)  // 비동기 시나리오에서 예전 값을 참조할 수 있음

조건부 렌더링 (Conditional Rendering)

// 통과: 좋음: 명확한 조건부 렌더링
{isLoading && <Spinner />}
{error && <ErrorMessage error={error} />}
{data && <DataDisplay data={data} />}

// 실패: 나쁨: 삼항 연산자 중첩 (Ternary hell)
{isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}

API 설계 표준

REST API 컨벤션

GET    /api/markets              # 모든 마켓 목록 조회
GET    /api/markets/:id          # 특정 마켓 조회
POST   /api/markets              # 새 마켓 생성
PUT    /api/markets/:id          # 마켓 전체 업데이트
PATCH  /api/markets/:id          # 마켓 부분 업데이트
DELETE /api/markets/:id          # 마켓 삭제

# 필터링을 위한 쿼리 파라미터
GET /api/markets?status=active&limit=10&offset=0

응답 형식 (Response Format)

// 통과: 좋음: 일관된 응답 구조
interface ApiResponse<T> {
  success: boolean
  data?: T
  error?: string
  meta?: {
    total: number
    page: number
    limit: number
  }
}

// 성공 응답
return NextResponse.json({
  success: true,
  data: markets,
  meta: { total: 100, page: 1, limit: 10 }
})

// 에러 응답
return NextResponse.json({
  success: false,
  error: '잘못된 요청입니다.'
}, { status: 400 })

입력값 검증 (Input Validation)

import { z } from 'zod'

// 통과: 좋음: 스키마 검증
const CreateMarketSchema = z.object({
  name: z.string().min(1).max(200),
  description: z.string().min(1).max(2000),
  endDate: z.string().datetime(),
  categories: z.array(z.string()).min(1)
})

export async function POST(request: Request) {
  const body = await request.json()

  try {
    const validated = CreateMarketSchema.parse(body)
    // 검증된 데이터로 진행
  } catch (error) {
    if (error instanceof z.ZodError) {
      return NextResponse.json({
        success: false,
        error: ,
        : error.
      }, { :  })
    }
  }
}

파일 조직 (File Organization)

프로젝트 구조

src/
├── app/                    # Next.js App Router
│   ├── api/               # API 라우트
│   ├── markets/           # 마켓 페이지
│   └── (auth)/           # 인증 페이지 (경로 그룹)
├── components/            # React 컴포넌트
│   ├── ui/               # 공통 UI 컴포넌트
│   ├── forms/            # 폼 컴포넌트
│   └── layouts/          # 레이아웃 컴포넌트
├── hooks/                # 커스텀 React 훅
├── lib/                  # 유틸리티 및 설정
│   ├── api/             # API 클라이언트
│   ├── utils/           # 헬퍼 함수
│   └── constants/       # 상수
├── types/                # TypeScript 타입 정의
└── styles/              # 글로벌 스타일

파일 명명 (File Naming)

components/Button.tsx          # 컴포넌트는 PascalCase
hooks/useAuth.ts              # 훅은 'use' 접두사와 함께 camelCase
lib/formatDate.ts             # 유틸리티는 camelCase
types/market.types.ts         # 타입 정의는 .types 접미사와 함께 camelCase

주석 및 문서화

주석 작성 시점

// 통과: 좋음: '무엇'이 아니라 '왜'를 설명
// 서비스 장애 시 API 과부하를 방지하기 위해 지수 백오프(exponential backoff) 사용
const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)

// 대용량 배열의 성능을 위해 의도적으로 직접 수정(mutation) 사용
items.push(newItem)

// 실패: 나쁨: 뻔한 내용 기술
// 카운터를 1 증가시킴
count++

// 이름을 사용자의 이름으로 설정
name = user.name

공용 API를 위한 JSDoc

/**
 * 의미론적 유사성을 사용하여 마켓을 검색합니다.
 *
 * @param query - 자연어 검색 쿼리
 * @param limit - 최대 결과 수 (기본값: 10)
 * @returns 유사도 점수에 따라 정렬된 마켓 배열
 * @throws {Error} OpenAI API 호출 실패 또는 Redis 사용 불가 시
 *
 * @example
 * ```typescript
 * const results = await searchMarkets('선거', 5)
 * console.log(results[0].name) // "트럼프 vs 바이든"
 * ```
 */
export async function searchMarkets(
  query: string,
  limit: number = 10
): Promise<Market[]> {
  // 구현 내용
}

성능 모범 사례

메모이제이션 (Memoization)

import { useMemo, useCallback } from 'react'

// 통과: 좋음: 비용이 큰 계산 결과 메모이제이션
const sortedMarkets = useMemo(() => {
  return markets.sort((a, b) => b.volume - a.volume)
}, [markets])

// 통과: 좋음: 콜백 함수 메모이제이션
const handleSearch = useCallback((query: string) => {
  setSearchQuery(query)
}, [])

지연 로딩 (Lazy Loading)

import { lazy, Suspense } from 'react'

// 통과: 좋음: 무거운 컴포넌트 지연 로딩
const HeavyChart = lazy(() => import('./HeavyChart'))

export function Dashboard() {
  return (
    <Suspense fallback={<Spinner />}>
      <HeavyChart />
    </Suspense>
  )
}

데이터베이스 쿼리

// 통과: 좋음: 필요한 컬럼만 선택
const { data } = await supabase
  .from('markets')
  .select('id, name, status')
  .limit(10)

// 실패: 나쁨: 모든 컬럼 선택
const { data } = await supabase
  .from('markets')
  .select('*')

테스트 표준

테스트 구조 (AAA 패턴)

test('유사도를 올바르게 계산함', () => {
  // 준비 (Arrange)
  const vector1 = [1, 0, 0]
  const vector2 = [0, 1, 0]

  // 실행 (Act)
  const similarity = calculateCosineSimilarity(vector1, vector2)

  // 단언 (Assert)
  expect(similarity).toBe(0)
})

테스트 명명

// 통과: 좋음: 설명적인 테스트 이름
test('쿼리와 일치하는 마켓이 없을 때 빈 배열을 반환함', () => { })
test('OpenAI API 키가 누락되었을 때 에러를 발생시킴', () => { })
test('Redis를 사용할 수 없을 때 부분 문자열 검색으로 대체함', () => { })

// 실패: 나쁨: 모호한 테스트 이름
test('작동함', () => { })
test('검색 테스트', () => { })

코드 스멜(Code Smell) 감지

다음과 같은 안티 패턴을 주의하세요:

1. 긴 함수

// 실패: 나쁨: 50줄 이상의 함수
function processMarketData() {
  // 100줄의 코드
}

// 통과: 좋음: 작은 함수들로 분리
function processMarketData() {
  const validated = validateData()
  const transformed = transformData(validated)
  return saveData(transformed)
}

2. 깊은 중첩 (Deep Nesting)

// 실패: 나쁨: 5단계 이상의 중첩
if (user) {
  if (user.isAdmin) {
    if (market) {
      if (market.isActive) {
        if (hasPermission) {
          // 어떤 작업 수행
        }
      }
    }
  }
}

// 통과: 좋음: 조기 반환 (Early returns)
if (!user) return
if (!user.isAdmin) return
if (!market) return
if (!market.isActive) return
if (!hasPermission) return

// 어떤 작업 수행

3. 매직 넘버 (Magic Numbers)

// 실패: 나쁨: 설명 없는 숫자
if (retryCount > 3) { }
setTimeout(callback, 500)

// 통과: 좋음: 명명된 상수 사용
const MAX_RETRIES = 3
const DEBOUNCE_DELAY_MS = 500

if (retryCount > MAX_RETRIES) { }
setTimeout(callback, DEBOUNCE_DELAY_MS)

기억하세요: 코드 품질은 타협의 대상이 아닙니다. 명확하고 유지보수가 가능한 코드는 신속한 개발과 자신감 있는 리팩터링을 가능하게 합니다.