tylersong 1.0.9 → 1.0.11

package/docs/testing.md

@@ -0,0 +1,173 @@
+# 테스트 가이드
+
+## 개요
+
+이 프로젝트는 **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

@@ -0,0 +1,112 @@
+# 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

@@ -0,0 +1,176 @@
+# 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 패키지명 중복 확인
+
+이 구조를 통해 각 워크플로우의 책임이 명확히 분리되어 유지보수가 쉬워집니다.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tylersong",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "나의 CLI 자기소개 도구",
   "main": "dist/index.js",
   "bin": {
@@ -19,7 +19,14 @@
     "dev:bun": "bun run src/index.ts",
     "start": "node dist/index.js",
     "start:bun": "bun run dist/index.js",
-    "test": "echo \"No test specified\"",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src test --ext .ts",
+    "lint:fix": "eslint src test --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
+    "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
@@ -31,8 +38,14 @@
     "@types/chalk": "^0.4.31",
     "@types/inquirer": "^9.0.8",
     "@types/node": "^24.1.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "@vitest/coverage-v8": "^1.3.1",
+    "eslint": "^8.56.0",
+    "prettier": "^3.2.5",
     "ts-node": "^10.9.2",
     "tsx": "^4.20.3",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "vitest": "^1.3.1"
   }
 }

package/src/index.ts

@@ -4,6 +4,9 @@ import inquirer from "inquirer";
 import chalk from "chalk";
 import { program } from "commander";
 import { exec } from "child_process";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+import { dirname, join } from "path";
 
 interface ProgramOptions {
   github?: boolean;
@@ -13,6 +16,28 @@ interface UserAnswer {
   showInfo: boolean;
 }
 
+interface PackageJson {
+  version: string;
+  name: string;
+  description: string;
+}
+
+// package.json에서 버전 동적으로 읽기
+const getPackageVersion = (): string => {
+  try {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = dirname(__filename);
+    const packagePath = join(__dirname, "..", "package.json");
+    const packageJson = JSON.parse(
+      readFileSync(packagePath, "utf-8")
+    ) as PackageJson;
+    return packageJson.version;
+  } catch (error) {
+    console.error(chalk.red("⚠️  버전 정보를 읽을 수 없습니다."));
+    return "1.0.0";
+  }
+};
+
 const openUrl = (url: string): void => {
   const command: string =
     process.platform === "win32"
@@ -20,10 +45,16 @@ const openUrl = (url: string): void => {
       : process.platform === "darwin"
       ? "open"
       : "xdg-open";
-  exec(`${command} ${url}`);
+  
+  exec(`${command} ${url}`, (error) => {
+    if (error) {
+      console.error(chalk.red("❌ 브라우저를 열 수 없습니다."));
+      console.error(chalk.yellow(`수동으로 방문해주세요: ${url}`));
+    }
+  });
 };
 
-program.version("1.0.9");
+program.version(getPackageVersion());
 
 program.option("-g, --github", "GitHub 프로필 열기");
 
@@ -37,10 +68,11 @@ if (Object.keys(options).length > 0) {
 }
 
 const main = async (): Promise<void> => {
-  // 도움말 옵션 체크
-  if (process.argv.includes("--help")) {
-    console.log(
-      chalk.yellow(`
+  try {
+    // 도움말 옵션 체크
+    if (process.argv.includes("--help")) {
+      console.log(
+        chalk.yellow(`
       ╭───────────────────────────────╮
       │         사용 방법             │
       ├───────────────────────────────┤
@@ -52,45 +84,58 @@ const main = async (): Promise<void> => {
       │   -h, --help     도움말       │
       ╰───────────────────────────────╯
     `)
-    );
-    process.exit(0);
-  }
+      );
+      process.exit(0);
+    }
+
+    // 사용자 질문
+    const answer: UserAnswer = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "showInfo",
+        message: chalk.cyan("✨ 저에 대해 궁금하신가요?"),
+        default: true,
+      },
+    ]);
 
-  // 사용자 질문
-  const answer: UserAnswer = await inquirer.prompt([
-    {
-      type: "confirm",
-      name: "showInfo",
-      message: chalk.cyan("✨ 저에 대해 궁금하신가요?"),
-      default: true,
-    },
-  ]);
-
-  if (answer.showInfo) {
-    console.log(
-      chalk.bold.cyan(`
+    if (answer.showInfo) {
+      console.log(
+        chalk.bold.cyan(`
       ╭───────────────────────────────────────────╮
       │    🚀 Developer Profile 🚀      │
       ╰───────────────────────────────────────────╯
       
       `) +
-        chalk.green(`👋 안녕하세요!
+          chalk.green(`👋 안녕하세요!
       💻 개발자 ${chalk.bold.yellow("송민성")}입니다.
 
       `) +
-        chalk.hex("#fef6e1")(`📌 Github: ${chalk.underline.whiteBright(
-          `https://github.com/alstjd0051`
-        )}
+          chalk.hex("#fef6e1")(`📌 Github: ${chalk.underline.whiteBright(
+            `https://github.com/alstjd0051`
+          )}
       `) +
-        chalk.blue(`✉️  E-mail: ${chalk.underline.whiteBright(
-          `wsc7202@gmail.com`
-        )}
+          chalk.blue(`✉️  E-mail: ${chalk.underline.whiteBright(
+            `wsc7202@gmail.com`
+          )}
       `) +
-        chalk.magenta(`
+          chalk.magenta(`
       💡 더 많은 정보는 ${chalk.bold("--help")}를 통해 확인해주세요.
       `)
-    );
+      );
+    }
+  } catch (error) {
+    console.error(chalk.red("\n❌ 오류가 발생했습니다:"));
+    if (error instanceof Error) {
+      console.error(chalk.yellow(error.message));
+    } else {
+      console.error(chalk.yellow("알 수 없는 오류가 발생했습니다."));
+    }
+    process.exit(1);
   }
 };
 
-main().catch(console.error);
+main().catch((error) => {
+  console.error(chalk.red("\n❌ 치명적인 오류가 발생했습니다:"));
+  console.error(error);
+  process.exit(1);
+});