chore: Java Gradle 프로젝트 템플릿 초기 구성
- CLAUDE.md: Java/Spring Boot/Gradle 프로젝트 가이드 - .claude/settings.json: Gradle 빌드 도구 권한 설정 - .claude/rules/: Java 코드 스타일, 네이밍, 테스트 규칙 - .githooks/pre-commit: Gradle 컴파일 검증 - gradle.properties.example: Nexus 레포지토리 설정 예시 - .sdkmanrc: JDK 17 버전 고정
This commit is contained in:
부모
44b2a23276
커밋
3c99ffb83a
59
.claude/rules/code-style.md
Normal file
59
.claude/rules/code-style.md
Normal file
@ -0,0 +1,59 @@
|
||||
# Java 코드 스타일 규칙
|
||||
|
||||
## 일반
|
||||
- Java 17+ 문법 사용 (record, sealed class, pattern matching, text block 활용)
|
||||
- 들여쓰기: 4 spaces (탭 사용 금지)
|
||||
- 줄 길이: 120자 이하
|
||||
- 파일 끝에 빈 줄 추가
|
||||
|
||||
## 클래스 구조
|
||||
클래스 내 멤버 순서:
|
||||
1. static 상수 (public → private)
|
||||
2. 인스턴스 필드 (public → private)
|
||||
3. 생성자
|
||||
4. public 메서드
|
||||
5. protected/package-private 메서드
|
||||
6. private 메서드
|
||||
7. inner class/enum
|
||||
|
||||
## Spring Boot 규칙
|
||||
|
||||
### 계층 구조
|
||||
- Controller → Service → Repository 단방향 의존
|
||||
- Controller에 비즈니스 로직 금지 (요청/응답 변환만)
|
||||
- Service 계층 간 순환 참조 금지
|
||||
- Repository에 비즈니스 로직 금지
|
||||
|
||||
### DTO와 Entity 분리
|
||||
- API 요청/응답에 Entity 직접 사용 금지
|
||||
- DTO는 record 또는 불변 클래스로 작성
|
||||
- DTO ↔ Entity 변환은 매퍼 클래스 또는 팩토리 메서드 사용
|
||||
|
||||
### 의존성 주입
|
||||
- 생성자 주입 사용 (필드 주입 `@Autowired` 사용 금지)
|
||||
- 단일 생성자는 `@Autowired` 어노테이션 생략
|
||||
- Lombok `@RequiredArgsConstructor` 사용 가능
|
||||
|
||||
### 트랜잭션
|
||||
- `@Transactional` 범위 최소화
|
||||
- 읽기 전용: `@Transactional(readOnly = true)`
|
||||
- Service 메서드 레벨에 적용 (클래스 레벨 지양)
|
||||
|
||||
## Lombok 규칙
|
||||
- `@Getter`, `@Setter` 허용 (Entity에서 Setter는 지양)
|
||||
- `@Builder` 허용
|
||||
- `@Data` 사용 금지 (명시적으로 필요한 어노테이션만)
|
||||
- `@AllArgsConstructor` 단독 사용 금지 (`@Builder`와 함께 사용)
|
||||
- `@Slf4j` 로거 사용
|
||||
|
||||
## 예외 처리
|
||||
- 비즈니스 예외는 커스텀 Exception 클래스 정의
|
||||
- `@ControllerAdvice`로 전역 예외 처리
|
||||
- 예외 메시지에 컨텍스트 정보 포함
|
||||
- catch 블록에서 예외 무시 금지 (`// ignore` 금지)
|
||||
|
||||
## 기타
|
||||
- `Optional`은 반환 타입으로만 사용 (필드, 파라미터에 사용 금지)
|
||||
- `null` 반환보다 빈 컬렉션 또는 `Optional` 반환
|
||||
- Stream API 활용 (단, 3단계 이상 체이닝은 메서드 추출)
|
||||
- 하드코딩된 문자열/숫자 금지 → 상수 또는 설정값으로 추출
|
||||
84
.claude/rules/git-workflow.md
Normal file
84
.claude/rules/git-workflow.md
Normal file
@ -0,0 +1,84 @@
|
||||
# Git 워크플로우 규칙
|
||||
|
||||
## 브랜치 전략
|
||||
|
||||
### 브랜치 구조
|
||||
```
|
||||
main ← 배포 가능한 안정 브랜치 (보호됨)
|
||||
└── develop ← 개발 통합 브랜치
|
||||
├── feature/ISSUE-123-기능설명
|
||||
├── bugfix/ISSUE-456-버그설명
|
||||
└── hotfix/ISSUE-789-긴급수정
|
||||
```
|
||||
|
||||
### 브랜치 네이밍
|
||||
- feature 브랜치: `feature/ISSUE-번호-간단설명` (예: `feature/ISSUE-42-user-login`)
|
||||
- bugfix 브랜치: `bugfix/ISSUE-번호-간단설명`
|
||||
- hotfix 브랜치: `hotfix/ISSUE-번호-간단설명`
|
||||
- 이슈 번호가 없는 경우: `feature/간단설명` (예: `feature/add-swagger-docs`)
|
||||
|
||||
### 브랜치 규칙
|
||||
- main, develop 브랜치에 직접 커밋/푸시 금지
|
||||
- feature 브랜치는 develop에서 분기
|
||||
- hotfix 브랜치는 main에서 분기
|
||||
- 머지는 반드시 MR(Merge Request)을 통해 수행
|
||||
|
||||
## 커밋 메시지 규칙
|
||||
|
||||
### Conventional Commits 형식
|
||||
```
|
||||
type(scope): subject
|
||||
|
||||
body (선택)
|
||||
|
||||
footer (선택)
|
||||
```
|
||||
|
||||
### type (필수)
|
||||
| type | 설명 |
|
||||
|------|------|
|
||||
| feat | 새로운 기능 추가 |
|
||||
| fix | 버그 수정 |
|
||||
| docs | 문서 변경 |
|
||||
| style | 코드 포맷팅 (기능 변경 없음) |
|
||||
| refactor | 리팩토링 (기능 변경 없음) |
|
||||
| test | 테스트 추가/수정 |
|
||||
| chore | 빌드, 설정 변경 |
|
||||
| ci | CI/CD 설정 변경 |
|
||||
| perf | 성능 개선 |
|
||||
|
||||
### scope (선택)
|
||||
- 변경 범위를 나타내는 짧은 단어
|
||||
- 한국어, 영어 모두 허용 (예: `feat(인증): 로그인 기능`, `fix(auth): token refresh`)
|
||||
|
||||
### subject (필수)
|
||||
- 변경 내용을 간결하게 설명
|
||||
- 한국어, 영어 모두 허용
|
||||
- 72자 이내
|
||||
- 마침표(.) 없이 끝냄
|
||||
|
||||
### 예시
|
||||
```
|
||||
feat(auth): JWT 기반 로그인 구현
|
||||
fix(배치): 야간 배치 타임아웃 수정
|
||||
docs: README에 빌드 방법 추가
|
||||
refactor(user-service): 중복 로직 추출
|
||||
test(결제): 환불 로직 단위 테스트 추가
|
||||
chore: Gradle 의존성 버전 업데이트
|
||||
```
|
||||
|
||||
## MR(Merge Request) 규칙
|
||||
|
||||
### MR 생성
|
||||
- 제목: 커밋 메시지와 동일한 Conventional Commits 형식
|
||||
- 본문: 변경 내용 요약, 테스트 방법, 관련 이슈 번호
|
||||
- 라벨: 적절한 라벨 부착 (feature, bugfix, hotfix 등)
|
||||
|
||||
### MR 리뷰
|
||||
- 최소 1명의 리뷰어 승인 필수
|
||||
- CI 검증 통과 필수 (설정된 경우)
|
||||
- 리뷰 코멘트 모두 해결 후 머지
|
||||
|
||||
### MR 머지
|
||||
- Squash Merge 권장 (깔끔한 히스토리)
|
||||
- 머지 후 소스 브랜치 삭제
|
||||
60
.claude/rules/naming.md
Normal file
60
.claude/rules/naming.md
Normal file
@ -0,0 +1,60 @@
|
||||
# Java 네이밍 규칙
|
||||
|
||||
## 패키지
|
||||
- 모두 소문자, 단수형
|
||||
- 도메인 역순: `com.gcsc.프로젝트명.모듈`
|
||||
- 예: `com.gcsc.batch.scheduler`, `com.gcsc.api.auth`
|
||||
|
||||
## 클래스
|
||||
- PascalCase
|
||||
- 명사 또는 명사구
|
||||
- 접미사로 역할 표시:
|
||||
|
||||
| 계층 | 접미사 | 예시 |
|
||||
|------|--------|------|
|
||||
| Controller | `Controller` | `UserController` |
|
||||
| Service | `Service` | `UserService` |
|
||||
| Service 구현 | `ServiceImpl` | `UserServiceImpl` (인터페이스 있을 때만) |
|
||||
| Repository | `Repository` | `UserRepository` |
|
||||
| Entity | (없음) | `User`, `ShipRoute` |
|
||||
| DTO 요청 | `Request` | `CreateUserRequest` |
|
||||
| DTO 응답 | `Response` | `UserResponse` |
|
||||
| 설정 | `Config` | `SecurityConfig` |
|
||||
| 예외 | `Exception` | `UserNotFoundException` |
|
||||
| Enum | (없음) | `UserStatus`, `ShipType` |
|
||||
| Mapper | `Mapper` | `UserMapper` |
|
||||
|
||||
## 메서드
|
||||
- camelCase
|
||||
- 동사로 시작
|
||||
- CRUD 패턴:
|
||||
|
||||
| 작업 | Controller | Service | Repository |
|
||||
|------|-----------|---------|------------|
|
||||
| 조회(단건) | `getUser()` | `getUser()` | `findById()` |
|
||||
| 조회(목록) | `getUsers()` | `getUsers()` | `findAll()` |
|
||||
| 생성 | `createUser()` | `createUser()` | `save()` |
|
||||
| 수정 | `updateUser()` | `updateUser()` | `save()` |
|
||||
| 삭제 | `deleteUser()` | `deleteUser()` | `deleteById()` |
|
||||
| 존재확인 | - | `existsUser()` | `existsById()` |
|
||||
|
||||
## 변수
|
||||
- camelCase
|
||||
- 의미 있는 이름 (단일 문자 변수 금지, 루프 인덱스 `i, j, k` 예외)
|
||||
- boolean: `is`, `has`, `can`, `should` 접두사
|
||||
- 예: `isActive`, `hasPermission`, `canDelete`
|
||||
|
||||
## 상수
|
||||
- UPPER_SNAKE_CASE
|
||||
- 예: `MAX_RETRY_COUNT`, `DEFAULT_PAGE_SIZE`
|
||||
|
||||
## 테스트
|
||||
- 클래스: `{대상클래스}Test` (예: `UserServiceTest`)
|
||||
- 메서드: `{메서드명}_{시나리오}_{기대결과}` 또는 한국어 `@DisplayName`
|
||||
- 예: `createUser_withDuplicateEmail_throwsException()`
|
||||
- 예: `@DisplayName("중복 이메일로 생성 시 예외 발생")`
|
||||
|
||||
## 파일/디렉토리
|
||||
- Java 파일: PascalCase (클래스명과 동일)
|
||||
- 리소스 파일: kebab-case (예: `application-local.yml`)
|
||||
- SQL 파일: `V{번호}__{설명}.sql` (Flyway) 또는 kebab-case
|
||||
34
.claude/rules/team-policy.md
Normal file
34
.claude/rules/team-policy.md
Normal file
@ -0,0 +1,34 @@
|
||||
# 팀 정책 (Team Policy)
|
||||
|
||||
이 규칙은 조직 전체에 적용되는 필수 정책입니다.
|
||||
프로젝트별 `.claude/rules/`에 추가 규칙을 정의할 수 있으나, 이 정책을 위반할 수 없습니다.
|
||||
|
||||
## 보안 정책
|
||||
|
||||
### 금지 행위
|
||||
- `.env`, `.env.*`, `secrets/` 파일 읽기 및 내용 출력 금지
|
||||
- 비밀번호, API 키, 토큰 등 민감 정보를 코드에 하드코딩 금지
|
||||
- `git push --force`, `git reset --hard`, `git clean -fd` 실행 금지
|
||||
- `rm -rf /`, `rm -rf ~`, `rm -rf .git` 등 파괴적 명령 실행 금지
|
||||
- main/develop 브랜치에 직접 push 금지 (MR을 통해서만 머지)
|
||||
|
||||
### 인증 정보 관리
|
||||
- 환경변수 또는 외부 설정 파일(`.env`, `application-local.yml`)로 관리
|
||||
- 설정 파일은 `.gitignore`에 반드시 포함
|
||||
- 예시 파일(`.env.example`, `application.yml.example`)만 커밋
|
||||
|
||||
## 코드 품질 정책
|
||||
|
||||
### 필수 검증
|
||||
- 커밋 전 빌드(컴파일) 성공 확인
|
||||
- 린트 경고 0개 유지 (CI에서도 검증)
|
||||
- 테스트 코드가 있는 프로젝트는 테스트 통과 필수
|
||||
|
||||
### 코드 리뷰
|
||||
- main 브랜치 머지 시 최소 1명 리뷰 필수
|
||||
- 리뷰어 승인 없이 머지 불가
|
||||
|
||||
## 문서화 정책
|
||||
- 공개 API(controller endpoint)에는 반드시 설명 주석 작성
|
||||
- 복잡한 비즈니스 로직에는 의도를 설명하는 주석 작성
|
||||
- README.md에 프로젝트 빌드/실행 방법 유지
|
||||
62
.claude/rules/testing.md
Normal file
62
.claude/rules/testing.md
Normal file
@ -0,0 +1,62 @@
|
||||
# Java 테스트 규칙
|
||||
|
||||
## 테스트 프레임워크
|
||||
- JUnit 5 + AssertJ 조합
|
||||
- Mockito로 의존성 모킹
|
||||
- Spring Boot Test (`@SpringBootTest`) 는 통합 테스트에만 사용
|
||||
|
||||
## 테스트 구조
|
||||
|
||||
### 단위 테스트 (Unit Test)
|
||||
- Service, Util, Domain 로직 테스트
|
||||
- Spring 컨텍스트 로딩 없이 (`@ExtendWith(MockitoExtension.class)`)
|
||||
- 외부 의존성은 Mockito로 모킹
|
||||
|
||||
```java
|
||||
@ExtendWith(MockitoExtension.class)
|
||||
class UserServiceTest {
|
||||
@InjectMocks
|
||||
private UserService userService;
|
||||
|
||||
@Mock
|
||||
private UserRepository userRepository;
|
||||
|
||||
@Test
|
||||
@DisplayName("사용자 생성 시 정상 저장")
|
||||
void createUser_withValidInput_savesUser() {
|
||||
// given
|
||||
// when
|
||||
// then
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 통합 테스트 (Integration Test)
|
||||
- Controller 테스트: `@WebMvcTest` + `MockMvc`
|
||||
- Repository 테스트: `@DataJpaTest`
|
||||
- 전체 플로우: `@SpringBootTest` (최소화)
|
||||
|
||||
### 테스트 패턴
|
||||
- **Given-When-Then** 구조 사용
|
||||
- 각 섹션을 주석으로 구분
|
||||
- 하나의 테스트에 하나의 검증 원칙 (가능한 범위에서)
|
||||
|
||||
## 테스트 네이밍
|
||||
- 메서드명: `{메서드}_{시나리오}_{기대결과}` 패턴
|
||||
- `@DisplayName`: 한국어로 테스트 의도 설명
|
||||
|
||||
## 테스트 커버리지
|
||||
- 새로 작성하는 Service 클래스: 핵심 비즈니스 로직 테스트 필수
|
||||
- 기존 코드 수정 시: 수정된 로직에 대한 테스트 추가 권장
|
||||
- Controller: 주요 API endpoint 통합 테스트 권장
|
||||
|
||||
## 테스트 데이터
|
||||
- 테스트 데이터는 테스트 메서드 내부 또는 `@BeforeEach`에서 생성
|
||||
- 공통 테스트 데이터는 TestFixture 클래스로 분리
|
||||
- 실제 DB 연결 필요 시 H2 인메모리 또는 Testcontainers 사용
|
||||
|
||||
## 금지 사항
|
||||
- `@SpringBootTest`를 단위 테스트에 사용 금지
|
||||
- 테스트 간 상태 공유 금지
|
||||
- `Thread.sleep()` 사용 금지 → `Awaitility` 사용
|
||||
- 실제 외부 API 호출 금지 → WireMock 또는 Mockito 사용
|
||||
47
.claude/settings.json
Normal file
47
.claude/settings.json
Normal file
@ -0,0 +1,47 @@
|
||||
{
|
||||
"$schema": "https://json.schemastore.org/claude-code-settings.json",
|
||||
"permissions": {
|
||||
"allow": [
|
||||
"Bash(./gradlew *)",
|
||||
"Bash(gradle *)",
|
||||
"Bash(java -version)",
|
||||
"Bash(java -jar *)",
|
||||
"Bash(git status)",
|
||||
"Bash(git diff *)",
|
||||
"Bash(git log *)",
|
||||
"Bash(git branch *)",
|
||||
"Bash(git checkout *)",
|
||||
"Bash(git add *)",
|
||||
"Bash(git commit *)",
|
||||
"Bash(git pull *)",
|
||||
"Bash(git fetch *)",
|
||||
"Bash(git merge *)",
|
||||
"Bash(git stash *)",
|
||||
"Bash(git remote *)",
|
||||
"Bash(git config *)",
|
||||
"Bash(git rev-parse *)",
|
||||
"Bash(git show *)",
|
||||
"Bash(git tag *)",
|
||||
"Bash(curl -s *)",
|
||||
"Bash(sdk *)"
|
||||
],
|
||||
"deny": [
|
||||
"Bash(git push --force*)",
|
||||
"Bash(git push -f *)",
|
||||
"Bash(git push origin --force*)",
|
||||
"Bash(git reset --hard*)",
|
||||
"Bash(git clean -fd*)",
|
||||
"Bash(git checkout -- .)",
|
||||
"Bash(git restore .)",
|
||||
"Bash(rm -rf /)",
|
||||
"Bash(rm -rf ~)",
|
||||
"Bash(rm -rf .git*)",
|
||||
"Bash(rm -rf /*)",
|
||||
"Read(./**/.env)",
|
||||
"Read(./**/.env.*)",
|
||||
"Read(./**/secrets/**)",
|
||||
"Read(./**/application-local.yml)",
|
||||
"Read(./**/application-local.properties)"
|
||||
]
|
||||
}
|
||||
}
|
||||
65
.claude/skills/create-mr/SKILL.md
Normal file
65
.claude/skills/create-mr/SKILL.md
Normal file
@ -0,0 +1,65 @@
|
||||
---
|
||||
name: create-mr
|
||||
description: 현재 브랜치에서 Gitea MR(Merge Request)을 생성합니다
|
||||
allowed-tools: "Bash, Read, Grep"
|
||||
argument-hint: "[target-branch: develop|main] (기본: develop)"
|
||||
---
|
||||
|
||||
현재 브랜치의 변경 사항을 기반으로 Gitea에 MR을 생성합니다.
|
||||
타겟 브랜치: $ARGUMENTS (기본: develop)
|
||||
|
||||
## 수행 단계
|
||||
|
||||
### 1. 사전 검증
|
||||
- 현재 브랜치가 main/develop이 아닌지 확인
|
||||
- 커밋되지 않은 변경 사항 확인 (있으면 경고)
|
||||
- 리모트에 현재 브랜치가 push되어 있는지 확인 (안 되어 있으면 push)
|
||||
|
||||
### 2. 변경 내역 분석
|
||||
```bash
|
||||
git log develop..HEAD --oneline
|
||||
git diff develop..HEAD --stat
|
||||
```
|
||||
- 커밋 목록과 변경된 파일 목록 수집
|
||||
- 주요 변경 사항 요약 작성
|
||||
|
||||
### 3. MR 정보 구성
|
||||
- **제목**: 브랜치의 첫 커밋 메시지 또는 브랜치명에서 추출
|
||||
- `feature/ISSUE-42-user-login` → `feat: ISSUE-42 user-login`
|
||||
- **본문**:
|
||||
```markdown
|
||||
## 변경 사항
|
||||
- (커밋 기반 자동 생성)
|
||||
|
||||
## 관련 이슈
|
||||
- closes #이슈번호 (브랜치명에서 추출)
|
||||
|
||||
## 테스트
|
||||
- [ ] 빌드 성공 확인
|
||||
- [ ] 기존 테스트 통과
|
||||
```
|
||||
|
||||
### 4. Gitea API로 MR 생성
|
||||
```bash
|
||||
# Gitea remote URL에서 owner/repo 추출
|
||||
REMOTE_URL=$(git remote get-url origin)
|
||||
|
||||
# Gitea API 호출
|
||||
curl -X POST "GITEA_URL/api/v1/repos/{owner}/{repo}/pulls" \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"title": "MR 제목",
|
||||
"body": "MR 본문",
|
||||
"head": "현재브랜치",
|
||||
"base": "타겟브랜치"
|
||||
}'
|
||||
```
|
||||
|
||||
### 5. 결과 출력
|
||||
- MR URL 출력
|
||||
- 리뷰어 지정 안내
|
||||
- 다음 단계: 리뷰 대기 → 승인 → 머지
|
||||
|
||||
## 필요 환경변수
|
||||
- `GITEA_TOKEN`: Gitea API 접근 토큰 (없으면 안내)
|
||||
49
.claude/skills/fix-issue/SKILL.md
Normal file
49
.claude/skills/fix-issue/SKILL.md
Normal file
@ -0,0 +1,49 @@
|
||||
---
|
||||
name: fix-issue
|
||||
description: Gitea 이슈를 분석하고 수정 브랜치를 생성합니다
|
||||
allowed-tools: "Bash, Read, Write, Edit, Glob, Grep"
|
||||
argument-hint: "<issue-number>"
|
||||
---
|
||||
|
||||
Gitea 이슈 #$ARGUMENTS 를 분석하고 수정 작업을 시작합니다.
|
||||
|
||||
## 수행 단계
|
||||
|
||||
### 1. 이슈 조회
|
||||
```bash
|
||||
curl -s "GITEA_URL/api/v1/repos/{owner}/{repo}/issues/$ARGUMENTS" \
|
||||
-H "Authorization: token ${GITEA_TOKEN}"
|
||||
```
|
||||
- 이슈 제목, 본문, 라벨, 담당자 정보 확인
|
||||
- 이슈 내용을 사용자에게 요약하여 보여줌
|
||||
|
||||
### 2. 브랜치 생성
|
||||
이슈 라벨에 따라 브랜치 타입 결정:
|
||||
- `bug` 라벨 → `bugfix/ISSUE-번호-설명`
|
||||
- 그 외 → `feature/ISSUE-번호-설명`
|
||||
- 긴급 → `hotfix/ISSUE-번호-설명`
|
||||
|
||||
```bash
|
||||
git checkout develop
|
||||
git pull origin develop
|
||||
git checkout -b {type}/ISSUE-{number}-{slug}
|
||||
```
|
||||
|
||||
### 3. 이슈 분석
|
||||
이슈 내용을 바탕으로:
|
||||
- 관련 파일 탐색 (Grep, Glob 활용)
|
||||
- 영향 범위 파악
|
||||
- 수정 방향 제안
|
||||
|
||||
### 4. 수정 계획 제시
|
||||
사용자에게 수정 계획을 보여주고 승인을 받은 후 작업 진행:
|
||||
- 수정할 파일 목록
|
||||
- 변경 내용 요약
|
||||
- 예상 영향
|
||||
|
||||
### 5. 작업 완료 후
|
||||
- 변경 사항 요약
|
||||
- `/create-mr` 실행 안내
|
||||
|
||||
## 필요 환경변수
|
||||
- `GITEA_TOKEN`: Gitea API 접근 토큰
|
||||
90
.claude/skills/init-project/SKILL.md
Normal file
90
.claude/skills/init-project/SKILL.md
Normal file
@ -0,0 +1,90 @@
|
||||
---
|
||||
name: init-project
|
||||
description: 팀 표준 워크플로우로 프로젝트를 초기화합니다
|
||||
allowed-tools: "Bash, Read, Write, Edit, Glob, Grep"
|
||||
argument-hint: "[project-type: java-maven|java-gradle|react-ts|auto]"
|
||||
---
|
||||
|
||||
팀 표준 워크플로우에 따라 프로젝트를 초기화합니다.
|
||||
프로젝트 타입: $ARGUMENTS (기본: auto — 자동 감지)
|
||||
|
||||
## 프로젝트 타입 자동 감지
|
||||
|
||||
$ARGUMENTS가 "auto"이거나 비어있으면 다음 순서로 감지:
|
||||
1. `pom.xml` 존재 → **java-maven**
|
||||
2. `build.gradle` 또는 `build.gradle.kts` 존재 → **java-gradle**
|
||||
3. `package.json` + `tsconfig.json` 존재 → **react-ts**
|
||||
4. 감지 실패 → 사용자에게 타입 선택 요청
|
||||
|
||||
## 수행 단계
|
||||
|
||||
### 1. 프로젝트 분석
|
||||
- 빌드 파일, 설정 파일, 디렉토리 구조 파악
|
||||
- 사용 중인 프레임워크, 라이브러리 감지
|
||||
- 기존 `.claude/` 디렉토리 존재 여부 확인
|
||||
|
||||
### 2. CLAUDE.md 생성
|
||||
프로젝트 루트에 CLAUDE.md를 생성하고 다음 내용 포함:
|
||||
- 프로젝트 개요 (이름, 타입, 주요 기술 스택)
|
||||
- 빌드/실행 명령어 (감지된 빌드 도구 기반)
|
||||
- 테스트 실행 명령어
|
||||
- 프로젝트 디렉토리 구조 요약
|
||||
- 팀 컨벤션 참조 (`.claude/rules/` 안내)
|
||||
|
||||
### 3. .claude/ 디렉토리 구성
|
||||
이미 팀 표준 파일이 존재하면 건너뜀. 없는 경우:
|
||||
- `.claude/settings.json` — 프로젝트 타입별 표준 권한 설정
|
||||
- `.claude/rules/` — 팀 규칙 파일 (team-policy, git-workflow, code-style, naming, testing)
|
||||
- `.claude/skills/` — 팀 스킬 (create-mr, fix-issue, sync-team-workflow)
|
||||
|
||||
### 4. Git Hooks 설정
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
`.githooks/` 디렉토리에 실행 권한 부여:
|
||||
```bash
|
||||
chmod +x .githooks/*
|
||||
```
|
||||
|
||||
### 5. 프로젝트 타입별 추가 설정
|
||||
|
||||
#### java-maven
|
||||
- `.sdkmanrc` 생성 (java=17.0.18-amzn 또는 프로젝트에 맞는 버전)
|
||||
- `.mvn/settings.xml` Nexus 미러 설정 확인
|
||||
- `mvn compile` 빌드 성공 확인
|
||||
|
||||
#### java-gradle
|
||||
- `.sdkmanrc` 생성
|
||||
- `gradle.properties.example` Nexus 설정 확인
|
||||
- `./gradlew compileJava` 빌드 성공 확인
|
||||
|
||||
#### react-ts
|
||||
- `.node-version` 생성 (프로젝트에 맞는 Node 버전)
|
||||
- `.npmrc` Nexus 레지스트리 설정 확인
|
||||
- `npm install && npm run build` 성공 확인
|
||||
|
||||
### 6. .gitignore 확인
|
||||
다음 항목이 .gitignore에 포함되어 있는지 확인하고, 없으면 추가:
|
||||
```
|
||||
.claude/settings.local.json
|
||||
.claude/CLAUDE.local.md
|
||||
.env
|
||||
.env.*
|
||||
*.local
|
||||
```
|
||||
|
||||
### 7. workflow-version.json 생성
|
||||
`.claude/workflow-version.json` 파일을 생성하여 현재 글로벌 워크플로우 버전 기록:
|
||||
```json
|
||||
{
|
||||
"applied_global_version": "1.0.0",
|
||||
"applied_date": "현재날짜",
|
||||
"project_type": "감지된타입"
|
||||
}
|
||||
```
|
||||
|
||||
### 8. 검증 및 요약
|
||||
- 생성/수정된 파일 목록 출력
|
||||
- `git config core.hooksPath` 확인
|
||||
- 빌드 명령 실행 가능 확인
|
||||
- 다음 단계 안내 (개발 시작, 첫 커밋 방법 등)
|
||||
73
.claude/skills/sync-team-workflow/SKILL.md
Normal file
73
.claude/skills/sync-team-workflow/SKILL.md
Normal file
@ -0,0 +1,73 @@
|
||||
---
|
||||
name: sync-team-workflow
|
||||
description: 팀 글로벌 워크플로우를 현재 프로젝트에 동기화합니다
|
||||
allowed-tools: "Bash, Read, Write, Edit, Glob, Grep"
|
||||
---
|
||||
|
||||
팀 글로벌 워크플로우의 최신 버전을 현재 프로젝트에 적용합니다.
|
||||
|
||||
## 수행 절차
|
||||
|
||||
### 1. 글로벌 버전 조회
|
||||
Gitea API로 template-common 리포의 workflow-version.json 조회:
|
||||
```bash
|
||||
GITEA_URL=$(python3 -c "import json; print(json.load(open('.claude/workflow-version.json')).get('gitea_url', 'http://211.208.115.83:3000'))" 2>/dev/null || echo "http://211.208.115.83:3000")
|
||||
|
||||
curl -sf "${GITEA_URL}/api/v1/repos/gcsc/template-common/raw/workflow-version.json"
|
||||
```
|
||||
|
||||
### 2. 버전 비교
|
||||
로컬 `.claude/workflow-version.json`과 비교:
|
||||
- 버전 일치 → "최신 버전입니다" 안내 후 종료
|
||||
- 버전 불일치 → 미적용 변경 항목 추출하여 표시
|
||||
|
||||
### 3. 프로젝트 타입 감지
|
||||
자동 감지 순서:
|
||||
1. `.claude/workflow-version.json`의 `project_type` 필드 확인
|
||||
2. 없으면: `pom.xml` → java-maven, `build.gradle` → java-gradle, `package.json` → react-ts
|
||||
|
||||
### 4. 파일 다운로드 및 적용
|
||||
Gitea API로 해당 타입 + common 템플릿 파일 다운로드:
|
||||
|
||||
#### 4-1. 규칙 파일 (덮어쓰기)
|
||||
팀 규칙은 로컬 수정 불가 — 항상 글로벌 최신으로 교체:
|
||||
```
|
||||
.claude/rules/team-policy.md
|
||||
.claude/rules/git-workflow.md
|
||||
.claude/rules/code-style.md (타입별)
|
||||
.claude/rules/naming.md (타입별)
|
||||
.claude/rules/testing.md (타입별)
|
||||
```
|
||||
|
||||
#### 4-2. settings.json (부분 갱신)
|
||||
- `deny` 목록: 글로벌 최신으로 교체
|
||||
- `allow` 목록: 기존 사용자 커스텀 유지 + 글로벌 기본값 병합
|
||||
- `hooks`: 글로벌 최신으로 교체
|
||||
|
||||
#### 4-3. 스킬 파일 (덮어쓰기)
|
||||
```
|
||||
.claude/skills/create-mr/SKILL.md
|
||||
.claude/skills/fix-issue/SKILL.md
|
||||
.claude/skills/sync-team-workflow/SKILL.md
|
||||
```
|
||||
|
||||
#### 4-4. Git Hooks (덮어쓰기 + 실행 권한)
|
||||
```bash
|
||||
chmod +x .githooks/*
|
||||
```
|
||||
|
||||
### 5. 로컬 버전 업데이트
|
||||
`.claude/workflow-version.json` 갱신:
|
||||
```json
|
||||
{
|
||||
"applied_global_version": "새버전",
|
||||
"applied_date": "오늘날짜",
|
||||
"project_type": "감지된타입"
|
||||
}
|
||||
```
|
||||
|
||||
### 6. 변경 보고
|
||||
- `git diff`로 변경 내역 확인
|
||||
- 업데이트된 파일 목록 출력
|
||||
- 변경 로그(글로벌 workflow-version.json의 changes) 표시
|
||||
- 필요한 추가 조치 안내 (빌드 확인, 의존성 업데이트 등)
|
||||
33
.editorconfig
Normal file
33
.editorconfig
Normal file
@ -0,0 +1,33 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.{java,kt}]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.{js,jsx,ts,tsx,json,yml,yaml,css,scss,html}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
[*.{sh,bash}]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[Makefile]
|
||||
indent_style = tab
|
||||
|
||||
[*.{gradle,groovy}]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.xml]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
60
.githooks/commit-msg
Executable file
60
.githooks/commit-msg
Executable file
@ -0,0 +1,60 @@
|
||||
#!/bin/bash
|
||||
#==============================================================================
|
||||
# commit-msg hook
|
||||
# Conventional Commits 형식 검증 (한/영 혼용 지원)
|
||||
#==============================================================================
|
||||
|
||||
COMMIT_MSG_FILE="$1"
|
||||
COMMIT_MSG=$(cat "$COMMIT_MSG_FILE")
|
||||
|
||||
# Merge 커밋은 검증 건너뜀
|
||||
if echo "$COMMIT_MSG" | head -1 | grep -qE "^Merge "; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Revert 커밋은 검증 건너뜀
|
||||
if echo "$COMMIT_MSG" | head -1 | grep -qE "^Revert "; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Conventional Commits 정규식
|
||||
# type(scope): subject
|
||||
# - type: feat|fix|docs|style|refactor|test|chore|ci|perf (필수)
|
||||
# - scope: 영문, 숫자, 한글, 점, 밑줄, 하이픈 허용 (선택)
|
||||
# - subject: 1~72자, 한/영 혼용 허용 (필수)
|
||||
PATTERN='^(feat|fix|docs|style|refactor|test|chore|ci|perf)(\([a-zA-Z0-9가-힣._-]+\))?: .{1,72}$'
|
||||
|
||||
FIRST_LINE=$(head -1 "$COMMIT_MSG_FILE")
|
||||
|
||||
if ! echo "$FIRST_LINE" | grep -qP "$PATTERN"; then
|
||||
echo ""
|
||||
echo "╔══════════════════════════════════════════════════════════════╗"
|
||||
echo "║ 커밋 메시지가 Conventional Commits 형식에 맞지 않습니다 ║"
|
||||
echo "╚══════════════════════════════════════════════════════════════╝"
|
||||
echo ""
|
||||
echo " 올바른 형식: type(scope): subject"
|
||||
echo ""
|
||||
echo " type (필수):"
|
||||
echo " feat — 새로운 기능"
|
||||
echo " fix — 버그 수정"
|
||||
echo " docs — 문서 변경"
|
||||
echo " style — 코드 포맷팅"
|
||||
echo " refactor — 리팩토링"
|
||||
echo " test — 테스트"
|
||||
echo " chore — 빌드/설정 변경"
|
||||
echo " ci — CI/CD 변경"
|
||||
echo " perf — 성능 개선"
|
||||
echo ""
|
||||
echo " scope (선택): 한/영 모두 가능"
|
||||
echo " subject (필수): 1~72자, 한/영 모두 가능"
|
||||
echo ""
|
||||
echo " 예시:"
|
||||
echo " feat(auth): JWT 기반 로그인 구현"
|
||||
echo " fix(배치): 야간 배치 타임아웃 수정"
|
||||
echo " docs: README 업데이트"
|
||||
echo " chore: Gradle 의존성 업데이트"
|
||||
echo ""
|
||||
echo " 현재 메시지: $FIRST_LINE"
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
25
.githooks/post-checkout
Executable file
25
.githooks/post-checkout
Executable file
@ -0,0 +1,25 @@
|
||||
#!/bin/bash
|
||||
#==============================================================================
|
||||
# post-checkout hook
|
||||
# 브랜치 체크아웃 시 core.hooksPath 자동 설정
|
||||
# clone/checkout 후 .githooks 디렉토리가 있으면 자동으로 hooksPath 설정
|
||||
#==============================================================================
|
||||
|
||||
# post-checkout 파라미터: prev_HEAD, new_HEAD, branch_flag
|
||||
# branch_flag=1: 브랜치 체크아웃, 0: 파일 체크아웃
|
||||
BRANCH_FLAG="$3"
|
||||
|
||||
# 파일 체크아웃은 건너뜀
|
||||
if [ "$BRANCH_FLAG" = "0" ]; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# .githooks 디렉토리 존재 확인
|
||||
REPO_ROOT=$(git rev-parse --show-toplevel 2>/dev/null)
|
||||
if [ -d "${REPO_ROOT}/.githooks" ]; then
|
||||
CURRENT_HOOKS_PATH=$(git config core.hooksPath 2>/dev/null || echo "")
|
||||
if [ "$CURRENT_HOOKS_PATH" != ".githooks" ]; then
|
||||
git config core.hooksPath .githooks
|
||||
chmod +x "${REPO_ROOT}/.githooks/"* 2>/dev/null
|
||||
fi
|
||||
fi
|
||||
33
.githooks/pre-commit
Executable file
33
.githooks/pre-commit
Executable file
@ -0,0 +1,33 @@
|
||||
#!/bin/bash
|
||||
#==============================================================================
|
||||
# pre-commit hook (Java Gradle)
|
||||
# Gradle 컴파일 검증 — 컴파일 실패 시 커밋 차단
|
||||
#==============================================================================
|
||||
|
||||
echo "pre-commit: Gradle 컴파일 검증 중..."
|
||||
|
||||
# Gradle Wrapper 사용 (없으면 gradle 사용)
|
||||
if [ -f "./gradlew" ]; then
|
||||
GRADLE="./gradlew"
|
||||
elif command -v gradle &>/dev/null; then
|
||||
GRADLE="gradle"
|
||||
else
|
||||
echo "경고: Gradle이 설치되지 않았습니다. 컴파일 검증을 건너뜁니다."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# 컴파일 검증 (테스트 제외)
|
||||
$GRADLE compileJava -q 2>&1
|
||||
RESULT=$?
|
||||
|
||||
if [ $RESULT -ne 0 ]; then
|
||||
echo ""
|
||||
echo "╔══════════════════════════════════════════════════════════╗"
|
||||
echo "║ 컴파일 실패! 커밋이 차단되었습니다. ║"
|
||||
echo "║ 컴파일 오류를 수정한 후 다시 커밋해주세요. ║"
|
||||
echo "╚══════════════════════════════════════════════════════════╝"
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "pre-commit: 컴파일 성공"
|
||||
45
.gitignore
vendored
Normal file
45
.gitignore
vendored
Normal file
@ -0,0 +1,45 @@
|
||||
# === Build ===
|
||||
build/
|
||||
!gradle/wrapper/gradle-wrapper.jar
|
||||
!**/src/main/**/build/
|
||||
!**/src/test/**/build/
|
||||
|
||||
# === IDE ===
|
||||
.idea/
|
||||
*.iws
|
||||
*.iml
|
||||
*.ipr
|
||||
.project
|
||||
.classpath
|
||||
.settings/
|
||||
.factorypath
|
||||
.vscode/
|
||||
|
||||
# === OS ===
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# === Java ===
|
||||
*.class
|
||||
*.log
|
||||
*.jar
|
||||
!gradle/wrapper/*.jar
|
||||
hs_err_pid*
|
||||
|
||||
# === Gradle ===
|
||||
.gradle/
|
||||
gradle.properties
|
||||
!gradle.properties.example
|
||||
|
||||
# === Spring Boot ===
|
||||
application-local.yml
|
||||
application-local.properties
|
||||
|
||||
# === Environment ===
|
||||
.env
|
||||
.env.*
|
||||
secrets/
|
||||
|
||||
# === Claude Code (개인 설정) ===
|
||||
.claude/settings.local.json
|
||||
.claude/CLAUDE.local.md
|
||||
65
CLAUDE.md
Normal file
65
CLAUDE.md
Normal file
@ -0,0 +1,65 @@
|
||||
# 프로젝트 개요
|
||||
|
||||
- **타입**: Java + Spring Boot + Gradle
|
||||
- **JDK**: 17 (`.sdkmanrc` 참조)
|
||||
- **프레임워크**: Spring Boot
|
||||
- **빌드 도구**: Gradle (Gradle Wrapper 사용)
|
||||
|
||||
## 빌드 및 실행
|
||||
|
||||
```bash
|
||||
# 빌드
|
||||
./gradlew compileJava
|
||||
|
||||
# 패키징
|
||||
./gradlew build -x test
|
||||
|
||||
# 테스트
|
||||
./gradlew test
|
||||
|
||||
# 특정 테스트 클래스 실행
|
||||
./gradlew test --tests "패키지.클래스명"
|
||||
|
||||
# 로컬 실행
|
||||
./gradlew bootRun
|
||||
|
||||
# 린트 (Checkstyle 설정된 경우)
|
||||
./gradlew checkstyleMain
|
||||
```
|
||||
|
||||
## 프로젝트 구조
|
||||
|
||||
```
|
||||
src/
|
||||
├── main/
|
||||
│ ├── java/
|
||||
│ │ └── com/gcsc/{프로젝트}/
|
||||
│ │ ├── config/ # 설정 클래스
|
||||
│ │ ├── controller/ # REST 컨트롤러
|
||||
│ │ ├── service/ # 비즈니스 로직
|
||||
│ │ ├── repository/ # 데이터 접근
|
||||
│ │ ├── domain/ # 엔티티
|
||||
│ │ ├── dto/ # 데이터 전송 객체
|
||||
│ │ ├── exception/ # 예외 처리
|
||||
│ │ └── util/ # 유틸리티
|
||||
│ └── resources/
|
||||
│ ├── application.yml # 공통 설정
|
||||
│ ├── application-local.yml # 로컬 설정 (.gitignore)
|
||||
│ └── application-prod.yml # 운영 설정
|
||||
└── test/
|
||||
└── java/ # 테스트 코드
|
||||
```
|
||||
|
||||
## 팀 규칙
|
||||
|
||||
- 코드 스타일: `.claude/rules/code-style.md` 참조
|
||||
- 네이밍 규칙: `.claude/rules/naming.md` 참조
|
||||
- 테스트 규칙: `.claude/rules/testing.md` 참조
|
||||
- Git 워크플로우: `.claude/rules/git-workflow.md` 참조
|
||||
- 팀 정책: `.claude/rules/team-policy.md` 참조
|
||||
|
||||
## 의존성 관리
|
||||
|
||||
- Nexus 프록시 레포지토리를 통해 의존성 관리 (`build.gradle` repositories 블록)
|
||||
- 인증 정보는 `~/.gradle/gradle.properties`에 관리 (커밋 금지)
|
||||
- 프로젝트의 `gradle.properties.example`을 참고하여 로컬 설정
|
||||
10
gradle.properties.example
Normal file
10
gradle.properties.example
Normal file
@ -0,0 +1,10 @@
|
||||
# Nexus Repository 설정
|
||||
# 이 파일을 gradle.properties로 복사하여 사용하세요.
|
||||
# gradle.properties는 .gitignore에 포함되어 있습니다.
|
||||
|
||||
# Nexus URL
|
||||
nexusUrl=http://211.208.115.83:9081/repository
|
||||
|
||||
# Nexus 인증 (내부 라이브러리 배포 시 필요)
|
||||
# nexusUsername=your-username
|
||||
# nexusPassword=your-password
|
||||
26
workflow-version.json
Normal file
26
workflow-version.json
Normal file
@ -0,0 +1,26 @@
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"updated": "2026-02-14",
|
||||
"gitea_url": "http://211.208.115.83:3000",
|
||||
"nexus_url": "http://211.208.115.83:9081",
|
||||
"changes": [
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"date": "2026-02-14",
|
||||
"description": "팀 워크플로우 초기 구성",
|
||||
"items": [
|
||||
"3계층 정책 강제 (프로젝트 deny + 서버 hooks + Branch Protection)",
|
||||
"Java Maven/Gradle + React TS 템플릿",
|
||||
"Nexus 자체 레포지토리 연동",
|
||||
"Conventional Commits (한/영 혼용)",
|
||||
"Git hooks: pre-commit(빌드검증), commit-msg(형식검증), post-checkout(hooksPath 자동설정)"
|
||||
],
|
||||
"affected_files": [
|
||||
".claude/settings.json",
|
||||
".claude/rules/*",
|
||||
".claude/skills/*",
|
||||
".githooks/*"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
불러오는 중...
Reference in New Issue
Block a user