# 機能設計書 20-omz pr clean

## 概要

本ドキュメントは、Oh My Zshの`omz pr clean`コマンドの機能設計について記載する。このコマンドは`omz pr test`で作成された全てのPull Requestブランチ（`ohmyzsh/pull-*`）を削除する機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：`omz pr test`コマンドを使用してPull Requestをテストすると、`ohmyzsh/pull-<番号>`という名前のローカルブランチが作成される。複数のPRをテストすると、これらのブランチが蓄積されていく。本機能は、これらのテスト用ブランチを一括で削除し、リポジトリをクリーンな状態に保つことを目的とする。

**機能の利用シーン**：
- 複数のPRをテストした後にブランチを整理したい場合
- ローカルリポジトリのブランチ数を減らしたい場合
- PRテストが完了し、もうテストブランチが不要になった場合

**主要な処理内容**：
1. `ohmyzsh/pull-*`パターンに一致するブランチを検索
2. 見つかったブランチを一覧表示
3. ユーザーに削除の確認を求める
4. 確認後、一致するすべてのブランチを強制削除

**関連システム・外部連携**：特になし。ローカルgitリポジトリのみを操作する。

**権限による制御**：特になし。ローカルブランチの削除権限があれば実行可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 12 | omz pr clean | 主画面 | ohmyzsh/pull-*ブランチをすべて削除 |

## 機能種別

バージョン管理・クリーンアップ

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| - | - | - | パラメータなし | - |

### 入力データソース

- Oh My Zshリポジトリのローカルブランチ一覧

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| branches | 配列 | 削除対象のブランチ一覧 |

### 出力先

- 標準出力: 削除対象ブランチの一覧
- 標準エラー出力: ログメッセージ

### 副作用

- `ohmyzsh/pull-*`パターンに一致するすべてのローカルブランチが削除される

## 処理フロー

### 処理シーケンス

```
1. PRブランチの検索
   └─ git for-each-ref "refs/heads/ohmyzsh/pull-*"

2. ブランチの存在確認
   └─ ブランチがない場合は情報メッセージを出力して終了

3. ブランチ一覧の表示
   └─ フォーマットされた一覧を表示（ブランチ名、SHA、サブジェクト）

4. 削除確認
   └─ "do you want remove these Pull Request branches? [Y/n]"

5. ブランチ削除
   └─ git branch -D で各ブランチを強制削除
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[cd $ZSH]
    B --> C[git for-each-ref ohmyzsh/pull-*]
    C --> D{PRブランチが存在する?}
    D -->|No| E[情報メッセージを出力]
    E --> F[終了]
    D -->|Yes| G[ブランチ一覧を表示]
    G --> H[削除確認プロンプト表示]
    H --> I{Y/y/Enterが入力された?}
    I -->|No| F
    I -->|Yes| J[情報メッセージを出力]
    J --> K[git branch --list ohmyzsh/pull-*]
    K --> L[各ブランチをgit branch -Dで削除]
    L --> F
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パターンマッチ | `ohmyzsh/pull-*`パターンに一致するブランチのみを対象とする | 常時 |
| BR-02 | 削除確認必須 | 削除前に必ずユーザー確認を求める | 常時 |
| BR-03 | デフォルトYes | Enter（空入力）は「Yes」として扱う | 確認時 |
| BR-04 | 強制削除 | `git branch -D`を使用してマージ状態に関係なく削除 | 削除時 |
| BR-05 | 一括削除 | 確認は一度のみで、すべてのブランチを一括削除 | 削除時 |

### 計算ロジック

特になし。

## データベース操作仕様

本機能ではデータベース操作は行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ブランチなし | 削除対象のブランチが存在しない | 情報メッセージを出力して正常終了 |
| - | 削除失敗 | ブランチの削除に失敗（現在チェックアウト中など） | gitのエラーメッセージが出力される |

### リトライ仕様

リトライは行わない。

## トランザクション仕様

該当なし。各ブランチは個別に削除されるため、一部のブランチで失敗しても他のブランチの削除は継続される。

## パフォーマンス要件

- 通常のブランチ数（数十件程度）では即座に完了すること

## セキュリティ考慮事項

- ローカルブランチの削除のみで、リモートには影響しない
- 削除前に必ず確認を求めるため、誤操作を防止

## 備考

- ブランチ一覧の表示では、ブランチ名、短縮SHA、コミットサブジェクトが色付きでフォーマットされる
- ブランチはコミット日時の新しい順でソートされて表示される
- 現在チェックアウト中のブランチが`ohmyzsh/pull-*`の場合、そのブランチの削除は失敗する

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: 関数の全体構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | cli.zsh | `lib/cli.zsh` | `_omz::pr::clean`関数の定義位置（561-589行目）を確認 |

**読解のコツ**: この関数はシンプルな構造で、サブシェル内で全ての処理が行われる。`set -e`によりエラー時に即座に終了する。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | cli.zsh | `lib/cli.zsh` | omz関数（3-21行目）からのコマンドディスパッチを確認 |
| 2-2 | cli.zsh | `lib/cli.zsh` | _omz::pr関数（541-559行目）からのサブコマンドディスパッチを確認 |

**主要処理フロー**:
1. **3-21行目**: `omz`関数がコマンドライン引数を解析し、`_omz::$command`を呼び出す
2. **541-559行目**: `_omz::pr`関数が`clean`サブコマンドを受け取り、`_omz::pr::clean`を呼び出す

#### Step 3: PRブランチ削除処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | cli.zsh | `lib/cli.zsh` | `_omz::pr::clean`関数（561-589行目）の実装詳細 |

**主要処理フロー**:
- **562行目**: サブシェルの開始と`set -e`
- **563行目**: `$ZSH`ディレクトリへの移動
- **565-569行目**: PRブランチの検索と一覧表示用フォーマット設定
- **571-575行目**: ブランチが存在しない場合の処理
- **577-578行目**: ブランチ一覧の表示
- **579-582行目**: 削除確認プロンプト
- **584-587行目**: ブランチの削除実行

### プログラム呼び出し階層図

```
omz (3-21行目)
    │
    └─ _omz::pr (541-559行目)
           │
           └─ _omz::pr::clean (561-589行目)
                  │
                  └─ (サブシェル)
                         │
                         ├─ cd "$ZSH"
                         │
                         ├─ git for-each-ref → ブランチ検索
                         │
                         ├─ _omz::confirm → 削除確認
                         │
                         └─ git branch -D → ブランチ削除
```

### データフロー図

```
[入力]                    [処理]                           [出力]

git refs          ───▶ git for-each-ref
(ローカルブランチ)         │
                          ├─ ohmyzsh/pull-* パターン
                          │
                          ▼
                     ブランチ一覧表示         ───▶ フォーマット済み一覧
                          │
                          ▼
                     確認プロンプト
                          │
                          ├─ Y/y/Enter → 削除実行
                          └─ その他 → キャンセル
                               │
                               ▼
                     git branch -D            ───▶ ブランチ削除
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| cli.zsh | `lib/cli.zsh` | ソース | omzコマンドのCLI実装。_omz::pr::clean関数を含む |
