tylersong 1.0.11 → 1.0.12

package/docs/auto-deployment.md

@@ -1,191 +0,0 @@
-# 자동 배포 시스템 가이드
-
-## 🎯 개요
-이 시스템은 main 브랜치에 PR이 merge될 때 자동으로 버전을 업데이트하고 NPM에 배포하는 완전 자동화된 배포 시스템입니다.
-
-## 🚀 작동 방식
-
-### 1. 자동 트리거
-- **main 브랜치로의 PR merge**: CI 완료 후 자동 배포 시작
-- **main 브랜치로의 직접 push**: 즉시 자동 배포 시작
-- **태그 push**: 기존 태그 기반 배포 유지
-
-### 2. 자동 버전 결정 (Semantic Versioning)
-커밋 메시지를 분석하여 자동으로 버전 타입을 결정합니다:
-
-#### 🔴 Major 버전 (X.0.0)
-```bash
-# Breaking changes
-git commit -m "feat!: completely new API structure"
-git commit -m "fix!: remove deprecated method"
-git commit -m "feat: add new feature
-
-BREAKING CHANGE: This removes the old API"
-```
-
-#### 🟡 Minor 버전 (0.X.0)  
-```bash
-# New features
-git commit -m "feat: add user profile management"
-git commit -m "feat(auth): implement OAuth login"
-```
-
-#### 🟢 Patch 버전 (0.0.X)
-```bash
-# Bug fixes, docs, chores (default)
-git commit -m "fix: resolve login redirect issue"
-git commit -m "docs: update README"
-git commit -m "chore: update dependencies"
-git commit -m "style: fix code formatting"
-```
-
-### 3. 자동 실행 과정
-1. **CI 실행**: 테스트, 빌드, 린팅
-2. **버전 분석**: 현재 버전 vs NPM 배포 버전 비교
-3. **자동 버전 업데이트**: 필요 시 package.json 및 소스코드 버전 업데이트
-4. **자동 커밋**: 버전 업데이트 커밋 생성 및 푸시
-5. **빌드 및 배포**: TypeScript 빌드 후 NPM 배포
-6. **알림**: Discord 및 콘솔 알림
-
-## 📋 사전 설정 요구사항
-
-### 1. GitHub Secrets 설정
-```bash
-# NPM 토큰 설정 (필수)
-NPM_TOKEN=your_npm_token_here
-
-# Discord 알림 (선택사항)
-DISCORD_WEBHOOK_URL=your_discord_webhook_url
-```
-
-### 2. NPM 토큰 생성 방법
-1. [npmjs.com](https://www.npmjs.com)에 로그인
-2. Profile → Access Tokens → Generate New Token
-3. **Automation** 타입 선택
-4. 생성된 토큰을 GitHub Repository Settings → Secrets에 `NPM_TOKEN`으로 추가
-
-## 🎨 Conventional Commits 가이드
-
-### 기본 형식
-```
-<type>[optional scope]: <description>
-
-[optional body]
-
-[optional footer(s)]
-```
-
-### 주요 타입들
-| 타입 | 설명 | 버전 영향 |
-|------|------|-----------|
-| `feat` | 새로운 기능 | Minor |
-| `fix` | 버그 수정 | Patch |
-| `docs` | 문서 변경 | Patch |
-| `style` | 코드 스타일 변경 | Patch |
-| `refactor` | 코드 리팩토링 | Patch |
-| `test` | 테스트 추가/수정 | Patch |
-| `chore` | 빌드/설정 변경 | Patch |
-| `!` | Breaking Change | Major |
-
-### 실제 예시
-```bash
-# 새 기능 추가 (Minor 버전 증가)
-git commit -m "feat: add interactive CLI menu"
-
-# 버그 수정 (Patch 버전 증가)  
-git commit -m "fix: resolve command parsing error"
-
-# Breaking Change (Major 버전 증가)
-git commit -m "feat!: redesign CLI interface"
-
-# 상세한 설명이 있는 커밋
-git commit -m "feat: add color themes
-
-- Add dark and light theme options
-- Implement theme persistence
-- Update help text with theme info"
-```
-
-## 🔧 워크플로우 파일 구성
-
-### 주요 작업들
-1. **check-ci**: CI 상태 확인
-2. **auto-version**: 자동 버전 업데이트 및 결정
-3. **version-check**: 태그 기반 배포용 버전 확인
-4. **publish**: NPM 배포 실행
-5. **notify**: 결과 알림
-
-### 트리거 조건
-```yaml
-on:
-  push:
-    branches: [main]        # main 브랜치 직접 push
-    tags: ["v*"]           # 태그 push
-  workflow_run:
-    workflows: ["Continuous Integration"]
-    types: [completed]      # CI 완료 후
-    branches: [main]
-```
-
-## 📊 배포 시나리오
-
-### 시나리오 1: 첫 PR merge
-```
-현재 NPM: v1.0.5
-현재 코드: v1.0.5
-→ 자동으로 v1.0.6으로 업데이트 후 배포
-```
-
-### 시나리오 2: 이미 다른 버전인 경우
-```
-현재 NPM: v1.0.5  
-현재 코드: v1.0.6
-→ 버전 업데이트 없이 v1.0.6 즉시 배포
-```
-
-### 시나리오 3: 태그 기반 배포
-```
-태그 push: v1.1.0
-→ 버전 체크만 하고 즉시 배포
-```
-
-## 🚨 주의사항
-
-### 1. 권한 설정
-- GitHub Actions에 repository write 권한 필요
-- NPM 토큰이 올바르게 설정되어야 함
-
-### 2. 커밋 메시지 규칙
-- Conventional Commits 형식 권장
-- 명확하고 일관된 메시지 작성
-
-### 3. CI/CD 최적화  
-- `[skip ci]` 태그로 무한 루프 방지
-- 버전 업데이트 커밋은 자동으로 CI 건너뛰기
-
-## 🎉 장점
-
-### ✅ 완전 자동화
-- 수동 버전 관리 불필요
-- 실수 방지 및 일관성 보장
-
-### ✅ Semantic Versioning 준수
-- 커밋 메시지 기반 자동 버전 결정
-- 표준화된 버전 관리
-
-### ✅ 실시간 알림
-- Discord 및 콘솔 배포 상태 알림
-- 성공/실패 즉시 확인
-
-## 🔍 디버깅
-
-### 로그 확인 위치
-- GitHub Actions → 해당 워크플로우 실행 → 각 작업 로그
-
-### 일반적인 문제들
-1. **NPM 토큰 오류**: Secrets 설정 확인
-2. **버전 충돌**: NPM에서 같은 버전 이미 배포됨
-3. **빌드 실패**: TypeScript 컴파일 오류 확인
-4. **권한 오류**: GitHub token 권한 확인
-
-이제 PR만 merge하면 자동으로 버전이 업데이트되고 NPM에 배포됩니다! 🚀

package/docs/deployment.md

@@ -1,82 +0,0 @@
-# 배포 가이드
-
-## CI/CD 파이프라인
-
-이 프로젝트는 모듈화된 GitHub Actions를 사용한 자동 배포 시스템을 구축했습니다.
-
-> 📖 **워크플로우 구조**: 자세한 내용은 [docs/workflows.md](./workflows.md)를 참고해주세요.
-
-### 트리거 조건
-
-#### 1. Pull Request
-
-- `main` 브랜치로의 PR 시 테스트와 빌드만 실행
-- Node.js와 Bun 두 환경에서 모두 테스트
-
-#### 2. Main 브랜치 Push
-
-- `main` 브랜치에 직접 push 시
-- 버전이 변경된 경우에만 NPM에 자동 배포
-- package.json의 버전과 NPM에 이미 배포된 버전을 비교
-
-#### 3. 태그 Push
-
-- `v*` 형태의 태그 push 시 무조건 NPM에 배포
-- 예: `v1.0.5`, `v2.1.0`
-
-### 배포 워크플로우
-
-```mermaid
-graph LR
-    A[Code Push] --> B{브랜치 확인}
-    B -->|main| C[버전 체크]
-    B -->|태그| F[즉시 배포]
-    C -->|변경됨| D[테스트 & 빌드]
-    C -->|동일함| E[배포 스킵]
-    D --> F[NPM 배포]
-```
-
-### 수동 배포 방법
-
-#### 1. 버전 업데이트 후 main 브랜치 배포
-
-```bash
-# 버전 업데이트
-npm version patch  # 또는 minor, major
-
-# main 브랜치에 push (자동 배포됨)
-git push origin main
-```
-
-#### 2. 태그를 통한 배포
-
-```bash
-# 버전 업데이트
-npm version patch
-
-# 태그와 함께 push (즉시 배포됨)
-git push origin main --tags
-```
-
-### 환경 변수 설정
-
-GitHub Repository Settings에서 다음 Secret을 설정해야 합니다:
-
-- `NPM_TOKEN`: NPM 계정의 액세스 토큰
-
-### 지원 런타임
-
-- **Node.js 20.x**: 메인 런타임
-- **Bun Latest**: 성능 테스트 및 대안 빌드
-
-### 빌드 산출물
-
-- TypeScript 컴파일된 JavaScript 파일들
-- 타입 정의 파일 (.d.ts)
-- 소스맵 파일
-
-### 주의사항
-
-1. **버전 관리**: package.json의 버전을 먼저 업데이트해야 배포됩니다
-2. **테스트 통과**: 모든 테스트가 통과해야 배포가 진행됩니다
-3. **권한**: NPM_TOKEN이 올바르게 설정되어야 합니다

package/docs/development.md

@@ -1,394 +0,0 @@
-# 개발 가이드
-
-## 개발 환경 요구사항
-
-### 필수 요구사항
-
-- **Node.js**: 18.x 이상
-- **Bun**: 최신 버전 (권장)
-- **Git**: 버전 관리
-- **에디터**: VS Code 또는 기타 TypeScript 지원 에디터
-
-### Bun 설치
-
-```bash
-# macOS/Linux
-curl -fsSL https://bun.sh/install | bash
-
-# Windows (PowerShell)
-powershell -c "irm bun.sh/install.ps1 | iex"
-
-# 또는 npm을 통해
-npm install -g bun
-```
-
-## 프로젝트 설정
-
-### 1. 저장소 클론
-
-```bash
-git clone https://github.com/alstjd0051/npm_readMe.git
-cd npm_readMe
-```
-
-### 2. 의존성 설치
-
-```bash
-# Bun 사용 (권장)
-bun install
-
-# 또는 npm 사용
-npm install
-```
-
-### 3. 개발 서버 실행
-
-```bash
-# Bun으로 직접 실행
-bun run dev:bun
-
-# 또는 tsx 사용
-bun run dev
-```
-
-## 프로젝트 구조
-
-```
-npm_readMe/
-├── .github/
-│   └── workflows/          # GitHub Actions 워크플로우
-│       ├── ci.yml          # 지속적 통합
-│       └── publish.yml     # NPM 배포
-├── docs/                   # 문서
-│   ├── testing.md          # 테스트 가이드
-│   ├── pipeline.md         # CI/CD 파이프라인
-│   ├── development.md      # 개발 가이드 (이 파일)
-│   └── ...
-├── src/
-│   └── index.ts            # 메인 소스 코드
-├── test/
-│   └── index.test.ts       # 테스트 파일
-├── dist/                   # 빌드 출력 (gitignore)
-├── .eslintrc.json          # ESLint 설정
-├── .prettierrc             # Prettier 설정
-├── .editorconfig           # 에디터 설정
-├── .gitignore              # Git ignore 규칙
-├── vitest.config.ts        # Vitest 설정
-├── tsconfig.json           # TypeScript 설정
-├── bunfig.toml             # Bun 설정
-├── package.json            # 패키지 정보
-└── README.md               # 프로젝트 README
-```
-
-## 개발 워크플로우
-
-### 1. 기능 개발
-
-```bash
-# 1. 새 브랜치 생성
-git checkout -b feature/new-feature
-
-# 2. 코드 작성
-# src/index.ts 수정
-
-# 3. 타입 체크
-bun run typecheck
-
-# 4. 린트
-bun run lint:fix
-
-# 5. 테스트 작성 및 실행
-# test/index.test.ts 작성
-bun run test
-
-# 6. 로컬 테스트
-bun run dev:bun
-
-# 7. 커밋
-git add .
-git commit -m "feat: 새 기능 추가"
-
-# 8. 푸시 및 PR 생성
-git push origin feature/new-feature
-```
-
-### 2. 버그 수정
-
-```bash
-# 1. 버그 재현 테스트 작성
-# test/index.test.ts에 실패하는 테스트 추가
-
-# 2. 코드 수정
-# src/index.ts 수정
-
-# 3. 테스트 통과 확인
-bun run test
-
-# 4. 커밋
-git commit -m "fix: 버그 수정"
-```
-
-## 코드 스타일 가이드
-
-### TypeScript 규칙
-
-1. **타입 명시**
-   ```typescript
-   // ✅ 좋은 예
-   const openUrl = (url: string): void => {
-     // ...
-   };
-
-   // ❌ 나쁜 예
-   const openUrl = (url) => {
-     // ...
-   };
-   ```
-
-2. **인터페이스 정의**
-   ```typescript
-   // ✅ 좋은 예
-   interface UserAnswer {
-     showInfo: boolean;
-   }
-
-   // ❌ 나쁜 예
-   type UserAnswer = {
-     showInfo: boolean;
-   };  // 객체 타입에는 interface 선호
-   ```
-
-3. **에러 핸들링**
-   ```typescript
-   // ✅ 좋은 예
-   try {
-     // 위험한 작업
-   } catch (error) {
-     if (error instanceof Error) {
-       console.error(error.message);
-     }
-   }
-
-   // ❌ 나쁜 예
-   try {
-     // 위험한 작업
-   } catch (error) {
-     console.error(error);  // 타입 체크 없음
-   }
-   ```
-
-### 네이밍 컨벤션
-
-- **변수/함수**: camelCase (`openUrl`, `getUserInfo`)
-- **타입/인터페이스**: PascalCase (`UserAnswer`, `ProgramOptions`)
-- **상수**: UPPER_SNAKE_CASE (`MAX_RETRIES`, `DEFAULT_TIMEOUT`)
-- **파일명**: kebab-case (`index.ts`, `user-utils.ts`)
-
-### 코드 포맷팅
-
-Prettier가 자동으로 처리하지만, 기본 규칙:
-
-- **들여쓰기**: 2 스페이스
-- **세미콜론**: 사용
-- **따옴표**: 쌍따옴표 (")
-- **줄 길이**: 80자
-- **후행 쉼표**: ES5 호환
-
-## 테스트 작성
-
-### 단위 테스트
-
-```typescript
-import { describe, it, expect } from 'vitest';
-
-describe('함수명', () => {
-  it('특정 조건에서 기대되는 동작을 해야 함', () => {
-    // Arrange
-    const input = 'test';
-    
-    // Act
-    const result = someFunction(input);
-    
-    // Assert
-    expect(result).toBe('expected');
-  });
-});
-```
-
-### 통합 테스트
-
-```typescript
-describe('CLI 통합 테스트', () => {
-  it('전체 플로우가 정상 작동해야 함', async () => {
-    // CLI 실행 시뮬레이션
-    // 여러 컴포넌트 통합 테스트
-  });
-});
-```
-
-## 디버깅
-
-### VS Code 디버깅 설정
-
-`.vscode/launch.json` 생성:
-
-```json
-{
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Debug TypeScript",
-      "runtimeExecutable": "bun",
-      "runtimeArgs": ["run", "src/index.ts"],
-      "skipFiles": ["<node_internals>/**"]
-    }
-  ]
-}
-```
-
-### 콘솔 디버깅
-
-```typescript
-// 개발 중에만 사용
-console.log(chalk.gray('[DEBUG]'), variableName);
-```
-
-## 빌드 및 배포
-
-### 로컬 빌드
-
-```bash
-# TypeScript 컴파일러 사용
-bun run build
-
-# Bun 번들러 사용 (더 빠름)
-bun run build:bun
-
-# 빌드 결과 확인
-ls -la dist/
-```
-
-### 로컬에서 패키지 테스트
-
-```bash
-# 1. 전역 링크 생성
-npm link
-
-# 2. CLI 실행 테스트
-tylersong
-
-# 3. 테스트 완료 후 링크 제거
-npm unlink -g tylersong
-```
-
-### 버전 배포
-
-```bash
-# 1. 변경사항 커밋
-git add .
-git commit -m "feat: 새 기능"
-
-# 2. 버전 업데이트
-npm version patch  # 1.0.9 → 1.0.10
-
-# 3. 푸시 (태그 포함)
-git push origin main --tags
-
-# 4. GitHub Actions가 자동으로 NPM에 배포
-```
-
-## 품질 체크리스트
-
-배포 전 확인사항:
-
-- [ ] 모든 테스트 통과 (`bun run test`)
-- [ ] 린트 오류 없음 (`bun run lint`)
-- [ ] 타입 체크 통과 (`bun run typecheck`)
-- [ ] 빌드 성공 (`bun run build`)
-- [ ] 로컬에서 CLI 정상 작동 (`bun run dev:bun`)
-- [ ] 문서 업데이트 (필요시)
-- [ ] CHANGELOG 업데이트 (필요시)
-
-## 문제 해결
-
-### Bun 관련 문제
-
-```bash
-# Bun 재설치
-curl -fsSL https://bun.sh/install | bash
-
-# 캐시 삭제
-rm -rf ~/.bun/install/cache
-bun install
-```
-
-### 의존성 문제
-
-```bash
-# lockfile 삭제 후 재설치
-rm -f bun.lock package-lock.json
-bun install
-```
-
-### TypeScript 오류
-
-```bash
-# node_modules 재설치
-rm -rf node_modules
-bun install
-
-# tsconfig.json 확인
-bun run typecheck
-```
-
-## 기여 가이드
-
-1. **이슈 생성**: 버그 리포트 또는 기능 제안
-2. **브랜치 생성**: `feature/`, `fix/`, `docs/` 접두사 사용
-3. **커밋 메시지**: [Conventional Commits](https://www.conventionalcommits.org/) 형식
-   - `feat:` - 새 기능
-   - `fix:` - 버그 수정
-   - `docs:` - 문서 변경
-   - `test:` - 테스트 추가/수정
-   - `refactor:` - 리팩토링
-   - `style:` - 코드 스타일 변경
-   - `chore:` - 기타 변경사항
-4. **Pull Request**: 명확한 설명과 함께 제출
-5. **코드 리뷰**: 피드백 반영
-
-## 유용한 명령어 모음
-
-```bash
-# 개발
-bun run dev:bun              # 개발 모드 실행
-
-# 테스트
-bun run test                 # 테스트 실행
-bun run test:watch           # 테스트 감시
-bun run test:coverage        # 커버리지 포함
-
-# 코드 품질
-bun run lint                 # 린트 검사
-bun run lint:fix             # 린트 자동 수정
-bun run format               # 코드 포맷팅
-bun run typecheck            # 타입 체크
-
-# 빌드
-bun run build                # TypeScript 빌드
-bun run build:bun            # Bun 빌드
-
-# 실행
-bun run start                # 빌드된 파일 실행
-bun run start:bun            # Bun으로 실행
-```
-
-## 추가 리소스
-
-- [Bun 공식 문서](https://bun.sh/docs)
-- [TypeScript 핸드북](https://www.typescriptlang.org/docs/)
-- [Vitest 가이드](https://vitest.dev/guide/)
-- [ESLint 규칙](https://eslint.org/docs/rules/)
-- [Prettier 옵션](https://prettier.io/docs/en/options.html)
-