tylersong 1.0.4 → 1.0.5

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,10 +1,10 @@
 {
   "name": "tylersong",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "나의 CLI 자기소개 도구",
-  "main": "index.js",
+  "main": "dist/index.js",
   "bin": {
-    "tylersong": "index.js"
+    "tylersong": "dist/index.js"
   },
   "type": "module",
   "keywords": [
@@ -13,11 +13,26 @@
   "author": "송민성",
   "license": "MIT",
   "scripts": {
-    "test": "echo \"No test specified\""
+    "build": "tsc",
+    "build:bun": "bun build src/index.ts --outdir dist --target node",
+    "dev": "tsx src/index.ts",
+    "dev:bun": "bun run src/index.ts",
+    "start": "node dist/index.js",
+    "start:bun": "bun run dist/index.js",
+    "test": "echo \"No test specified\"",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
     "inquirer": "^12.4.2"
+  },
+  "devDependencies": {
+    "@types/chalk": "^0.4.31",
+    "@types/inquirer": "^9.0.8",
+    "@types/node": "^24.1.0",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.20.3",
+    "typescript": "^5.9.2"
   }
 }

package/{index.js → src/index.ts}

@@ -5,8 +5,16 @@ import chalk from "chalk";
 import { program } from "commander";
 import { exec } from "child_process";
 
-const openUrl = (url) => {
-  const command =
+interface ProgramOptions {
+  github?: boolean;
+}
+
+interface UserAnswer {
+  showInfo: boolean;
+}
+
+const openUrl = (url: string): void => {
+  const command: string =
     process.platform === "win32"
       ? "start"
       : process.platform === "darwin"
@@ -15,20 +23,20 @@ const openUrl = (url) => {
   exec(`${command} ${url}`);
 };
 
-program.version("1.0.3").description("송민성의 개발자 프로필 CLI");
+program.version("1.0.5").description("송민성의 개발자 프로필 CLI");
 
 program.option("-g, --github", "GitHub 프로필 열기");
 
 program.parse(process.argv);
 
-const options = program.opts();
+const options: ProgramOptions = program.opts();
 
 if (Object.keys(options).length > 0) {
   if (options.github) openUrl("https://github.com/alstjd0051");
   process.exit(0);
 }
 
-const main = async () => {
+const main = async (): Promise<void> => {
   // 도움말 옵션 체크
   if (process.argv.includes("--help")) {
     console.log(
@@ -49,7 +57,7 @@ const main = async () => {
   }
 
   // 사용자 질문
-  const answer = await inquirer.prompt([
+  const answer: UserAnswer = await inquirer.prompt([
     {
       type: "confirm",
       name: "showInfo",

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/.github/workflows/npm-publish.yml

@@ -1,48 +0,0 @@
-name: Node.js Package
-
-on:
-  push:
-    branches: [main]
-    tags: ["v*"]
-  pull_request:
-    branches: [main]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "18.x"
-          registry-url: "https://registry.npmjs.org/"
-
-      - name: Install dependencies
-        run: npm ci || npm install
-
-      - name: Run tests
-        run: npm test || true
-
-  publish:
-    needs: build
-    runs-on: ubuntu-latest
-    if: startsWith(github.ref, 'refs/tags/v')
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "18.x"
-          registry-url: "https://registry.npmjs.org/"
-
-      - name: Install dependencies
-        run: npm ci || npm install
-
-      - name: Publish to npm
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}