tylersong 1.0.11 → 1.0.12

package/docs/pipeline.md

@@ -1,228 +0,0 @@
-# CI/CD 파이프라인
-
-## 개요
-
-이 프로젝트는 GitHub Actions를 사용하여 자동화된 CI/CD 파이프라인을 구축했습니다. 모든 코드 변경사항은 자동으로 테스트되고, 검증되며, 배포됩니다.
-
-## 파이프라인 아키텍처
-
-```mermaid
-graph LR
-    A[코드 푸시] --> B{이벤트 타입}
-    B -->|Push/PR| C[CI 워크플로우]
-    B -->|Tag Push| D[Publish 워크플로우]
-    
-    C --> E[코드 체크아웃]
-    E --> F[Bun 설치]
-    F --> G[의존성 설치]
-    G --> H[타입 체크]
-    H --> I[린트 실행]
-    I --> J[테스트 실행]
-    J --> K[빌드]
-    K --> L{성공?}
-    L -->|Yes| M[✅ 완료]
-    L -->|No| N[❌ 실패]
-    
-    D --> O[코드 체크아웃]
-    O --> P[Bun + Node.js 설치]
-    P --> Q[의존성 설치]
-    Q --> R[테스트 + 린트]
-    R --> S[빌드]
-    S --> T[NPM 배포]
-    T --> U{성공?}
-    U -->|Yes| V[✅ 배포 완료]
-    U -->|No| W[❌ 배포 실패]
-```
-
-## CI 워크플로우 (`.github/workflows/ci.yml`)
-
-### 트리거 조건
-
-- `main`, `develop` 브랜치에 푸시
-- `main`, `develop` 브랜치로의 Pull Request
-
-### 실행 단계
-
-1. **테스트 & 린트 작업**
-   - Node.js 18.x, 20.x 매트릭스 테스트
-   - Bun을 사용한 빠른 의존성 설치
-   - 타입 체크 (TypeScript)
-   - ESLint를 통한 코드 품질 검사
-   - Vitest를 통한 단위/통합 테스트
-   - Codecov에 커버리지 업로드
-
-2. **빌드 작업**
-   - Bun 빌드 시스템 사용
-   - 빌드 결과물을 아티팩트로 저장
-
-### 예시 실행 시간
-
-- **의존성 설치**: ~10초 (캐시 사용 시 ~2초)
-- **타입 체크**: ~5초
-- **린트**: ~3초
-- **테스트**: ~5초
-- **빌드**: ~3초
-- **총 소요 시간**: ~30초
-
-## Publish 워크플로우 (`.github/workflows/publish.yml`)
-
-### 트리거 조건
-
-- `v*` 패턴의 태그 푸시 (예: `v1.0.10`, `v2.0.0`)
-
-### 실행 단계
-
-1. **코드 검증**
-   - 테스트 실행
-   - 린트 검사
-   - TypeScript 빌드
-
-2. **NPM 배포**
-   - NPM provenance 활성화 (보안 강화)
-   - Public 접근 권한으로 배포
-   - NPM 토큰을 사용한 인증
-
-### 필요한 Secrets
-
-GitHub Repository Settings → Secrets에서 설정:
-
-- `NPM_TOKEN`: NPM 배포를 위한 인증 토큰
-
-## 로컬에서 파이프라인 시뮬레이션
-
-CI/CD 파이프라인과 동일한 검증을 로컬에서 실행:
-
-```bash
-# 1. 타입 체크
-bun run typecheck
-
-# 2. 린트
-bun run lint
-
-# 3. 테스트
-bun run test
-
-# 4. 빌드
-bun run build:bun
-
-# 또는 모든 검증을 한 번에
-bun run typecheck && bun run lint && bun run test && bun run build:bun
-```
-
-## 배포 프로세스
-
-### 1. 버전 업데이트
-
-```bash
-# 패치 버전 (1.0.9 → 1.0.10)
-npm version patch
-
-# 마이너 버전 (1.0.9 → 1.1.0)
-npm version minor
-
-# 메이저 버전 (1.0.9 → 2.0.0)
-npm version major
-```
-
-### 2. 태그 푸시
-
-```bash
-# package.json 변경사항과 태그를 함께 푸시
-git push origin main --tags
-```
-
-### 3. 자동 배포
-
-- GitHub Actions가 자동으로 태그를 감지
-- Publish 워크플로우 실행
-- 테스트/린트/빌드 검증
-- NPM에 자동 배포
-
-## 파이프라인 모니터링
-
-### GitHub Actions 대시보드
-
-1. Repository → Actions 탭
-2. 워크플로우 실행 상태 확인
-3. 실패 시 로그 확인 및 디버깅
-
-### 배지 추가 (README.md)
-
-```markdown
-![CI](https://github.com/alstjd0051/npm_readMe/workflows/CI/badge.svg)
-![NPM Version](https://img.shields.io/npm/v/tylersong)
-![Test Coverage](https://codecov.io/gh/alstjd0051/npm_readMe/branch/main/graph/badge.svg)
-```
-
-## 최적화 전략
-
-### 1. 캐싱
-
-- Bun 의존성 캐시로 설치 시간 단축
-- Node.js 모듈 캐시
-
-### 2. 병렬 실행
-
-- 매트릭스 전략으로 여러 Node 버전 동시 테스트
-- 독립적인 작업들을 병렬로 실행
-
-### 3. 조건부 실행
-
-- 변경된 파일에 따라 선택적 워크플로우 실행
-- 캐시 히트 시 불필요한 단계 스킵
-
-## 보안 고려사항
-
-### 1. Secrets 관리
-
-- NPM 토큰은 절대 코드에 포함하지 않음
-- GitHub Secrets에 안전하게 저장
-
-### 2. Provenance
-
-- NPM provenance로 패키지 출처 증명
-- 공급망 공격 방지
-
-### 3. 권한 최소화
-
-- 워크플로우별 최소 권한만 부여
-- `id-token: write`로 OIDC 인증
-
-## 문제 해결
-
-### CI 실패 시
-
-1. **테스트 실패**
-   - 로컬에서 `bun run test` 실행
-   - 실패한 테스트 케이스 확인 및 수정
-
-2. **린트 실패**
-   - `bun run lint:fix`로 자동 수정
-   - 남은 문제 수동 수정
-
-3. **빌드 실패**
-   - TypeScript 오류 확인
-   - `bun run typecheck` 실행
-
-### 배포 실패 시
-
-1. **NPM 토큰 확인**
-   - Secrets에 `NPM_TOKEN` 존재 여부
-   - 토큰 만료 여부 확인
-
-2. **권한 문제**
-   - NPM 계정에 패키지 배포 권한 확인
-   - 2FA 설정 확인
-
-3. **버전 중복**
-   - 같은 버전을 다시 배포할 수 없음
-   - 새로운 버전 번호 사용
-
-## 향후 개선 계획
-
-- [ ] E2E 테스트 추가
-- [ ] 성능 테스트 자동화
-- [ ] 자동 changelog 생성
-- [ ] Slack/Discord 배포 알림
-- [ ] 스테이징 환경 배포 단계 추가
-

package/docs/testing.md

@@ -1,173 +0,0 @@
-# 테스트 가이드
-
-## 개요
-
-이 프로젝트는 **Vitest**를 사용하여 TypeScript 코드를 테스트합니다. Vitest는 빠르고 현대적인 테스트 프레임워크로, Vite 기반의 빠른 실행 속도와 훌륭한 TypeScript 지원을 제공합니다.
-
-## 테스트 실행
-
-### Bun 사용 (권장)
-
-```bash
-# 모든 테스트 실행
-bun run test
-
-# 테스트 감시 모드 (파일 변경 시 자동 재실행)
-bun run test:watch
-
-# 커버리지와 함께 테스트 실행
-bun run test:coverage
-```
-
-### NPM 사용
-
-```bash
-# 모든 테스트 실행
-npm test
-
-# 테스트 감시 모드
-npm run test:watch
-
-# 커버리지와 함께 테스트 실행
-npm run test:coverage
-```
-
-## 테스트 구조
-
-### 테스트 파일 위치
-
-```
-test/
-├── index.test.ts          # 메인 CLI 기능 테스트
-└── (추가 테스트 파일들)
-```
-
-### 테스트 커버리지
-
-테스트 커버리지는 다음 영역을 포함합니다:
-
-1. **단위 테스트**
-   - `openUrl` 함수 - URL 열기 기능
-   - `getPackageVersion` 함수 - 버전 정보 읽기
-   - 타입 정의 검증
-
-2. **통합 테스트**
-   - CLI 옵션 처리
-   - 사용자 인터랙션
-   - 에러 핸들링
-
-3. **플랫폼 테스트**
-   - Windows, macOS, Linux 명령어 검증
-
-## 테스트 작성 가이드
-
-### 기본 구조
-
-```typescript
-import { describe, it, expect, vi } from 'vitest';
-
-describe('테스트 그룹 이름', () => {
-  it('테스트 케이스 설명', () => {
-    // 준비 (Arrange)
-    const input = 'test';
-    
-    // 실행 (Act)
-    const result = someFunction(input);
-    
-    // 검증 (Assert)
-    expect(result).toBe('expected');
-  });
-});
-```
-
-### 모킹 (Mocking)
-
-외부 의존성은 모킹하여 테스트합니다:
-
-```typescript
-vi.mock('child_process', () => ({
-  exec: vi.fn(),
-}));
-
-vi.mock('chalk', () => ({
-  default: {
-    red: vi.fn((str) => str),
-    // 기타 chalk 메서드들
-  },
-}));
-```
-
-## CI/CD 통합
-
-GitHub Actions를 통해 자동으로 테스트가 실행됩니다:
-
-- **Pull Request**: 모든 PR에서 테스트 실행
-- **Main 브랜치 푸시**: 빌드 및 테스트 검증
-- **테스트 실패**: 머지 방지
-
-## 커버리지 목표
-
-- **라인 커버리지**: 80% 이상
-- **함수 커버리지**: 80% 이상
-- **브랜치 커버리지**: 70% 이상
-
-## 모범 사례
-
-1. **테스트 이름은 명확하게**
-   - ✅ `'macOS에서 open 명령어를 사용해야 함'`
-   - ❌ `'테스트 1'`
-
-2. **하나의 테스트는 하나의 것만 검증**
-   ```typescript
-   // ✅ 좋은 예
-   it('URL 형식이 올바른지 검증', () => {
-     expect(url).toMatch(/^https:\/\//);
-   });
-   
-   // ❌ 나쁜 예
-   it('URL과 이메일 검증', () => {
-     expect(url).toMatch(/^https:\/\//);
-     expect(email).toMatch(/@/);
-   });
-   ```
-
-3. **테스트 독립성 유지**
-   - 각 테스트는 독립적으로 실행 가능해야 함
-   - `beforeEach`로 초기화, `afterEach`로 정리
-
-4. **에러 케이스도 테스트**
-   ```typescript
-   it('잘못된 입력에 대해 에러를 발생시켜야 함', () => {
-     expect(() => someFunction(null)).toThrow();
-   });
-   ```
-
-## 문제 해결
-
-### 테스트가 실행되지 않을 때
-
-1. 의존성 설치 확인
-   ```bash
-   bun install
-   ```
-
-2. TypeScript 컴파일 확인
-   ```bash
-   bun run typecheck
-   ```
-
-3. Vitest 설정 확인
-   - `vitest.config.ts` 파일 존재 여부
-   - 테스트 파일 경로 확인
-
-### 모킹이 작동하지 않을 때
-
-1. `vi.mock()`이 import 문 앞에 있는지 확인
-2. 모킹된 모듈의 경로가 정확한지 확인
-3. `vi.clearAllMocks()` 사용하여 초기화
-
-## 추가 리소스
-
-- [Vitest 공식 문서](https://vitest.dev/)
-- [Testing Best Practices](https://github.com/goldbergyoni/javascript-testing-best-practices)
-

package/docs/usage.md

@@ -1,112 +0,0 @@
-# tylersong CLI 사용법
-
-## 설치
-
-NPX를 통해 바로 실행할 수 있습니다:
-
-```bash
-npx tylersong
-```
-
-## 옵션
-
-### 기본 사용법
-
-```bash
-npx tylersong
-```
-
-인터랙티브 모드로 개발자 프로필 정보를 확인할 수 있습니다.
-
-### 명령어 옵션
-
-- `-V, --version`: 버전 정보 출력
-- `-g, --github`: GitHub 프로필을 브라우저에서 바로 열기
-- `-h, --help`: 도움말 출력
-
-### 예시
-
-```bash
-# 버전 확인
-npx tylersong --version
-
-# GitHub 프로필 열기
-npx tylersong --github
-
-# 도움말 보기
-npx tylersong --help
-```
-
-## 개발
-
-### TypeScript로 개발
-
-#### NPM 사용
-
-```bash
-# 의존성 설치
-npm install
-
-# 개발 모드 실행
-npm run dev
-
-# 빌드
-npm run build
-
-# 빌드된 파일 실행
-npm start
-```
-
-#### Bun 사용 (더 빠른 성능!)
-
-```bash
-# 의존성 설치
-bun install
-
-# 개발 모드 실행 (TypeScript 직접 실행)
-bun run dev:bun
-
-# 빌드 (bun 번들러 사용)
-bun run build:bun
-
-# 빌드된 파일 실행
-bun run start:bun
-
-# 또는 TypeScript 소스를 직접 실행
-bun run src/index.ts
-```
-
-### 프로젝트 구조
-
-```
-tylersong/
-├── src/
-│   └── index.ts        # 메인 TypeScript 소스 파일
-├── dist/               # 빌드된 JavaScript 파일들
-├── docs/               # 문서 파일들
-├── package.json        # 패키지 설정
-└── tsconfig.json       # TypeScript 설정
-```
-
-## 기능
-
-- 🚀 개발자 프로필 정보 표시
-- 💻 GitHub 프로필 바로 열기
-- ✨ 터미널에서 색상과 아이콘으로 꾸며진 출력
-- 📧 이메일 연락처 정보 제공
-
-## 배포
-
-자세한 배포 가이드는 [docs/deployment.md](./deployment.md)를 참고해주세요.
-
-### 빠른 배포
-
-```bash
-# 패치 버전 업데이트 후 자동 배포
-npm version patch
-git push origin main
-
-# 또는 태그와 함께 즉시 배포
-npm version patch
-git push origin main --tags
-```

package/docs/workflows.md

@@ -1,176 +0,0 @@
-# GitHub Actions 워크플로우 가이드
-
-이 프로젝트는 모듈화된 GitHub Actions 워크플로우를 사용합니다.
-
-## 📁 워크플로우 구조
-
-```
-.github/
-├── actions/
-│   └── setup-runtime/        # 재사용 가능한 컴포지트 액션
-│       └── action.yml
-└── workflows/
-    ├── ci.yml               # 지속적 통합 (테스트, 빌드, 린팅)
-    └── publish.yml          # NPM 배포
-```
-
-## 🔄 워크플로우 설명
-
-### 1. Continuous Integration (ci.yml)
-
-**트리거:**
-
-- `main`, `develop` 브랜치로의 push
-- `main`, `develop` 브랜치로의 pull request
-
-**작업:**
-
-- **test**: Node.js와 Bun 환경에서 테스트 실행
-- **build**: TypeScript 빌드 및 아티팩트 업로드
-- **lint**: 코드 품질 검사, 타입 체크, 보안 감사
-
-### 2. Publish to NPM (publish.yml)
-
-**트리거:**
-
-- `main` 브랜치로의 push
-- `v*` 형태의 태그 push
-- CI 워크플로우 완료 후 (workflow_run)
-
-**작업:**
-
-- **check-ci**: CI 워크플로우 성공 여부 확인
-- **version-check**: 버전 변경 사항 확인
-- **publish**: NPM에 패키지 배포
-- **notify**: 배포 결과 알림
-
-## 🔧 재사용 가능한 액션
-
-### setup-runtime
-
-Node.js 또는 Bun 런타임 환경을 설정하고 의존성을 설치합니다.
-
-**입력:**
-
-- `runtime`: 'node' 또는 'bun'
-- `node-version`: Node.js 버전 (기본: '20.x')
-- `bun-version`: Bun 버전 (기본: 'latest')
-
-**사용 예:**
-
-```yaml
-- name: Setup runtime environment
-  uses: ./.github/actions/setup-runtime
-  with:
-    runtime: node
-```
-
-### discord-notify
-
-Discord 웹후크를 통해 알림을 전송합니다.
-
-**입력:**
-
-- `webhook-url`: Discord 웹후크 URL (필수)
-- `status`: 워크플로우 상태 (success/failure/cancelled)
-- `title`: 알림 제목 (필수)
-- `description`: 알림 설명
-- `color`: Embed 색상 (hex, # 제외)
-- `fields`: 추가 필드 (JSON 배열)
-
-**사용 예:**
-
-```yaml
-- name: Send Discord notification
-  uses: ./.github/actions/discord-notify
-  with:
-    webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }}
-    status: success
-    title: "배포 완료!"
-    description: "새 버전이 배포되었습니다."
-```
-
-## 🚀 배포 시나리오
-
-### 자동 배포 (main 브랜치)
-
-1. 코드를 `main` 브랜치에 push
-2. CI 워크플로우 실행 (테스트, 빌드, 린팅)
-3. CI 성공 시 배포 워크플로우 실행
-4. package.json 버전이 NPM과 다르면 자동 배포
-
-### 즉시 배포 (태그)
-
-1. 버전 태그 push (`v1.0.5` 등)
-2. CI와 배포 워크플로우 동시 실행
-3. CI 성공 시 무조건 NPM에 배포
-4. GitHub Release 자동 생성
-
-### Pull Request
-
-1. PR 생성 시 CI 워크플로우만 실행
-2. 테스트, 빌드, 린팅 검사
-3. 배포는 실행되지 않음 (dry-run만)
-
-## 📋 워크플로우 흐름도
-
-```mermaid
-graph TD
-    A[코드 Push/PR] --> B[CI 워크플로우]
-    B --> C{테스트 통과?}
-    C -->|실패| D[❌ 빌드 실패]
-    C -->|성공| E[빌드 & 아티팩트 업로드]
-    E --> F{main 브랜치?}
-    F -->|No| G[✅ CI 완료]
-    F -->|Yes| H[배포 워크플로우]
-    H --> I{버전 변경?}
-    I -->|No| J[⏭️ 배포 스킵]
-    I -->|Yes| K[NPM 배포]
-    K --> L[✅ 배포 완료]
-```
-
-## ⚙️ 환경 설정
-
-### GitHub Secrets
-
-Repository Settings → Secrets and variables → Actions에서 설정:
-
-- `NPM_TOKEN`: NPM 액세스 토큰
-- `DISCORD_WEBHOOK_URL`: Discord 웹후크 URL (선택사항)
-- `GITHUB_TOKEN`: 자동으로 제공됨 (Release 생성용)
-
-> 💬 **Discord 알림**: 자세한 설정은 [Discord 설정 가이드](./discord-setup.md)를 참고하세요.
-
-### GitHub Environment
-
-`production` 환경 설정을 통해 배포 시 추가 보안 검토 가능
-
-## 🔍 모니터링
-
-### CI 상태 확인
-
-- Actions 탭에서 각 워크플로우 실행 상태 확인
-- 실패 시 로그를 통해 문제 진단
-
-### 배포 상태 확인
-
-- NPM: https://www.npmjs.com/package/tylersong
-- GitHub Releases: 태그 배포 시 자동 생성
-- 알림 작업에서 성공/실패 상태 확인
-
-## 🛠️ 트러블슈팅
-
-### CI 실패 시
-
-1. 테스트 실패: 코드 수정 후 재푸시
-2. 빌드 실패: TypeScript 오류 확인
-3. 린팅 실패: 코드 품질 이슈 해결
-
-### 배포 실패 시
-
-1. NPM_TOKEN 확인
-2. package.json 버전 확인
-3. 빌드 아티팩트 존재 확인
-4. NPM 패키지명 중복 확인
-
-이 구조를 통해 각 워크플로우의 책임이 명확히 분리되어 유지보수가 쉬워집니다.