44 lines
2.5 KiB
Markdown
44 lines
2.5 KiB
Markdown
# code-style
|
|
|
|
`SodaLive` 저장소에서 코드 스타일, 네이밍, 레이어, 타입/계약/에러 처리 관련 세부 규칙을 정리한 문서다.
|
|
|
|
## 코드 스타일 가이드
|
|
### 1) 포맷/기본 규칙
|
|
- `.editorconfig` 기준을 준수한다.
|
|
- 인덴트: 공백 4칸, 줄바꿈: LF, 최대 라인 길이: 130.
|
|
- 파일 끝 개행 유지, trailing whitespace 제거.
|
|
- Kotlin/KTS에서 `import-ordering` ktlint 규칙은 비활성화되어 있으므로 기존 파일 정렬 스타일을 우선 따른다.
|
|
|
|
### 2) import 규칙
|
|
- 신규 코드에서는 와일드카드 import(`*`)를 기본적으로 지양한다.
|
|
- 사용하지 않는 import를 남기지 않는다.
|
|
- import alias(`as`)는 필요한 경우(이름 충돌 회피) 최소 범위로만 사용한다.
|
|
- 기존 파일에 와일드카드/alias가 있으면 대규모 정렬 리팩터링 없이 주변 스타일에 맞춘다.
|
|
|
|
### 3) 네이밍/레이어
|
|
- UI: `*Activity`, `*Fragment`, dialog/sheet suffix
|
|
- 상태/도메인: `*ViewModel` (주로 `BaseViewModel` 상속)
|
|
- 데이터 계층: `*Repository`, Retrofit `*Api`
|
|
- DTO: `data class` + `*Request`, `*Response` suffix
|
|
- 레이어 흐름: `Api` -> `Repository` -> `ViewModel` -> `Activity`/`Fragment`
|
|
- DI는 `app/src/main/java/kr/co/vividnext/sodalive/di/AppDI.kt`의 Koin 구성을 따른다.
|
|
- 기존 로직 수정이 아닌 신규 `Activity`, `Fragment`, `ViewModel` 파일 및 코드와 그에 연결된 하위 코드(예: Repository, Api, DTO, adapter/helper 등)는 `app/src/main/java/kr/co/vividnext/sodalive/v2` 경로의 `kr.co.vividnext.sodalive.v2` 패키지 하위에 작성한다.
|
|
|
|
### 4) 타입/계약/에러 처리
|
|
- nullability와 제네릭 타입을 의미가 바뀌지 않게 유지한다.
|
|
- 공개 API/스키마/리소스 계약은 요청 없이 변경하지 않는다.
|
|
- 응답 처리 시 기존 `ApiResponse<T>`와 Rx 타입(`Single`, `Flowable`)을 우선 재사용한다.
|
|
- 빈 `catch` 블록을 새로 추가하지 않는다.
|
|
- 예외를 조용히 삼키지 않고 로그/주석/대체 흐름 중 하나를 남긴다.
|
|
|
|
### 5) 테스트 관례
|
|
- 단위 테스트는 `app/src/test`에 위치하며 클래스명은 `*Test`를 사용한다.
|
|
- 기본 스택은 JUnit4 + MockK/Mockito다.
|
|
- 테스트 추가 시 단일 실행 명령 예시도 `docs/agent-guides/build-test-style.md`에 갱신한다.
|
|
|
|
### 6) 주석
|
|
- 의미 단위별로 주석을 작성한다.
|
|
- 주석은 한 문장으로 간결하게 작성한다.
|
|
- 주석은 코드의 의도와 구조를 설명한다.
|
|
- 주석은 코드 변경 시 업데이트를 잊지 않는다.
|