@seahworks/branch-cli 1.0.2 → 1.0.4

package/README.md

@@ -2,6 +2,14 @@
 
 세아웍스 Git 브랜치 네이밍 규칙을 준수하는 브랜치를 쉽게 생성하는 CLI 도구입니다.
 
+## 주요 기능
+
+- ✅ 브랜치 네이밍 규칙 자동 적용
+- ✅ dev_06M/dev_06MON 브랜치에서만 생성 가능
+- ✅ 자동 git fetch 및 동기화 상태 확인
+- ✅ Pull/Push 필요 시 안내 메시지
+- ✅ 대화형 인터페이스로 쉬운 사용
+
 ## 설치
 
 ### Yarn (권장)
@@ -16,20 +24,107 @@ yarn global add @seah/branch-cli
 npm install -g @seah/branch-cli
 ```
 
+## 환경별 추가 설정
+
+### Windows - Git Bash 사용자
+
+Git Bash에서는 PATH 설정이 추가로 필요합니다:
+
+```bash
+# 자동 설정 (권장)
+YARN_BIN=$(yarn global bin | sed 's/\\/\//g' | sed 's/C:/\/c/')
+echo "export PATH=\"$YARN_BIN:\$PATH\"" >> ~/.bashrc
+source ~/.bashrc
+```
+
+**수동 설정:**
+
+```bash
+# 1. .bashrc 편집
+nano ~/.bashrc
+
+# 2. 파일 맨 아래에 추가 (YourName을 실제 사용자명으로 변경)
+export PATH="/c/Users/YourName/AppData/Local/Yarn/bin:$PATH"
+
+# 3. 저장 후 적용
+source ~/.bashrc
+```
+
+### Windows - PowerShell/CMD 사용자
+
+1. `Win + R` → `sysdm.cpl` 입력 → Enter
+2. **고급** 탭 → **환경 변수** 클릭
+3. **사용자 변수**에서 **Path** 선택 → **편집**
+4. **새로 만들기** 클릭
+5. `yarn global bin` 명령어 결과 경로 입력
+
+```
+   C:\Users\YourName\AppData\Local\Yarn\bin
+```
+
+6. **확인** 후 **PowerShell/CMD 재시작**
+
+### macOS / Linux
+
+```bash
+# Zsh (macOS 기본)
+echo 'export PATH="$(yarn global bin):$PATH"' >> ~/.zshrc
+source ~/.zshrc
+
+# Bash
+echo 'export PATH="$(yarn global bin):$PATH"' >> ~/.bashrc
+source ~/.bashrc
+```
+
 ## 사용법
 
-Git 저장소 내에서 다음 명령어를 실행하세요:
+### 1. dev 브랜치로 이동
+
+**중요:** 브랜치 생성은 `dev_06M` 또는 `dev_06MON` 브랜치에서만 가능합니다.
+
+```bash
+git checkout dev_06M
+# 또는
+git checkout dev_06MON
+```
+
+### 2. CLI 도구 실행
 
 ```bash
 seah-branch
 ```
 
-대화형 프롬프트를 따라 다음을 선택/입력합니다:
+도구가 자동으로 다음을 확인합니다:
+
+- ✅ 현재 브랜치가 dev_06M 또는 dev_06MON인지 검증
+- ✅ 원격 저장소에서 최신 정보 가져오기 (`git fetch`)
+- ✅ Pull/Push가 필요한지 확인
+
+### 3. 브랜치 정보 입력
+
+대화형 프롬프트에 따라 선택/입력:
+
+1. **브랜치 타입**
+
+   - feature (새 기능)
+   - hotfix (긴급 수정)
+   - bugfix (버그 수정)
+
+2. **모듈**
+
+   - 공통, 전자결재, 조직도, 근태, 게시판, 관리자, SELIS, SETIS
+
+3. **회사**
+
+   - 세아홀딩스, 세아베스틸지주, 세아베스틸, 세아창원특수강, 세아제강지주, 세아제강, 기타
 
-1. 브랜치 타입 (feature/hotfix/bugfix)
-2. 모듈 (공통/전자결재/조직도/근태/게시판/관리자/SELIS/SETIS)
-3. 회사 (세아홀딩스/세아베스틸지주/세아베스틸/세아창원특수강/세아제강지주/세아제강/기타)
-4. SR/ITS 번호 (예: SR2601-01234 또는 빈 값으로 남겨두세요)
+4. **SR/ITS 또는 티켓 번호** (선택사항)
+   - 예: `SR2601-01234`
+   - 없으면 Enter
+
+### 4. 브랜치 생성 완료
+
+확인 후 새 브랜치가 자동으로 생성되고 체크아웃됩니다.
 
 ## 브랜치 네이밍 규칙
 
@@ -39,17 +134,251 @@ seah-branch
 {type}/{year}/{module}/{company}/{mmdd}-{sr-number}
 ```
 
-**예시:**
+### 예시
+
+**티켓 번호가 있는 경우:**
 
 ```
 feature/2024/appr/aaaa0000000/1229-sr2612-01234
 ```
 
+**티켓 번호가 없는 경우:**
+
+```
+feature/2024/board/etc/1229
+```
+
+### 구성 요소
+
+- `type`: feature, hotfix, bugfix
+- `year`: 자동으로 현재 연도 (예: 2024)
+- `module`: cmn, appr, org, emp, board, admin, selis, setis
+- `company`: aaaa0000000, aamw0000000, aaaw0000000, aabw0000000, aaeb0000000, aaab0000000, etc
+- `mmdd`: 자동으로 오늘 날짜 (예: 1229)
+- `sr-number`: SR2601-01234 또는 ITS2601-01234 (선택사항)
+
+## 실행 시나리오
+
+### ✅ 정상 진행
+
+```bash
+$ seah-branch
+
+🌿 세아웍스 브랜치 생성 도구
+
+현재 브랜치: dev_06M
+
+✅ dev_06M 브랜치에서 실행 중
+
+🔄 원격 저장소에서 최신 정보를 가져오는 중...
+
+✅ 브랜치가 최신 상태입니다.
+
+? 브랜치 타입을 선택하세요: feature - 새 기능
+? 모듈을 선택하세요: 전자결재
+? 회사를 선택하세요: 세아홀딩스
+? SR/ITS 또는 티켓 번호를 입력하세요: SR2601-01234
+
+생성할 브랜치: feature/2024/appr/aaaa0000000/1229-sr2601-01234
+
+? 이 브랜치를 생성하시겠습니까? Yes
+
+✅ 브랜치 생성 완료: feature/2024/appr/aaaa0000000/1229-sr2601-01234
+```
+
+### ❌ dev 브랜치가 아닌 경우
+
+```bash
+$ seah-branch
+
+🌿 세아웍스 브랜치 생성 도구
+
+현재 브랜치: main
+
+❌ 브랜치 생성은 dev_06M 또는 dev_06MON 브랜치에서만 가능합니다.
+
+다음 명령어로 브랜치를 변경한 후 다시 실행하세요:
+  git checkout dev_06M
+  또는
+  git checkout dev_06MON
+```
+
+### ⚠️ Pull이 필요한 경우
+
+```bash
+$ seah-branch
+
+🌿 세아웍스 브랜치 생성 도구
+
+현재 브랜치: dev_06M
+
+✅ dev_06M 브랜치에서 실행 중
+
+🔄 원격 저장소에서 최신 정보를 가져오는 중...
+
+⚠️  브랜치 동기화 필요
+
+❌ 원격 저장소에 3개의 새로운 커밋이 있습니다.
+다음 명령어로 최신 변경사항을 받아오세요:
+  git pull origin dev_06M
+
+동기화 후 다시 실행해주세요.
+```
+
+### ⚠️ Push가 필요한 경우
+
+```bash
+$ seah-branch
+
+🌿 세아웍스 브랜치 생성 도구
+
+현재 브랜치: dev_06MON
+
+✅ dev_06MON 브랜치에서 실행 중
+
+🔄 원격 저장소에서 최신 정보를 가져오는 중...
+
+⚠️  브랜치 동기화 필요
+
+❌ 로컬에 2개의 푸시되지 않은 커밋이 있습니다.
+다음 명령어로 변경사항을 푸시하세요:
+  git push origin dev_06MON
+
+동기화 후 다시 실행해주세요.
+```
+
 ## 요구사항
 
-- Node.js 22 이상
+- Node.js 18 이상
 - Git
 - Yarn 또는 npm
+- dev_06M 또는 dev_06MON 브랜치
+
+## 업데이트
+
+```bash
+# Yarn
+yarn global upgrade @seah/branch-cli
+
+# npm
+npm update -g @seah/branch-cli
+```
+
+## 문제 해결
+
+### command not found: seah-branch
+
+#### Windows - Git Bash
+
+```bash
+# PATH 확인
+echo $PATH | grep -i yarn
+
+# PATH 추가
+YARN_BIN=$(yarn global bin | sed 's/\\/\//g' | sed 's/C:/\/c/')
+echo "export PATH=\"$YARN_BIN:\$PATH\"" >> ~/.bashrc
+source ~/.bashrc
+
+# 확인
+seah-branch
+```
+
+#### Windows - PowerShell/CMD
+
+1. PowerShell을 **완전히 종료** 후 **새로 열기**
+2. 그래도 안 되면 **PC 재부팅**
+3. 여전히 안 되면 환경 변수 설정 다시 확인
+
+#### macOS / Linux
+
+```bash
+# PATH 추가 및 저장
+echo 'export PATH="$(yarn global bin):$PATH"' >> ~/.zshrc  # Zsh
+# 또는
+echo 'export PATH="$(yarn global bin):$PATH"' >> ~/.bashrc  # Bash
+
+# 적용
+source ~/.zshrc  # 또는 source ~/.bashrc
+```
+
+### Node.js 버전 확인
+
+```bash
+node --version
+# v18.0.0 이상이어야 합니다
+```
+
+**업데이트 방법:**
+
+```bash
+# nvm 사용 시
+nvm install 18
+nvm use 18
+
+# 공식 사이트 다운로드
+# https://nodejs.org
+```
+
+### Git 저장소가 아닙니다
+
+```bash
+❌ Git 저장소가 아니거나 브랜치를 확인할 수 없습니다.
+```
+
+**해결:**
+
+- Git 저장소 디렉토리에서 실행하세요
+- `git init` 또는 `git clone`으로 저장소 생성
+
+### 임시 해결책
+
+PATH 설정이 어려운 경우:
+
+#### npx 사용 (npm 설치 시)
+
+```bash
+npx @seah/branch-cli
+```
+
+#### 전체 경로로 실행
+
+**Windows - Git Bash:**
+
+```bash
+"/c/Users/YourName/AppData/Local/Yarn/bin/seah-branch"
+```
+
+**Windows - PowerShell/CMD:**
+
+```bash
+C:\Users\YourName\AppData\Local\Yarn\bin\seah-branch
+```
+
+**macOS / Linux:**
+
+```bash
+$(yarn global bin)/seah-branch
+```
+
+#### package.json 스크립트
+
+프로젝트 `package.json`에 추가:
+
+```json
+{
+  "scripts": {
+    "branch": "seah-branch"
+  }
+}
+```
+
+실행:
+
+```bash
+yarn branch
+# 또는
+npm run branch
+```
 
 ## 라이선스
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seahworks/branch-cli",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "세아웍스 Git 브랜치 네이밍 규칙 준수 도구",
   "type": "module",
   "main": "./src/index.js",
@@ -25,7 +25,7 @@
     "chalk": "^5.3.0"
   },
   "engines": {
-    "node": ">=22.0.0"
+    "node": ">=18.0.0"
   },
   "repository": {
     "type": "git",

package/src/index.js

@@ -13,21 +13,157 @@ function getTodayMMDD() {
 
 // SR/ITS 번호 검증
 function validateSRNumber(value) {
-  // 빈 값 허용
-  if (!value || value.trim() === "") {
-    return true;
+  return true;
+}
+
+// 현재 브랜치 가져오기
+function getCurrentBranch() {
+  try {
+    const branch = execSync("git branch --show-current", {
+      encoding: "utf-8",
+    }).trim();
+    return branch;
+  } catch (error) {
+    console.error(
+      chalk.red("❌ Git 저장소가 아니거나 브랜치를 확인할 수 없습니다.")
+    );
+    process.exit(1);
   }
+}
+
+// dev_06M 또는 dev_06MON 브랜치인지 확인
+function isDevBranch(branchName) {
+  return branchName === "dev_06M" || branchName === "dev_06MON";
+}
 
-  const pattern = /^(SR|ITS)\d{4}-\d{5}$/i;
-  if (pattern.test(value)) {
+// Git fetch 실행
+function gitFetch() {
+  try {
+    console.log(chalk.blue("🔄 원격 저장소에서 최신 정보를 가져오는 중..."));
+    execSync("git fetch", { stdio: "inherit" });
     return true;
+  } catch (error) {
+    console.error(chalk.red("❌ git fetch 실패"));
+    return false;
   }
-  return "SR2601-01234 또는 ITS2601-01234 형식으로 입력하거나 빈 값으로 남겨두세요";
+}
+
+// 로컬과 원격 브랜치 비교
+function checkBranchStatus(branchName) {
+  try {
+    // 원격 브랜치가 존재하는지 확인
+    const remoteBranch = `origin/${branchName}`;
+    try {
+      execSync(`git rev-parse --verify ${remoteBranch}`, { stdio: "pipe" });
+    } catch {
+      // 원격 브랜치가 없으면 로컬 전용 브랜치
+      return { canProceed: true, needsPull: false, needsPush: false };
+    }
+
+    // 로컬과 원격 커밋 비교
+    const localCommit = execSync(`git rev-parse ${branchName}`, {
+      encoding: "utf-8",
+    }).trim();
+    const remoteCommit = execSync(`git rev-parse ${remoteBranch}`, {
+      encoding: "utf-8",
+    }).trim();
+
+    if (localCommit === remoteCommit) {
+      // 동기화 상태
+      return { canProceed: true, needsPull: false, needsPush: false };
+    }
+
+    // ahead/behind 확인
+    const ahead = execSync(
+      `git rev-list --count ${remoteBranch}..${branchName}`,
+      { encoding: "utf-8" }
+    ).trim();
+    const behind = execSync(
+      `git rev-list --count ${branchName}..${remoteBranch}`,
+      { encoding: "utf-8" }
+    ).trim();
+
+    return {
+      canProceed: false,
+      needsPull: parseInt(behind) > 0,
+      needsPush: parseInt(ahead) > 0,
+      aheadCount: parseInt(ahead),
+      behindCount: parseInt(behind),
+    };
+  } catch (error) {
+    console.error(chalk.yellow("⚠️  브랜치 상태 확인 중 오류 발생"));
+    return { canProceed: true, needsPull: false, needsPush: false };
+  }
+}
+
+// 브랜치 검증 및 준비
+async function validateAndPrepareBranch() {
+  const currentBranch = getCurrentBranch();
+
+  console.log(chalk.blue(`현재 브랜치: ${currentBranch}\n`));
+
+  // 1. dev_06M 또는 dev_06MON이 아닌 경우
+  if (!isDevBranch(currentBranch)) {
+    console.log(
+      chalk.red(
+        "❌ 브랜치 생성은 dev_06M 또는 dev_06MON 브랜치에서만 가능합니다.\n"
+      )
+    );
+    console.log(
+      chalk.yellow("다음 명령어로 브랜치를 변경한 후 다시 실행하세요:")
+    );
+    console.log(chalk.cyan("  git checkout dev_06M"));
+    console.log(chalk.cyan("  또는"));
+    console.log(chalk.cyan("  git checkout dev_06MON\n"));
+    process.exit(1);
+  }
+
+  // 2. dev_06M 또는 dev_06MON인 경우 - fetch 실행
+  console.log(chalk.green(`✅ ${currentBranch} 브랜치에서 실행 중\n`));
+
+  if (!gitFetch()) {
+    process.exit(1);
+  }
+
+  // 3. pull/push 필요 여부 확인
+  const status = checkBranchStatus(currentBranch);
+
+  if (!status.canProceed) {
+    console.log(chalk.yellow("\n⚠️  브랜치 동기화 필요\n"));
+
+    if (status.needsPull) {
+      console.log(
+        chalk.red(
+          `❌ 원격 저장소에 ${status.behindCount}개의 새로운 커밋이 있습니다.`
+        )
+      );
+      console.log(chalk.yellow("다음 명령어로 최신 변경사항을 받아오세요:"));
+      console.log(chalk.cyan(`  git pull origin ${currentBranch}\n`));
+    }
+
+    if (status.needsPush) {
+      console.log(
+        chalk.red(
+          `❌ 로컬에 ${status.aheadCount}개의 푸시되지 않은 커밋이 있습니다.`
+        )
+      );
+      console.log(chalk.yellow("다음 명령어로 변경사항을 푸시하세요:"));
+      console.log(chalk.cyan(`  git push origin ${currentBranch}\n`));
+    }
+
+    console.log(chalk.yellow("동기화 후 다시 실행해주세요.\n"));
+    process.exit(1);
+  }
+
+  console.log(chalk.green("✅ 브랜치가 최신 상태입니다.\n"));
 }
 
 async function createBranch() {
   console.log(chalk.blue.bold("\n🌿 세아웍스 브랜치 생성 도구\n"));
 
+  // 브랜치 검증 및 준비
+  await validateAndPrepareBranch();
+
   try {
     // 브랜치 타입 선택
     const type = await select({
@@ -85,11 +221,7 @@ async function createBranch() {
         console.log(chalk.green.bold(`\n✅ 브랜치 생성 완료: ${branchName}\n`));
       } catch (error) {
         console.error(chalk.red("\n❌ 브랜치 생성 실패"));
-        console.error(
-          chalk.red(
-            "Git 저장소인지 확인하거나 이미 존재하는 브랜치명인지 확인하세요.\n"
-          )
-        );
+        console.error(chalk.red("이미 존재하는 브랜치명인지 확인하세요.\n"));
         process.exit(1);
       }
     } else {