tylersong 1.0.8 → 1.0.10

package/.cursor/plans/-----------8c733d2f.plan.md

@@ -0,0 +1,158 @@
+<!-- 8c733d2f-63d8-4158-aa6e-255c23deedca 77c7f805-6518-4181-90b0-4dff17016b38 -->
+# 프로젝트 품질 개선 계획
+
+## 📊 현재 프로젝트 분석
+
+### ✅ 장점
+
+1. **깔끔한 코드 구조**: TypeScript 기반의 명확한 단일 파일 구조
+2. **타입 안정성**: TypeScript 사용으로 인터페이스 정의 및 strict 모드 활성화
+3. **Bun 지원**: 최신 런타임 지원으로 성능 최적화 가능
+4. **풍부한 문서화**: docs 폴더에 배포, 사용법 등 상세 문서 작성됨
+5. **사용자 친화적**: Commander.js, Inquirer.js로 직관적인 CLI 경험 제공
+6. **크로스 플랫폼**: Windows, macOS, Linux 모두 지원하는 URL 열기 기능
+
+### ❌ 단점 및 개선 필요 사항
+
+#### 1. **테스트 코드 부재** (Critical)
+
+- 현재 `package.json`에 "No test specified"로 테스트 미구현
+- 사용자 규칙에 따라 Vitest 사용 필요
+
+#### 2. **에러 처리 부족** (High)
+
+- `exec()` 함수의 에러 핸들링 없음
+- URL 열기 실패 시 사용자 피드백 없음
+- 프로미스 거부(rejection) 처리가 `.catch(console.error)`로만 처리
+
+#### 3. **린팅/포맷팅 설정 없음** (Medium)
+
+- ESLint, Prettier 등 코드 품질 도구 미설정
+- 일관된 코드 스타일 관리 어려움
+
+#### 4. **CI/CD 파이프라인 없음** (High)
+
+- docs에 워크플로우 문서는 있으나 실제 `.github/workflows` 폴더 없음
+- 자동 테스트, 빌드, 배포 검증 불가
+
+#### 5. **버전 중복 관리** (Low)
+
+- `package.json`과 `src/index.ts`에 버전이 각각 하드코딩됨
+- 버전 업데이트 시 두 곳을 수정해야 함
+
+#### 6. **Bun 우선 정책 미준수** (Medium)
+
+- `prepublishOnly` 스크립트가 `npm run build` 사용
+- 사용자 규칙에 따라 bun 사용 필요
+
+#### 7. **Git 관리 개선 필요** (Low)
+
+- `.gitignore`에 `dist/`, `*.log` 등 명시 필요
+- `node_modules` 제외 확인 필요
+
+#### 8. **보안 및 의존성 관리** (Medium)
+
+- 의존성 취약점 자동 검사 없음
+- 정기적인 업데이트 메커니즘 부재
+
+#### 9. **환경별 설정 분리 없음** (Low)
+
+- 개인정보(GitHub URL, 이메일)가 하드코딩됨
+- 설정 파일로 분리하면 재사용성 향상
+
+## 🔧 개선 작업 항목
+
+### 1. 테스트 환경 구축 (`test/` 폴더)
+
+- **파일**: `test/index.test.ts`
+- Vitest 설치 및 설정
+- 주요 함수(`openUrl`, `main`) 단위 테스트 작성
+- CLI 옵션별 통합 테스트 작성
+
+### 2. 에러 처리 강화 (`src/index.ts`)
+
+```typescript
+// openUrl 함수 개선
+const openUrl = (url: string): void => {
+  exec(`${command} ${url}`, (error) => {
+    if (error) {
+      console.error(chalk.red('❌ 브라우저를 열 수 없습니다.'));
+    }
+  });
+};
+```
+
+### 3. 린팅/포맷팅 설정
+
+- **파일**: `.eslintrc.json`, `.prettierrc`, `.editorconfig`
+- ESLint + TypeScript 플러그인 설치
+- Prettier 설정
+- pre-commit 훅 설정 (husky)
+
+### 4. CI/CD 파이프라인 구축
+
+- **파일**: `.github/workflows/ci.yml`, `.github/workflows/publish.yml`
+- Pull Request 시 자동 테스트/린트
+- main 브랜치 머지 시 자동 빌드 검증
+- 태그 푸시 시 NPM 자동 배포
+
+### 5. 버전 관리 개선
+
+- `src/index.ts`에서 버전 하드코딩 제거
+- `package.json` 버전을 동적으로 읽어오기
+
+### 6. 프로젝트 설정 개선
+
+- **파일**: `.gitignore`, `vitest.config.ts`
+- Bun 우선 스크립트 수정
+- Git ignore 규칙 추가
+
+### 7. 문서 업데이트
+
+- **파일**: `docs/testing.md`, `docs/development.md`
+- 테스트 실행 방법 문서화
+- 개발 환경 설정 가이드 추가
+- 파이프라인 다이어그램 (Mermaid 그래프)
+
+## 📝 생성/수정될 파일 목록
+
+### 새로 생성
+
+- `test/index.test.ts` - 테스트 코드
+- `vitest.config.ts` - Vitest 설정
+- `.eslintrc.json` - ESLint 설정
+- `.prettierrc` - Prettier 설정
+- `.gitignore` - Git ignore 규칙
+- `.github/workflows/ci.yml` - CI 워크플로우
+- `.github/workflows/publish.yml` - 배포 워크플로우
+- `docs/testing.md` - 테스트 가이드
+- `docs/pipeline.md` - CI/CD 파이프라인 설명 (Mermaid 그래프 포함)
+
+### 수정
+
+- `src/index.ts` - 에러 처리 강화, 버전 동적 로딩
+- `package.json` - 테스트 스크립트 추가, bun 우선 스크립트 수정
+- `README.md` - 테스트, 린팅 배지 추가
+
+## 🎯 우선순위
+
+1. **테스트 환경 구축** (가장 중요)
+2. **에러 처리 강화**
+3. **CI/CD 파이프라인**
+4. **린팅/포맷팅 설정**
+5. **기타 개선 사항**
+
+### To-dos
+
+- [ ] Vitest 설치 및 설정 파일 생성 (vitest.config.ts)
+- [ ] test/index.test.ts 파일 작성 (주요 기능 테스트)
+- [ ] src/index.ts의 에러 처리 강화 (openUrl, main 함수)
+- [ ] ESLint, Prettier 설정 파일 생성
+- [ ] .github/workflows/ci.yml 생성 (테스트, 린트 자동화)
+- [ ] .github/workflows/publish.yml 생성 (NPM 자동 배포)
+- [ ] src/index.ts에서 버전을 package.json에서 동적으로 읽어오기
+- [ ] .gitignore 파일 생성 또는 개선
+- [ ] package.json의 테스트/린트 스크립트 추가, bun 우선 수정
+- [ ] docs/testing.md 문서 작성
+- [ ] docs/pipeline.md 작성 (Mermaid 그래프 포함)
+- [ ] README.md에 테스트, 린팅 배지 및 정보 추가

package/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{ts,js,json}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+

package/.eslintrc.json

@@ -0,0 +1,33 @@
+{
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "project": "./tsconfig.eslint.json"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/explicit-function-return-type": "warn",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-floating-promises": "error",
+    "no-console": "off"
+  },
+  "ignorePatterns": ["dist", "node_modules", "*.config.ts", "*.config.js", "**/*.d.ts"]
+}
+

package/.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Continuous Integration
+name: CI
 
 on:
   push:
@@ -8,169 +8,72 @@ on:
 
 jobs:
   test:
-    name: Test
+    name: Test & Lint
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        runtime: [node, bun]
+        node-version: [18.x, 20.x]
 
     steps:
-      - name: Checkout code
+      - name: 코드 체크아웃
         uses: actions/checkout@v4
 
-      - name: Setup runtime environment
-        uses: ./.github/actions/setup-runtime
+      - name: Bun 설치
+        uses: oven-sh/setup-bun@v1
         with:
-          runtime: ${{ matrix.runtime }}
-
-      - name: Run tests (Node.js)
-        if: matrix.runtime == 'node'
-        run: npm test
-
-      - name: Run tests (Bun)
-        if: matrix.runtime == 'bun'
-        run: bun test || echo "No bun tests specified"
-
-      - name: Test CLI functionality (Node.js)
-        if: matrix.runtime == 'node'
-        run: |
-          npm run build
-          node dist/index.js --version
-          node dist/index.js --help
-
-      - name: Test CLI functionality (Bun)
-        if: matrix.runtime == 'bun'
-        run: |
-          bun run build:bun
-          bun run dist/index.js --version
-          bun run dist/index.js --help
+          bun-version: latest
 
-  build:
-    name: Build & Upload Artifacts
-    runs-on: ubuntu-latest
-    needs: test
+      - name: 의존성 캐시
+        uses: actions/cache@v3
+        with:
+          path: ~/.bun/install/cache
+          key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-bun-
 
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
+      - name: 의존성 설치
+        run: bun install
 
-      - name: Setup Node.js environment
-        uses: ./.github/actions/setup-runtime
-        with:
-          runtime: node
+      - name: 타입 체크
+        run: bun run build
 
-      - name: Build TypeScript
-        run: npm run build
+      - name: 린트 실행
+        run: bun run lint
 
-      - name: Upload build artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: dist-files-${{ github.sha }}
-          path: dist/
-          retention-days: 30
+      - name: 테스트 실행
+        run: bun run test
 
-      - name: Upload type definitions
-        uses: actions/upload-artifact@v4
+      - name: 테스트 커버리지 업로드
+        if: matrix.node-version == '20.x'
+        uses: codecov/codecov-action@v3
         with:
-          name: types-${{ github.sha }}
-          path: |
-            dist/*.d.ts
-            dist/*.d.ts.map
-          retention-days: 30
-
-  lint:
-    name: Code Quality
+          files: ./coverage/coverage-final.json
+          flags: unittests
+          name: codecov-umbrella
+
+  build:
+    name: Build
     runs-on: ubuntu-latest
+    needs: test
 
     steps:
-      - name: Checkout code
+      - name: 코드 체크아웃
         uses: actions/checkout@v4
 
-      - name: Setup Node.js environment
-        uses: ./.github/actions/setup-runtime
+      - name: Bun 설치
+        uses: oven-sh/setup-bun@v1
         with:
-          runtime: node
-
-      - name: Check TypeScript compilation
-        run: npx tsc --noEmit
+          bun-version: latest
 
-      - name: Check code formatting (if prettier is added)
-        run: echo "Add prettier check here if needed"
+      - name: 의존성 설치
+        run: bun install
 
-      - name: Security audit
-        run: npm audit --audit-level=moderate
-
-  notify:
-    name: Notify Results
-    runs-on: ubuntu-latest
-    needs: [test, build, lint]
-    if: always()
+      - name: Bun으로 빌드
+        run: bun run build:bun
 
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Determine overall status
-        id: status
-        run: |
-          if [ "${{ needs.test.result }}" == "success" ] && [ "${{ needs.build.result }}" == "success" ] && [ "${{ needs.lint.result }}" == "success" ]; then
-            echo "status=success" >> $GITHUB_OUTPUT
-            echo "title=CI 성공 🎉" >> $GITHUB_OUTPUT
-            echo "description=모든 테스트, 빌드, 린팅이 성공적으로 완료되었습니다." >> $GITHUB_OUTPUT
-          else
-            echo "status=failure" >> $GITHUB_OUTPUT
-            echo "title=CI 실패 💥" >> $GITHUB_OUTPUT
-            echo "description=CI 파이프라인에서 오류가 발생했습니다. 로그를 확인해주세요." >> $GITHUB_OUTPUT
-          fi
-
-      - name: Create fields JSON
-        id: fields
-        run: |
-          FIELDS=$(cat << EOF
-          [
-            {
-              "name": "브랜치",
-              "value": "${{ github.ref_name }}",
-              "inline": true
-            },
-            {
-              "name": "커밋",
-              "value": "[\`${GITHUB_SHA:0:7}\`](https://github.com/${{ github.repository }}/commit/${{ github.sha }})",
-              "inline": true
-            },
-            {
-              "name": "테스트",
-              "value": "${{ needs.test.result == 'success' && '✅ 성공' || '❌ 실패' }}",
-              "inline": true
-            },
-            {
-              "name": "빌드",
-              "value": "${{ needs.build.result == 'success' && '✅ 성공' || '❌ 실패' }}",
-              "inline": true
-            },
-            {
-              "name": "린팅",
-              "value": "${{ needs.lint.result == 'success' && '✅ 성공' || '❌ 실패' }}",
-              "inline": true
-            },
-            {
-              "name": "작업자",
-              "value": "${{ github.actor }}",
-              "inline": true
-            }
-          ]
-          EOF
-          )
-          echo "fields<<EOF" >> $GITHUB_OUTPUT
-          echo "$FIELDS" >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
-
-      - name: Send Discord notification
-        uses: ./.github/actions/discord-notify
+      - name: 빌드 결과물 업로드
+        uses: actions/upload-artifact@v3
         with:
-          webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }}
-          status: ${{ steps.status.outputs.status }}
-          title: ${{ steps.status.outputs.title }}
-          description: ${{ steps.status.outputs.description }}
-          fields: ${{ steps.fields.outputs.fields }}
+          name: dist
+          path: dist/

package/.github/workflows/deploy.yml

@@ -0,0 +1,164 @@
+name: Deploy to NPM
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  # 통합된 CI + 배포 작업
+  deploy:
+    name: CI & Deploy
+    runs-on: ubuntu-latest
+
+    steps:
+      # === 기본 Setup ===
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org/"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      # === CI 단계 ===
+      - name: Type check
+        run: npx tsc --noEmit
+
+      - name: Build
+        run: npm run build
+
+      - name: Test CLI
+        run: |
+          node dist/index.js --version
+          node dist/index.js --help
+
+      - name: Security audit
+        run: npm audit --audit-level=moderate || true
+
+      # === 버전 관리 (main 브랜치만) ===
+      - name: Auto version update
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        run: |
+          # Git 설정
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+          PUBLISHED_VERSION=$(npm view tylersong version 2>/dev/null || echo "0.0.0")
+
+          echo "📦 Current: $CURRENT_VERSION | Published: $PUBLISHED_VERSION"
+
+          # 같은 버전이면 자동 업데이트
+          if [ "$CURRENT_VERSION" == "$PUBLISHED_VERSION" ]; then
+            echo "🔄 Auto-updating version..."
+            
+            # 커밋 메시지로 버전 타입 결정
+            COMMIT_MSG=$(git log -1 --pretty=%B)
+            if echo "$COMMIT_MSG" | grep -qE "BREAKING CHANGE|feat!|fix!"; then
+              VERSION_TYPE="major"
+            elif echo "$COMMIT_MSG" | grep -qE "^feat(\(.+\))?:"; then
+              VERSION_TYPE="minor"
+            else
+              VERSION_TYPE="patch"
+            fi
+            
+            echo "📈 Version type: $VERSION_TYPE"
+            
+            # 버전 업데이트
+            npm version $VERSION_TYPE --no-git-tag-version
+            NEW_VERSION=$(node -p "require('./package.json').version")
+            
+            echo "✅ Updated to v$NEW_VERSION"
+            echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
+            
+            # 재빌드 (버전 반영)
+            npm run build
+            
+            # 커밋 & 푸시
+            git add package.json package-lock.json
+            git commit -m "chore: bump version to v$NEW_VERSION [skip ci]"
+            git push origin main
+            
+            echo "SHOULD_PUBLISH=true" >> $GITHUB_ENV
+          else
+            echo "✅ Version already updated"
+            echo "NEW_VERSION=$CURRENT_VERSION" >> $GITHUB_ENV
+            echo "SHOULD_PUBLISH=true" >> $GITHUB_ENV
+          fi
+
+      # === 태그 기반 배포 ===
+      - name: Tag deployment check
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "🏷️ Tag deployment for v$VERSION"
+          echo "NEW_VERSION=$VERSION" >> $GITHUB_ENV
+          echo "SHOULD_PUBLISH=true" >> $GITHUB_ENV
+
+      # === NPM 배포 ===
+      - name: Publish to NPM
+        if: |
+          env.SHOULD_PUBLISH == 'true' && 
+          github.event_name != 'pull_request'
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      # === GitHub Release (태그만) ===
+      - name: Create GitHub Release
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const version = process.env.NEW_VERSION;
+            const tagName = context.ref.replace('refs/tags/', '');
+
+            await github.rest.repos.createRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              tag_name: tagName,
+              name: `Release v${version}`,
+              body: `🚀 **tylersong CLI v${version}**
+
+            ### 설치
+            \`\`\`bash
+            npx tylersong
+            \`\`\`
+
+            ### 변경사항
+            전체 변경사항은 [커밋 히스토리](https://github.com/${context.repo.owner}/${context.repo.repo}/commits/v${version})를 확인해주세요.`,
+              draft: false,
+              prerelease: false
+            });
+
+      # === 성공 알림 ===
+      - name: Success notification
+        if: success() && env.SHOULD_PUBLISH == 'true'
+        run: |
+          echo "🎉 Successfully deployed tylersong v${{ env.NEW_VERSION }}"
+          echo "📦 NPM: https://www.npmjs.com/package/tylersong"
+          echo "🚀 Install: npx tylersong"
+
+      # === 실패 알림 ===
+      - name: Failure notification
+        if: failure()
+        run: |
+          echo "❌ Deployment failed!"
+          echo "📋 Check the logs above for details"
+          exit 1