Coding Skill - 공통 원칙
이 문서는 모든 코드 작성 시 적용되는 공통 원칙을 정의한다. FE/BE 상세 규칙은 기술별 스킬에서 다룬다.
코드 예시:
references/patterns.md참조
1. 설계 원칙
SRP (Single Responsibility Principle)
- 함수는 하나의 작업만 수행한다
- "이 함수가 하는 일"을 한 문장으로 설명할 수 없으면 분리한다
결합도와 응집도
- 낮은 결합도: 인터페이스/추상화를 통해 의존. 구현 세부사항에 직접 의존 금지
- 높은 응집도: 관련 있는 로직을 같은 모듈에 모은다
Early Return (Guard Clause)
- 예외/실패 조건을 함수 상단에서 먼저 처리하고 빠져나온다
삼항 연산자
- 1단만 허용. 중첩 삼항은 금지
- 한 줄(80자) 넘기면
if/else또는 early return으로 전환 - JSX: 표시/숨김은
&&, 분기는 삼항 1단, 그 이상은 변수 추출 또는 컴포넌트 분리
DRY
- 동일한 로직이 3번 이상 반복되면 추출. 2번까지는 중복 허용 (섣부른 추상화 방지)
선언적 & 함수형 스타일
- 선언적 > 명령적 — "어떻게" 대신 "무엇"을 표현
- 순수 함수 우선 — 같은 입력이면 항상 같은 출력, 부수효과 없음
- 불변성 — 기존 데이터를 변경하지 않고 새 데이터를 생성
- 부수효과 격리 — 순수 로직과 부수효과(I/O)를 분리
상수 관리
- 매직 넘버/스트링 금지 — 의미 있는 상수명으로 추출
- 한 모듈에서만 사용 → 같은 파일 상단. 여러 모듈에서 공유 →
src/constants/ as const로 리터럴 타입을 보장
2. 네이밍 컨벤션
- 의도를 드러내는 이름 사용. 축약어 회피 (관례적 축약
id,url,api,dto는 허용) - Boolean:
is,has,can,should접두사 - 함수: 동사로 시작. 반환값이 예측 가능한 이름 (
getUserById,calculateTotal,isValid)
3. 에러 핸들링
- 시스템 경계(외부 API, 사용자 입력, 파일 I/O)에서 에러를 처리
- 내부 로직에서 불필요한 try-catch 남발 금지
- 에러를 삼키지 않는다. 원본 에러를
{ cause: e }로 보존
4. 코드 품질 체크리스트
- 함수/클래스가 SRP를 지키는가?
- 네이밍이 의도를 드러내는가?
- 시스템 경계에서 에러 핸들링이 되어 있는가?
- 불필요한 복잡도가 없는가?
-
any타입을 사용하지 않았는가? - 기존 프로젝트 패턴과 일관성이 있는가?
