@gracefullight/validate-branch 0.1.0

package/README.en.md

@@ -0,0 +1,423 @@
+# @gracefullight/validate-branch
+
+> 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)
+
+[한국어](./README.md) | **English**
+
+## Features
+
+- **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` - 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
+# Using pnpm
+pnpm add @gracefullight/validate-branch
+
+# Using npm
+npm install @gracefullight/validate-branch
+
+# Using yarn
+yarn add @gracefullight/validate-branch
+```
+
+## Usage
+
+### 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";
+
+// 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";
+
+const customPattern = "^(main|develop|story/.+|bugfix/.+)$";
+const isValid = validateBranchName("story/US-123-add-user", { customRegexp: customPattern });
+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" or null
+```
+
+#### Load Config File
+
+```typescript
+import { loadConfig } from "@gracefullight/validate-branch";
+
+const config = await loadConfig();
+console.log(config);
+// {
+//   pattern: "^(main|develop|feature/.+)$",
+//   description: "Project branch naming rules"
+// }
+```
+
+## Configuration File
+
+Create a `branch.config.ts` or `branch.config.js` file in your project root to define custom patterns.
+
+### TypeScript Config (`branch.config.ts`)
+
+```typescript
+import type { Config } from "@gracefullight/validate-branch";
+
+const config: Config = {
+  pattern: "^(main|develop|feature/.+|fix/.+|refactor/.+)$",
+  description: "Project branch naming rules",
+};
+
+export default config;
+```
+
+### JavaScript Config (`branch.config.js`)
+
+```javascript
+module.exports = {
+  pattern: "^(main|develop|feature/.+|fix/.+)$",
+  description: "Project branch naming rules",
+};
+```
+
+## API Reference
+
+### `validateBranchName(branchName, options?)`
+
+Check if a branch name is valid.
+
+```typescript
+interface ValidateBranchNameOptions {
+  customRegexp?: string;
+  preset?: "gitflow" | "jira";
+}
+
+function validateBranchName(
+  branchName: string,
+  options?: ValidateBranchNameOptions
+): boolean
+```
+
+**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(
+  branchName: string,
+  options?: ValidateBranchNameOptions
+): ValidationResult
+```
+
+**Returns:**
+```typescript
+{
+  valid: boolean;
+  branchName: string;
+  error?: string;  // Error message on failure
+}
+```
+
+**Example:**
+```typescript
+const result = validateWithDetails("invalid-branch");
+// {
+//   valid: false,
+//   branchName: "invalid-branch",
+//   error: 'Branch name "invalid-branch" does not match pattern: /^(main|master|...)$/'
+// }
+```
+
+---
+
+### `getCurrentBranchName()`
+
+Get current Git branch name.
+
+```typescript
+function getCurrentBranchName(): Promise<string | 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`
+
+**Returns:** Configuration object, `null` if no config file exists
+
+---
+
+## Type Definitions
+
+### `Config`
+
+```typescript
+interface Config {
+  pattern?: string;        // Single regex pattern
+  patterns?: string[];     // Multiple regex patterns (planned)
+  description?: string;    // Config description
+}
+```
+
+### `ValidationResult`
+
+```typescript
+interface ValidationResult {
+  valid: boolean;
+  branchName: string;
+  error?: string;
+}
+```
+
+## Examples
+
+### Use with Git Hooks
+
+#### With Husky in `package.json`
+
+```json
+{
+  "husky": {
+    "hooks": {
+      "pre-commit": "validate-branch"
+    }
+  }
+}
+```
+
+#### Direct Git Hooks
+
+```bash
+#!/bin/sh
+# .git/hooks/pre-commit
+
+npx validate-branch
+if [ $? -ne 0 ]; then
+  echo "Branch name does not follow naming conventions."
+  exit 1
+fi
+```
+
+### Use with GitHub Actions
+
+```yaml
+name: Branch Validation
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  validate-branch:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install validate-branch
+        run: npm install -g @gracefullight/validate-branch
+
+      - name: Validate branch name
+        run: validate-branch --test ${{ github.head_ref }}
+```
+
+### Use in CI/CD Pipeline
+
+```yaml
+# .github/workflows/ci.yml
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Validate branch name
+        run: npx validate-branch
+```
+
+### Use with ESLint Plugin
+
+```javascript
+// .eslintrc.js
+const { execSync } = require("child_process");
+
+module.exports = {
+  // ... other config
+  rules: {
+    "custom/validate-branch": {
+      meta: {
+        type: "suggestion",
+        docs: {
+          description: "Validate git branch name",
+        },
+      },
+      create(context) {
+        return {
+          Program() {
+            const branch = execSync("git rev-parse --abbrev-ref HEAD", {
+              encoding: "utf-8",
+            }).trim();
+
+            const { validateBranchName } = require("@gracefullight/validate-branch");
+
+            if (!validateBranchName(branch)) {
+              context.report({
+                node: {},
+                message: `Invalid branch name: ${branch}`,
+              });
+            }
+          },
+        };
+      },
+    },
+  },
+};
+```
+
+## 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
+```
+
+### Test CLI Locally
+
+```bash
+# 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
+
+Contributions are welcome! Please feel free to submit a 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
+
+- 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 implementation library
+- [Commander.js](https://commander.js/) - Node.js CLI framework
+- [Chalk](https://chalk.js.org/) - Terminal string styling
+
+## Support
+
+- [Documentation](https://github.com/gracefullight/saju#readme)
+- [Issue Tracker](https://github.com/gracefullight/saju/issues)
+- [Discussions](https://github.com/gracefullight/saju/discussions)

package/README.md

@@ -0,0 +1,423 @@
+# @gracefullight/validate-branch
+
+> 커스텀 정규식을 지원하는 Git 브랜치 이름 유효성 검사 도구
+
+[![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)
+
+## 주요 기능
+
+- **유연한 정규식 패턴** - 기본 패턴 또는 커스텀 정규식 사용
+- **현재 브랜치 감지** - Git 저장소에서 현재 브랜치 이름 자동 감지
+- **설정 파일 지원** - `branch.config.{ts,js,mjs}` 파일에서 패턴 로드
+- **CLI 도구** - 명령줄에서 직접 사용 가능
+- **상세한 오류 메시지** - 실패 시 명확한 오류 설명 제공
+- **타입스크립트 지원** - 완전한 TypeScript 타입 정의
+
+## 기본 패턴
+
+기본적으로 다음 브랜치 이름이 허용됩니다:
+
+- `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`)
+
+## 설치
+
+```bash
+# pnpm 사용
+pnpm add @gracefullight/validate-branch
+
+# npm 사용
+npm install @gracefullight/validate-branch
+
+# yarn 사용
+yarn add @gracefullight/validate-branch
+```
+
+## 사용법
+
+### CLI 사용
+
+```bash
+# 현재 브랜치 검증
+npx validate-branch
+
+# 특정 브랜치 검증
+npx validate-branch --test feature/new-feature
+
+# 커스텀 정규식 사용
+npx validate-branch --regexp "^(main|develop|feature/.+)$"
+```
+
+### 프로그래밍 방식 사용
+
+#### 기본 패턴으로 검증
+
+```typescript
+import { validateBranchName, validateWithDetails } from "@gracefullight/validate-branch";
+
+// 간단한 boolean 반환
+const isValid = validateBranchName("feature/new-component");
+console.log(isValid); // true
+
+// 상세한 결과 반환
+const result = validateWithDetails("feature/new-component");
+console.log(result);
+// { valid: true, branchName: "feature/new-component" }
+```
+
+#### 커스텀 정규식 사용
+
+```typescript
+import { validateBranchName } from "@gracefullight/validate-branch";
+
+const customPattern = "^(main|develop|story/.+|bugfix/.+)$";
+const isValid = validateBranchName("story/US-123-add-user", { customRegexp: customPattern });
+console.log(isValid); // true
+```
+
+#### 현재 브랜치 이름 가져오기
+
+```typescript
+import { getCurrentBranchName } from "@gracefullight/validate-branch";
+
+const currentBranch = await getCurrentBranchName();
+console.log(currentBranch); // "feature/new-component" 또는 null
+```
+
+#### 설정 파일 로드
+
+```typescript
+import { loadConfig } from "@gracefullight/validate-branch";
+
+const config = await loadConfig();
+console.log(config);
+// {
+//   pattern: "^(main|develop|feature/.+)$",
+//   description: "프로젝트 브랜치 네이밍 규칙"
+// }
+```
+
+## 설정 파일
+
+프로젝트 루트에 `branch.config.ts` 또는 `branch.config.js` 파일을 생성하여 커스텀 패턴을 정의하세요.
+
+### TypeScript 설정 (`branch.config.ts`)
+
+```typescript
+import type { Config } from "@gracefullight/validate-branch";
+
+const config: Config = {
+  pattern: "^(main|develop|feature/.+|fix/.+|refactor/.+)$",
+  description: "프로젝트 브랜치 네이밍 규칙",
+};
+
+export default config;
+```
+
+### JavaScript 설정 (`branch.config.js`)
+
+```javascript
+module.exports = {
+  pattern: "^(main|develop|feature/.+|fix/.+)$",
+  description: "프로젝트 브랜치 네이밍 규칙",
+};
+```
+
+## API 레퍼런스
+
+### `validateBranchName(branchName, options?)`
+
+브랜치 이름이 유효한지 확인합니다.
+
+```typescript
+interface ValidateBranchNameOptions {
+  customRegexp?: string;
+  preset?: "gitflow" | "jira";
+}
+
+function validateBranchName(
+  branchName: string,
+  options?: ValidateBranchNameOptions
+): boolean
+```
+
+**매개변수:**
+- `branchName`: 검증할 브랜치 이름
+- `options`: 선택사항, 검증 옵션 객체
+  - `customRegexp`: 커스텀 정규식 문자열
+  - `preset`: 프리셋 패턴 (`gitflow` 또는 `jira`, 기본값: `gitflow`)
+
+**반환값:** 유효 여부
+
+---
+
+### `validateWithDetails(branchName, options?)`
+
+상세한 검증 결과를 반환합니다.
+
+```typescript
+function validateWithDetails(
+  branchName: string,
+  options?: ValidateBranchNameOptions
+): ValidationResult
+```
+
+**반환값:**
+```typescript
+{
+  valid: boolean;
+  branchName: string;
+  error?: string;  // 실패 시 오류 메시지
+}
+```
+
+**예시:**
+```typescript
+const result = validateWithDetails("invalid-branch");
+// {
+//   valid: false,
+//   branchName: "invalid-branch",
+//   error: 'Branch name "invalid-branch" does not match pattern: /^(main|master|...)$/'
+// }
+```
+
+---
+
+### `getCurrentBranchName()`
+
+현재 Git 브랜치 이름을 가져옵니다.
+
+```typescript
+function getCurrentBranchName(): Promise<string | null>
+```
+
+**반환값:** 현재 브랜치 이름, Git 저장소가 아닌 경우 `null`
+
+---
+
+### `loadConfig()`
+
+프로젝트 설정 파일을 로드합니다.
+
+```typescript
+function loadConfig(): Promise<Config | null>
+```
+
+**설정 파일 탐색 순서:**
+1. `branch.config.ts`
+2. `branch.config.mts`
+3. `branch.config.js`
+4. `branch.config.cjs`
+5. `branch.config.mjs`
+
+**반환값:** 설정 객체 또는 설정 파일이 없는 경우 `null`
+
+---
+
+## 타입 정의
+
+### `Config`
+
+```typescript
+interface Config {
+  pattern?: string;        // 단일 정규식 패턴
+  patterns?: string[];     // 다중 정규식 패턴 (예정)
+  description?: string;    // 설정 설명
+}
+```
+
+### `ValidationResult`
+
+```typescript
+interface ValidationResult {
+  valid: boolean;
+  branchName: string;
+  error?: string;
+}
+```
+
+## 예제
+
+### Git Hooks와 함께 사용
+
+#### `package.json`에서 husky 설정
+
+```json
+{
+  "husky": {
+    "hooks": {
+      "pre-commit": "validate-branch"
+    }
+  }
+}
+```
+
+#### 직접 Git Hooks 사용
+
+```bash
+#!/bin/sh
+# .git/hooks/pre-commit
+
+npx validate-branch
+if [ $? -ne 0 ]; then
+  echo "브랜치 이름이 규칙에 맞지 않습니다."
+  exit 1
+fi
+```
+
+### GitHub Actions와 함께 사용
+
+```yaml
+name: Branch Validation
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  validate-branch:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install validate-branch
+        run: npm install -g @gracefullight/validate-branch
+
+      - name: Validate branch name
+        run: validate-branch --test ${{ github.head_ref }}
+```
+
+### CI/CD 파이프라인에서 사용
+
+```yaml
+# .github/workflows/ci.yml
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Validate branch name
+        run: npx validate-branch
+```
+
+### ESLint 플러그인과 함께 사용
+
+```javascript
+// .eslintrc.js
+const { execSync } = require("child_process");
+
+module.exports = {
+  // ... 기본 설정
+  rules: {
+    "custom/validate-branch": {
+      meta: {
+        type: "suggestion",
+        docs: {
+          description: "Validate git branch name",
+        },
+      },
+      create(context) {
+        return {
+          Program() {
+            const branch = execSync("git rev-parse --abbrev-ref HEAD", {
+              encoding: "utf-8",
+            }).trim();
+
+            const { validateBranchName } = require("@gracefullight/validate-branch");
+
+            if (!validateBranchName(branch)) {
+              context.report({
+                node: {},
+                message: `Invalid branch name: ${branch}`,
+              });
+            }
+          },
+        };
+      },
+    },
+  },
+};
+```
+
+## 개발
+
+### 설정
+
+```bash
+# 저장소 클론
+git clone https://github.com/gracefullight/saju.git
+cd packages/validate-branch
+
+# 의존성 설치
+pnpm install
+
+# 빌드
+pnpm build
+
+# 테스트
+pnpm test
+
+# 린트
+pnpm lint
+
+# 포맷
+pnpm lint:fix
+```
+
+### 로컬에서 CLI 테스트
+
+```bash
+# 빌드 후 로컬에서 CLI 테스트
+node bin/validate-branch.js --test feature/new-feature
+
+# 커스텀 패턴 테스트
+node bin/validate-branch.js --test invalid-name --regexp "^(main|develop)$"
+```
+
+## 기여하기
+
+기여를 환영합니다! 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 오픈
+
+### 가이드라인
+
+- 새 기능에 대한 테스트 작성
+- 코드 커버리지 유지 또는 개선
+- 기존 코드 스타일 따르기 (Biome으로 강제)
+- 필요에 따라 문서 업데이트
+
+## 라이선스
+
+MIT © [gracefullight](https://github.com/gracefullight)
+
+## 관련 프로젝트
+
+- [isomorphic-git](https://isomorphic-git.org/) - Git 구현 라이브러리
+- [Commander.js](https://commander.js/) - Node.js CLI 프레임워크
+- [Chalk](https://chalk.js.org/) - 터미널 문자열 스타일링
+
+## 지원
+
+- [문서](https://github.com/gracefullight/saju#readme)
+- [이슈 트래커](https://github.com/gracefullight/saju/issues)
+- [토론](https://github.com/gracefullight/saju/discussions)

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.js

@@ -0,0 +1,141 @@
+#!/usr/bin/env node
+
+// src/cli.ts
+import { Command, Option } from "commander";
+import chalk from "chalk";
+
+// src/validate-branch-name.ts
+import * as git from "isomorphic-git";
+import * as fs from "fs";
+import { cwd } from "process";
+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(),
+      fullname: false
+    });
+    return branch ?? null;
+  } catch {
+    return null;
+  }
+}
+function validateWithDetails(branchName, options) {
+  const { customRegexp, preset = "gitflow" } = options ?? {};
+  if (customRegexp) {
+    const pattern2 = new RegExp(customRegexp);
+    if (pattern2.test(branchName)) {
+      return { valid: true, branchName };
+    }
+    return {
+      valid: false,
+      branchName,
+      error: `Branch name "${branchName}" does not match pattern: ${pattern2.source}`
+    };
+  }
+  const pattern = preset === "jira" ? JIRA_PATTERN : GITFLOW_PATTERN;
+  if (pattern.test(branchName)) {
+    return { valid: true, branchName };
+  }
+  return {
+    valid: false,
+    branchName,
+    error: `Branch name "${branchName}" does not match pattern: ${pattern.source}`
+  };
+}
+
+// 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;
+var program = new Command();
+program.name("validate-branch").description("Git branch name validation tool").version("0.1.0", "-v, --version");
+program.addOption(
+  new Option("-t, --test <branch>", "Test target branch name (uses current branch by default)")
+);
+program.addOption(
+  new Option("-r, --regexp <regexp>", "Custom regular expression to test branch name")
+);
+program.addOption(
+  new Option("-p, --preset <preset>", "Use preset pattern (gitflow or jira)").choices([
+    "gitflow",
+    "jira"
+  ])
+);
+async function main() {
+  program.parse(process.argv);
+  const options = program.opts();
+  const branch = options.test || await getCurrentBranchName();
+  if (!branch) {
+    console.error(chalk.red.bold("Error: Not a git repository\n"));
+    process.exit(FAILED_CODE);
+  }
+  const config = await loadConfig();
+  const customRegexp = options.regexp || config?.pattern;
+  const preset = options.preset || config?.preset || "gitflow";
+  console.log(chalk.cyan.bold(`
+Validating branch: ${chalk.yellow(branch)}
+`));
+  console.log(chalk.gray(`Preset: ${preset}
+`));
+  if (config?.description) {
+    console.log(chalk.gray(`Config: ${config.description}
+`));
+  }
+  try {
+    const result = validateWithDetails(branch, { customRegexp, preset });
+    if (result.valid) {
+      console.log(chalk.green.bold("\u2713 Valid branch name\n"));
+      process.exit(SUCCESS_CODE);
+    } else {
+      console.error(chalk.red.bold("\u2717 Invalid branch name\n"));
+      console.error(chalk.yellow(result.error));
+      process.exit(FAILED_CODE);
+    }
+  } catch (error) {
+    const errorMessage = error instanceof Error ? error.message : "Unknown error";
+    console.error(chalk.red.bold(`
+Error: ${errorMessage}
+`));
+    process.exit(FAILED_CODE);
+  }
+}
+main();

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+type Preset = "gitflow" | "jira";
+interface ValidateBranchNameOptions {
+    customRegexp?: string;
+    preset?: Preset;
+}
+declare function validateBranchName(branchName: string, options?: ValidateBranchNameOptions): boolean;
+declare function getCurrentBranchName(): Promise<string | null>;
+interface ValidationResult {
+    valid: boolean;
+    branchName: string;
+    error?: string;
+}
+declare function validateWithDetails(branchName: string, options?: ValidateBranchNameOptions): ValidationResult;
+
+interface Config {
+    pattern?: string;
+    patterns?: string[];
+    preset?: Preset;
+    description?: string;
+}
+declare function loadConfig(): Promise<Config | null>;
+
+export { type Config, type Preset, type ValidateBranchNameOptions, type ValidationResult, getCurrentBranchName, loadConfig, validateBranchName, validateWithDetails };

package/dist/index.js

@@ -0,0 +1,92 @@
+// src/validate-branch-name.ts
+import * as git from "isomorphic-git";
+import * as fs from "fs";
+import { cwd } from "process";
+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]+)$/;
+function validateBranchName(branchName, options) {
+  const { customRegexp, preset = "gitflow" } = options ?? {};
+  if (customRegexp) {
+    return new RegExp(customRegexp).test(branchName);
+  }
+  const pattern = preset === "jira" ? JIRA_PATTERN : GITFLOW_PATTERN;
+  return pattern.test(branchName);
+}
+async function getCurrentBranchName() {
+  try {
+    const branch = await git.currentBranch({
+      fs,
+      dir: cwd(),
+      fullname: false
+    });
+    return branch ?? null;
+  } catch {
+    return null;
+  }
+}
+function validateWithDetails(branchName, options) {
+  const { customRegexp, preset = "gitflow" } = options ?? {};
+  if (customRegexp) {
+    const pattern2 = new RegExp(customRegexp);
+    if (pattern2.test(branchName)) {
+      return { valid: true, branchName };
+    }
+    return {
+      valid: false,
+      branchName,
+      error: `Branch name "${branchName}" does not match pattern: ${pattern2.source}`
+    };
+  }
+  const pattern = preset === "jira" ? JIRA_PATTERN : GITFLOW_PATTERN;
+  if (pattern.test(branchName)) {
+    return { valid: true, branchName };
+  }
+  return {
+    valid: false,
+    branchName,
+    error: `Branch name "${branchName}" does not match pattern: ${pattern.source}`
+  };
+}
+
+// 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;
+}
+export {
+  getCurrentBranchName,
+  loadConfig,
+  validateBranchName,
+  validateWithDetails
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@gracefullight/validate-branch",
+  "version": "0.1.0",
+  "description": "Git branch name validation tool with custom regexp support",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "validate-branch": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "git",
+    "branch",
+    "validation",
+    "cli"
+  ],
+  "author": {
+    "name": "Eunkwang Shin",
+    "email": "gracefullight.dev@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/gracefullight/workspace/packages/validate-branch"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.4",
+    "tsup": "^8.5.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.3",
+    "vitest": "^4.0.7"
+  },
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^12.1.0",
+    "isomorphic-git": "^1.30.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsx src/cli.ts",
+    "test": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check --write src",
+    "format": "biome format --write src"
+  }
+}