@gracefullight/validate-branch 1.0.1 → 1.1.1

package/README.md

@@ -1,78 +1,78 @@
 # @gracefullight/validate-branch
 
-> 커스텀 정규식을 지원하는 Git 브랜치 이름 유효성 검사 도구
+> Git branch name validation tool with custom regexp support
 
 [![npm version](https://img.shields.io/npm/v/@gracefullight/validate-branch.svg)](https://www.npmjs.com/package/@gracefullight/validate-branch)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**한국어** | [English](./README.en.md)
+**English** | [한국어](./README.ko.md)
 
-## 주요 기능
+## Features
 
-- **유연한 정규식 패턴** - 기본 패턴 또는 커스텀 정규식 사용
-- **현재 브랜치 감지** - Git 저장소에서 현재 브랜치 이름 자동 감지
-- **설정 파일 지원** - `branch.config.{ts,js,mjs}` 파일에서 패턴 로드
-- **CLI 도구** - 명령줄에서 직접 사용 가능
-- **상세한 오류 메시지** - 실패 시 명확한 오류 설명 제공
-- **타입스크립트 지원** - 완전한 TypeScript 타입 정의
+- **Flexible Regular Expression Pattern** - Use default pattern or custom regular expression
+- **Current Branch Detection** - Automatically detect current branch name from Git repository
+- **Config File Support** - Load patterns from `branch.config.{ts,js,mjs}` files
+- **CLI Tool** - Use directly from command line
+- **Detailed Error Messages** - Clear error descriptions on validation failure
+- **Full TypeScript Support** - Complete TypeScript type definitions
 
-## 기본 패턴
+## Default Pattern
 
-기본적으로 다음 브랜치 이름이 허용됩니다:
+By default, the following branch names are allowed:
 
-- `main` / `master` - 메인 브랜치
-- `develop` / `stage` - 개발/스테이지 브랜치
-- `feature/.*` - 기능 브랜치 (예: `feature/login`, `feature/user-auth`)
-- `fix/.*` - 버그 수정 브랜치 (예: `fix/memory-leak`, `fix/typo`)
-- `hotfix/.*` - 핫픽스 브랜치 (예: `hotfix/critical-bug`)
-- `release/.*` - 릴리스 브랜치 (예: `release/v1.0.0`)
+- `main` / `master` - Main branches
+- `develop` / `stage` - Development/staging branches
+- `feature/.*` - Feature branches (e.g., `feature/login`, `feature/user-auth`)
+- `fix/.*` - Bug fix branches (e.g., `fix/memory-leak`, `fix/typo`)
+- `hotfix/.*` - Hotfix branches (e.g., `hotfix/critical-bug`)
+- `release/.*` - Release branches (e.g., `release/v1.0.0`)
 
-## 설치
+## Installation
 
 ```bash
-# pnpm 사용
+# Using pnpm
 pnpm add @gracefullight/validate-branch
 
-# npm 사용
+# Using npm
 npm install @gracefullight/validate-branch
 
-# yarn 사용
+# Using yarn
 yarn add @gracefullight/validate-branch
 ```
 
-## 사용법
+## Usage
 
-### CLI 사용
+### CLI Usage
 
 ```bash
-# 현재 브랜치 검증
+# Validate current branch
 npx validate-branch
 
-# 특정 브랜치 검증
+# Validate specific branch
 npx validate-branch --test feature/new-feature
 
-# 커스텀 정규식 사용
+# Use custom regular expression
 npx validate-branch --regexp "^(main|develop|feature/.+)$"
 ```
 
-### 프로그래밍 방식 사용
+### Programmatic Usage
 
-#### 기본 패턴으로 검증
+#### Validate with Default Pattern
 
 ```typescript
 import { validateBranchName, validateWithDetails } from "@gracefullight/validate-branch";
 
-// 간단한 boolean 반환
+// Simple boolean return
 const isValid = validateBranchName("feature/new-component");
 console.log(isValid); // true
 
-// 상세한 결과 반환
+// Detailed result return
 const result = validateWithDetails("feature/new-component");
 console.log(result);
 // { valid: true, branchName: "feature/new-component" }
 ```
 
-#### 커스텀 정규식 사용
+#### Validate with Custom Regexp
 
 ```typescript
 import { validateBranchName } from "@gracefullight/validate-branch";
@@ -82,16 +82,16 @@ const isValid = validateBranchName("story/US-123-add-user", { customRegexp: cust
 console.log(isValid); // true
 ```
 
-#### 현재 브랜치 이름 가져오기
+#### Get Current Branch Name
 
 ```typescript
 import { getCurrentBranchName } from "@gracefullight/validate-branch";
 
 const currentBranch = await getCurrentBranchName();
-console.log(currentBranch); // "feature/new-component" 또는 null
+console.log(currentBranch); // "feature/new-component" or null
 ```
 
-#### 설정 파일 로드
+#### Load Config File
 
 ```typescript
 import { loadConfig } from "@gracefullight/validate-branch";
@@ -100,87 +100,87 @@ const config = await loadConfig();
 console.log(config);
 // {
 //   pattern: "^(main|develop|feature/.+)$",
-//   description: "프로젝트 브랜치 네이밍 규칙"
+//   description: "Project branch naming rules"
 // }
 ```
 
-## 설정 파일
+## Configuration File
 
-프로젝트 루트에 `branch.config.ts` 또는 `branch.config.js` 파일을 생성하여 커스텀 패턴을 정의하세요.
+Create a `branch.config.ts` or `branch.config.js` file in your project root to define custom patterns.
 
-### TypeScript 설정 (`branch.config.ts`)
+### TypeScript Config (`branch.config.ts`)
 
 ```typescript
 import type { Config } from "@gracefullight/validate-branch";
 
 const config: Config = {
   pattern: "^(main|develop|feature/.+|fix/.+|refactor/.+)$",
-  description: "프로젝트 브랜치 네이밍 규칙",
+  description: "Project branch naming rules",
 };
 
 export default config;
 ```
 
-### JavaScript 설정 (`branch.config.js`)
+### JavaScript Config (`branch.config.js`)
 
 ```javascript
 module.exports = {
   pattern: "^(main|develop|feature/.+|fix/.+)$",
-  description: "프로젝트 브랜치 네이밍 규칙",
+  description: "Project branch naming rules",
 };
 ```
 
-### 프리셋 사용 (`branch.config.ts`)
+### Using Presets (`branch.config.ts`)
 
-커스텀 패턴 대신 내장 프리셋을 사용할 수 있습니다.
+You can use built-in presets instead of custom patterns.
 
 ```typescript
 import type { Config } from "@gracefullight/validate-branch";
 
 const config: Config = {
-  preset: "jira", // "gitflow" 또는 "jira"
-  description: "JIRA 티켓 기반 브랜치 네이밍",
+  preset: "jira", // "gitflow" or "jira"
+  description: "JIRA ticket-based branch naming",
 };
 
 export default config;
 ```
 
-**사용 가능한 프리셋:**
+**Available Presets:**
 
-#### `gitflow` (기본값)
+#### `gitflow` (default)
 
-Git Flow 브랜치 전략을 따르는 패턴입니다.
+Pattern following Git Flow branching strategy.
 
-| 상태 | 브랜치 예시 |
-|------|------------|
-| ✅ 허용 | `main`, `master`, `develop`, `stage` |
-| ✅ 허용 | `feature/login`, `feature/user-auth`, `feature/add-payment` |
-| ✅ 허용 | `fix/memory-leak`, `fix/typo`, `fix/null-pointer` |
-| ✅ 허용 | `hotfix/critical-bug`, `hotfix/security-patch` |
-| ✅ 허용 | `release/v1.0.0`, `release/2.3.1` |
-| ❌ 거부 | `login`, `bugfix`, `my-branch` (prefix 없음) |
-| ❌ 거부 | `feature/`, `fix/` (이름 없음) |
-| ❌ 거부 | `Feature/Login`, `FIX/bug` (대문자 prefix) |
+| Status | Branch Examples |
+|--------|-----------------|
+| ✅ Allowed | `main`, `master`, `develop`, `stage` |
+| ✅ Allowed | `feature/login`, `feature/user-auth`, `feature/add-payment` |
+| ✅ Allowed | `fix/memory-leak`, `fix/typo`, `fix/null-pointer` |
+| ✅ Allowed | `hotfix/critical-bug`, `hotfix/security-patch` |
+| ✅ Allowed | `release/v1.0.0`, `release/2.3.1` |
+| ❌ Rejected | `login`, `bugfix`, `my-branch` (no prefix) |
+| ❌ Rejected | `feature/`, `fix/` (no name) |
+| ❌ Rejected | `Feature/Login`, `FIX/bug` (uppercase prefix) |
 
 #### `jira`
 
-JIRA 티켓 번호 기반 브랜치 패턴입니다.
+JIRA ticket number-based branch pattern.
 
-| 상태 | 브랜치 예시 |
-|------|------------|
-| ✅ 허용 | `main`, `master`, `develop`, `stage` |
-| ✅ 허용 | `FEATURE-123`, `FEATURE-1`, `FEATURE-99999` |
-| ✅ 허용 | `BUG-456`, `STORY-789`, `TASK-101`, `HOTFIX-202` |
-| ❌ 거부 | `feature/login` (gitflow 스타일) |
-| ❌ 거부 | `FEATURE-ABC` (숫자 아님) |
-| ❌ 거부 | `feature-123` (소문자) |
-| ❌ 거부 | `JIRA-123/description` (슬래시 포함) |
+| Status | Branch Examples |
+|--------|-----------------|
+| ✅ Allowed | `main`, `master`, `develop`, `stage` |
+| ✅ Allowed | `FEATURE-123`, `FEATURE-1`, `FEATURE-99999` |
+| ✅ Allowed | `BUG-456`, `STORY-789`, `TASK-101`, `HOTFIX-202` |
+| ❌ Rejected | `feature/login` (gitflow style) |
+| ❌ Rejected | `FEATURE-ABC` (not a number) |
+| ❌ Rejected | `feature-123` (lowercase) |
+| ❌ Rejected | `JIRA-123/description` (contains slash) |
 
-## API 레퍼런스
+## API Reference
 
 ### `validateBranchName(branchName, options?)`
 
-브랜치 이름이 유효한지 확인합니다.
+Check if a branch name is valid.
 
 ```typescript
 interface ValidateBranchNameOptions {
@@ -194,19 +194,19 @@ function validateBranchName(
 ): boolean
 ```
 
-**매개변수:**
-- `branchName`: 검증할 브랜치 이름
-- `options`: 선택사항, 검증 옵션 객체
-  - `customRegexp`: 커스텀 정규식 문자열
-  - `preset`: 프리셋 패턴 (`gitflow` 또는 `jira`, 기본값: `gitflow`)
+**Parameters:**
+- `branchName`: Branch name to validate
+- `options`: Optional, validation options object
+  - `customRegexp`: Custom regular expression string
+  - `preset`: Preset pattern (`gitflow` or `jira`, default: `gitflow`)
 
-**반환값:** 유효 여부
+**Returns:** Validity status
 
 ---
 
 ### `validateWithDetails(branchName, options?)`
 
-상세한 검증 결과를 반환합니다.
+Return detailed validation result.
 
 ```typescript
 function validateWithDetails(
@@ -215,16 +215,16 @@ function validateWithDetails(
 ): ValidationResult
 ```
 
-**반환값:**
+**Returns:**
 ```typescript
 {
   valid: boolean;
   branchName: string;
-  error?: string;  // 실패 시 오류 메시지
+  error?: string;  // Error message on failure
 }
 ```
 
-**예시:**
+**Example:**
 ```typescript
 const result = validateWithDetails("invalid-branch");
 // {
@@ -238,45 +238,45 @@ const result = validateWithDetails("invalid-branch");
 
 ### `getCurrentBranchName()`
 
-현재 Git 브랜치 이름을 가져옵니다.
+Get current Git branch name.
 
 ```typescript
 function getCurrentBranchName(): Promise<string | null>
 ```
 
-**반환값:** 현재 브랜치 이름, Git 저장소가 아닌 경우 `null`
+**Returns:** Current branch name, `null` if not in a Git repository
 
 ---
 
 ### `loadConfig()`
 
-프로젝트 설정 파일을 로드합니다.
+Load project configuration file.
 
 ```typescript
 function loadConfig(): Promise<Config | null>
 ```
 
-**설정 파일 탐색 순서:**
+**Config file search order:**
 1. `branch.config.ts`
 2. `branch.config.mts`
 3. `branch.config.js`
 4. `branch.config.cjs`
 5. `branch.config.mjs`
 
-**반환값:** 설정 객체 또는 설정 파일이 없는 경우 `null`
+**Returns:** Configuration object, `null` if no config file exists
 
 ---
 
-## 타입 정의
+## Type Definitions
 
 ### `Config`
 
 ```typescript
 interface Config {
-  pattern?: string;                    // 단일 정규식 패턴
-  patterns?: string[];                 // 다중 정규식 패턴 (예정)
-  preset?: "gitflow" | "jira";         // 프리셋 패턴 (기본값: "gitflow")
-  description?: string;                // 설정 설명
+  pattern?: string;                    // Single regex pattern
+  patterns?: string[];                 // Multiple regex patterns (planned)
+  preset?: "gitflow" | "jira";         // Preset pattern (default: "gitflow")
+  description?: string;                // Config description
 }
 ```
 
@@ -290,11 +290,11 @@ interface ValidationResult {
 }
 ```
 
-## 예제
+## Examples
 
-### Git Hooks와 함께 사용
+### Use with Git Hooks
 
-#### `package.json`에서 husky 설정
+#### With Husky in `package.json`
 
 ```json
 {
@@ -306,7 +306,7 @@ interface ValidationResult {
 }
 ```
 
-#### 직접 Git Hooks 사용
+#### Direct Git Hooks
 
 ```bash
 #!/bin/sh
@@ -314,12 +314,12 @@ interface ValidationResult {
 
 npx validate-branch
 if [ $? -ne 0 ]; then
-  echo "브랜치 이름이 규칙에 맞지 않습니다."
+  echo "Branch name does not follow naming conventions."
   exit 1
 fi
 ```
 
-### GitHub Actions와 함께 사용
+### Use with GitHub Actions
 
 ```yaml
 name: Branch Validation
@@ -346,7 +346,7 @@ jobs:
         run: validate-branch --test ${{ github.head_ref }}
 ```
 
-### CI/CD 파이프라인에서 사용
+### Use in CI/CD Pipeline
 
 ```yaml
 # .github/workflows/ci.yml
@@ -362,14 +362,14 @@ jobs:
         run: npx validate-branch
 ```
 
-### ESLint 플러그인과 함께 사용
+### Use with ESLint Plugin
 
 ```javascript
 // .eslintrc.js
 const { execSync } = require("child_process");
 
 module.exports = {
-  // ... 기본 설정
+  // ... other config
   rules: {
     "custom/validate-branch": {
       meta: {
@@ -401,70 +401,70 @@ module.exports = {
 };
 ```
 
-## 개발
+## Development
 
-### 설정
+### Setup
 
 ```bash
-# 저장소 클론
+# Clone repository
 git clone https://github.com/gracefullight/saju.git
 cd packages/validate-branch
 
-# 의존성 설치
+# Install dependencies
 pnpm install
 
-# 빌드
+# Build
 pnpm build
 
-# 테스트
+# Test
 pnpm test
 
-# 린트
+# Lint
 pnpm lint
 
-# 포맷
+# Format
 pnpm lint:fix
 ```
 
-### 로컬에서 CLI 테스트
+### Test CLI Locally
 
 ```bash
-# 빌드 후 로컬에서 CLI 테스트
+# After building, test CLI locally
 node bin/validate-branch.js --test feature/new-feature
 
-# 커스텀 패턴 테스트
+# Test with custom pattern
 node bin/validate-branch.js --test invalid-name --regexp "^(main|develop)$"
 ```
 
-## 기여하기
+## Contributing
 
-기여를 환영합니다! Pull Request를 자유롭게 제출해주세요.
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-1. 저장소 포크
-2. feature 브랜치 생성 (`git checkout -b feature/amazing-feature`)
-3. 변경사항 커밋 (`git commit -m 'Add some amazing feature'`)
-4. 브랜치에 푸시 (`git push origin feature/amazing-feature`)
-5. Pull Request 오픈
+1. Fork repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
 
-### 가이드라인
+### Guidelines
 
-- 새 기능에 대한 테스트 작성
-- 코드 커버리지 유지 또는 개선
-- 기존 코드 스타일 따르기 (Biome으로 강제)
-- 필요에 따라 문서 업데이트
+- Write tests for new features
+- Maintain or improve code coverage
+- Follow existing code style (enforced by Biome)
+- Update documentation as needed
 
-## 라이선스
+## License
 
 MIT © [gracefullight](https://github.com/gracefullight)
 
-## 관련 프로젝트
+## Related Projects
 
-- [isomorphic-git](https://isomorphic-git.org/) - Git 구현 라이브러리
-- [Commander.js](https://commander.js/) - Node.js CLI 프레임워크
-- [Chalk](https://chalk.js.org/) - 터미널 문자열 스타일링
+- [isomorphic-git](https://isomorphic-git.org/) - Git implementation library
+- [Commander.js](https://commander.js/) - Node.js CLI framework
+- [Chalk](https://chalk.js.org/) - Terminal string styling
 
-## 지원
+## Support
 
-- [문서](https://github.com/gracefullight/saju#readme)
-- [이슈 트래커](https://github.com/gracefullight/saju/issues)
-- [토론](https://github.com/gracefullight/saju/discussions)
+- [Documentation](https://github.com/gracefullight/saju#readme)
+- [Issue Tracker](https://github.com/gracefullight/saju/issues)
+- [Discussions](https://github.com/gracefullight/saju/discussions)

package/dist/cli.js

@@ -1,20 +1,57 @@
 #!/usr/bin/env node
 
 // src/cli.ts
-import { Command, Option } from "commander";
 import chalk from "chalk";
+import { Command, Option } from "commander";
+
+// src/load-config.ts
+import { readFile } from "fs/promises";
+import { resolve } from "path";
+import { cwd } from "process";
+var CONFIG_FILES = [
+  "branch.config.ts",
+  "branch.config.mts",
+  "branch.config.js",
+  "branch.config.cjs",
+  "branch.config.mjs"
+];
+async function loadConfig() {
+  for (const file of CONFIG_FILES) {
+    const configPath = resolve(cwd(), file);
+    try {
+      await readFile(configPath, "utf-8");
+      if (file.endsWith(".ts") || file.endsWith(".mts")) {
+        const { default: config } = await import(`file://${configPath}?ts=${Date.now()}`);
+        return config;
+      }
+      if (file.endsWith(".mjs")) {
+        const { default: config } = await import(`file://${configPath}?ts=${Date.now()}`);
+        return config;
+      }
+      if (file.endsWith(".js") || file.endsWith(".cjs")) {
+        const { default: config } = await import(configPath);
+        return config;
+      }
+    } catch (error) {
+      if (error.code !== "ENOENT") {
+        console.error(`Error loading config file ${file}:`, error);
+      }
+    }
+  }
+  return null;
+}
 
 // src/validate-branch-name.ts
-import * as git from "isomorphic-git";
 import * as fs from "fs";
-import { cwd } from "process";
+import { cwd as cwd2 } from "process";
+import * as git from "isomorphic-git";
 var GITFLOW_PATTERN = /^(main|master|develop|stage|feature\/[A-Za-z0-9_-]+|fix\/[A-Za-z0-9_-]+|hotfix\/[A-Za-z0-9_-]+|release\/[A-Za-z0-9_.-]+)$/;
 var JIRA_PATTERN = /^(main|master|develop|stage|[A-Z]+-[0-9]+)$/;
 async function getCurrentBranchName() {
   try {
     const branch = await git.currentBranch({
       fs,
-      dir: cwd(),
+      dir: cwd2(),
       fullname: false
     });
     return branch ?? null;
@@ -46,43 +83,6 @@ function validateWithDetails(branchName, options) {
   };
 }
 
-// src/load-config.ts
-import { readFile } from "fs/promises";
-import { resolve } from "path";
-import { cwd as cwd2 } from "process";
-var CONFIG_FILES = [
-  "branch.config.ts",
-  "branch.config.mts",
-  "branch.config.js",
-  "branch.config.cjs",
-  "branch.config.mjs"
-];
-async function loadConfig() {
-  for (const file of CONFIG_FILES) {
-    const configPath = resolve(cwd2(), file);
-    try {
-      await readFile(configPath, "utf-8");
-      if (file.endsWith(".ts") || file.endsWith(".mts")) {
-        const { default: config } = await import(`file://${configPath}?ts=${Date.now()}`);
-        return config;
-      }
-      if (file.endsWith(".mjs")) {
-        const { default: config } = await import(`file://${configPath}?ts=${Date.now()}`);
-        return config;
-      }
-      if (file.endsWith(".js") || file.endsWith(".cjs")) {
-        const { default: config } = await import(configPath);
-        return config;
-      }
-    } catch (error) {
-      if (error.code !== "ENOENT") {
-        console.error(`Error loading config file ${file}:`, error);
-      }
-    }
-  }
-  return null;
-}
-
 // src/cli.ts
 var SUCCESS_CODE = 0;
 var FAILED_CODE = 1;