@gracefullight/validate-branch 0.1.0 → 1.0.1

package/README.en.md

@@ -130,6 +130,52 @@ module.exports = {
 };
 ```
 
+### 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" or "jira"
+  description: "JIRA ticket-based branch naming",
+};
+
+export default config;
+```
+
+**Available Presets:**
+
+#### `gitflow` (default)
+
+Pattern following Git Flow branching strategy.
+
+| 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 ticket number-based branch pattern.
+
+| 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 Reference
 
 ### `validateBranchName(branchName, options?)`
@@ -227,9 +273,10 @@ function loadConfig(): Promise<Config | null>
 
 ```typescript
 interface Config {
-  pattern?: string;        // Single regex pattern
-  patterns?: string[];     // Multiple regex patterns (planned)
-  description?: string;    // Config description
+  pattern?: string;                    // Single regex pattern
+  patterns?: string[];                 // Multiple regex patterns (planned)
+  preset?: "gitflow" | "jira";         // Preset pattern (default: "gitflow")
+  description?: string;                // Config description
 }
 ```
 

package/README.md

@@ -130,6 +130,52 @@ module.exports = {
 };
 ```
 
+### 프리셋 사용 (`branch.config.ts`)
+
+커스텀 패턴 대신 내장 프리셋을 사용할 수 있습니다.
+
+```typescript
+import type { Config } from "@gracefullight/validate-branch";
+
+const config: Config = {
+  preset: "jira", // "gitflow" 또는 "jira"
+  description: "JIRA 티켓 기반 브랜치 네이밍",
+};
+
+export default config;
+```
+
+**사용 가능한 프리셋:**
+
+#### `gitflow` (기본값)
+
+Git Flow 브랜치 전략을 따르는 패턴입니다.
+
+| 상태 | 브랜치 예시 |
+|------|------------|
+| ✅ 허용 | `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) |
+
+#### `jira`
+
+JIRA 티켓 번호 기반 브랜치 패턴입니다.
+
+| 상태 | 브랜치 예시 |
+|------|------------|
+| ✅ 허용 | `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` (슬래시 포함) |
+
 ## API 레퍼런스
 
 ### `validateBranchName(branchName, options?)`
@@ -227,9 +273,10 @@ function loadConfig(): Promise<Config | null>
 
 ```typescript
 interface Config {
-  pattern?: string;        // 단일 정규식 패턴
-  patterns?: string[];     // 다중 정규식 패턴 (예정)
-  description?: string;    // 설정 설명
+  pattern?: string;                    // 단일 정규식 패턴
+  patterns?: string[];                 // 다중 정규식 패턴 (예정)
+  preset?: "gitflow" | "jira";         // 프리셋 패턴 (기본값: "gitflow")
+  description?: string;                // 설정 설명
 }
 ```
 

package/dist/cli.js

@@ -86,6 +86,10 @@ async function loadConfig() {
 // src/cli.ts
 var SUCCESS_CODE = 0;
 var FAILED_CODE = 1;
+var PRESET_EXAMPLES = {
+  gitflow: ["feature/login", "fix/bug-123", "hotfix/security", "release/v1.0.0"],
+  jira: ["FEATURE-123", "BUG-456", "STORY-789", "TASK-101"]
+};
 var program = new Command();
 program.name("validate-branch").description("Git branch name validation tool").version("0.1.0", "-v, --version");
 program.addOption(
@@ -128,6 +132,11 @@ Validating branch: ${chalk.yellow(branch)}
     } else {
       console.error(chalk.red.bold("\u2717 Invalid branch name\n"));
       console.error(chalk.yellow(result.error));
+      console.error(chalk.gray("\nExamples of valid branch names:"));
+      for (const example of PRESET_EXAMPLES[preset]) {
+        console.error(chalk.green(`  \u2022 ${example}`));
+      }
+      console.error();
       process.exit(FAILED_CODE);
     }
   } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gracefullight/validate-branch",
-  "version": "0.1.0",
+  "version": "1.0.1",
   "description": "Git branch name validation tool with custom regexp support",
   "type": "module",
   "main": "./dist/index.js",
@@ -31,7 +31,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "http://github.com/gracefullight/workspace/packages/validate-branch"
+    "url": "https://github.com/gracefullight/ts-workspace.git",
+    "directory": "packages/validate-branch"
   },
   "license": "MIT",
   "publishConfig": {