# 機能設計書 30-git_prompt_short_sha

## 概要

本ドキュメントは、Oh My Zshの`git_prompt_short_sha`関数の機能設計を定義するものである。この関数は、現在のコミットの短縮SHA（7文字）を取得し、プロンプト表示用にフォーマットして出力する機能を提供する。

### 本機能の処理概要

`git_prompt_short_sha`関数は、`git rev-parse --short HEAD`コマンドを使用して現在のHEADコミットの短縮SHA（デフォルト7文字）を取得し、テーマ変数で装飾した形式で出力する。

**業務上の目的・背景**：開発者がターミナルで作業する際、現在のコミットを特定できるSHAを表示することは有用である。特にデバッグ時やコードレビュー時に、どのコミット上で作業しているかを明確にできる。短縮SHAは可読性が高く、ほとんどの場合一意に特定できる。

**機能の利用シーン**：
- プロンプトに現在のコミットSHAを表示
- デバッグ時にコミットを特定
- コードレビューで参照コミットを明示
- ログやスクリーンショットでコミット情報を記録

**主要な処理内容**：
1. `git rev-parse --short HEAD`で短縮SHAを取得
2. 取得成功時のみ出力
3. テーマ変数（BEFORE/AFTER）でフォーマットして出力

**関連システム・外部連携**：
- Gitコマンド（`git rev-parse`）

**権限による制御**：特になし。Gitリポジトリへのアクセス権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | シェルプロンプト | 主画面 | プロンプト表示時に短縮SHAを出力 |

## 機能種別

情報取得・フォーマット処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | この関数は引数を取らない | - |

### 入力データソース

- カレントディレクトリのGitリポジトリ情報
- テーマ変数（`ZSH_THEME_GIT_PROMPT_SHA_BEFORE`、`ZSH_THEME_GIT_PROMPT_SHA_AFTER`）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 短縮SHA | 文字列 | `${BEFORE}${SHA}${AFTER}`形式の文字列（例：`[abc1234]`） |

### 出力先

標準出力（プロンプト表示用）

## 処理フロー

### 処理シーケンス

```
1. git rev-parse --short HEADで短縮SHAを取得
   └─ デフォルトで7文字の短縮SHA
2. 取得成功の判定
   └─ 成功時のみ処理続行
3. フォーマット文字列の生成と出力
   └─ ${BEFORE}${SHA}${AFTER}
```

### フローチャート

```mermaid
flowchart TD
    A[開始: git_prompt_short_sha] --> B[git rev-parse --short HEAD]
    B --> C{取得成功?}
    C -->|No| D[何も出力せず終了]
    C -->|Yes| E[BEFORE + SHA + AFTER を出力]
    E --> F[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-30-01 | 短縮SHA長 | デフォルトで7文字の短縮SHA（Git設定で変更可能） | 常時 |
| BR-30-02 | 取得成功時のみ出力 | rev-parseが失敗した場合は何も出力しない | 常時 |
| BR-30-03 | フォーマット | BEFORE + SHA + AFTER の形式で出力 | 常時 |

### 計算ロジック

該当なし

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

### 操作別データベース影響一覧

該当なし（データベース操作は行わない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 非Gitリポジトリ | Gitリポジトリ外で実行 | 何も出力せずにリターン |
| - | HEADなし | 空のリポジトリでコミットがない | 何も出力せずにリターン |

### リトライ仕様

リトライ機能なし

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

該当なし

## パフォーマンス要件

- `GIT_OPTIONAL_LOCKS=0`を設定してGitコマンドを実行し、ロック競合を回避
- 単純なSHA取得のため非常に高速

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

- 読み取り専用のGit操作のみを実行
- `GIT_OPTIONAL_LOCKS=0`によりファイルロックを取得しない

## 備考

- 短縮SHAは通常7文字だが、リポジトリが大きくなると一意性を保つために長くなる場合がある
- `git_prompt_long_sha`関数（No.31）とセットで使用されることが多い
- テーマ変数でプレフィックス/サフィックスをカスタマイズ可能（例：「[」「]」で囲む）

---

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

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

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、この機能で使用されるテーマ変数を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | テーマファイル | `themes/*.zsh-theme` | ZSH_THEME_GIT_PROMPT_SHA_*変数の定義 |

**主要なテーマ変数**:
- `ZSH_THEME_GIT_PROMPT_SHA_BEFORE`: SHAの前に表示する文字列（例：「[」）
- `ZSH_THEME_GIT_PROMPT_SHA_AFTER`: SHAの後に表示する文字列（例：「]」）

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | git.zsh | `lib/git.zsh` | git_prompt_short_sha関数の実装を確認 |

**主要処理フロー**:
1. **336行目**: 関数のコメント
2. **337行目**: `git_prompt_short_sha`関数の定義開始
3. **338行目**: ローカル変数`SHA`の宣言
4. **339行目**: `rev-parse --short HEAD`でSHA取得し、成功時のみechoを実行

**読解のコツ**:
- `SHA=$(...) && echo ...`の形式で、取得と出力を1行で実現
- `&&`により、SHA取得が成功した場合のみechoが実行される
- `--short`オプションが短縮SHAを取得するポイント

#### Step 3: 関連関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | git.zsh | `lib/git.zsh` | git_prompt_long_sha関数（343-346行目） |

**関連関数**:
- `git_prompt_long_sha`は`--short`オプションなしでフルSHA（40文字）を取得
- 両関数は同じテーマ変数（BEFORE/AFTER）を使用

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

```
git_prompt_short_sha (ユーザー呼び出し/プロンプト展開)
    │
    └─ __git_prompt_git rev-parse --short HEAD
           │
           └─ 成功時
                  └─ echo "${BEFORE}${SHA}${AFTER}"
```

### データフロー図

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

                        ┌─────────────────────┐
カレントディレクトリ ──▶│ rev-parse --short   │
HEAD                    │ HEAD                │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
                        │ 取得成功判定        │
                        │ && で連結           │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
ZSH_THEME_GIT_         ▶│ フォーマット構築    │
PROMPT_SHA_BEFORE       │ ${BEFORE}${SHA}    │
PROMPT_SHA_AFTER        │ ${AFTER}           │
                        └─────────────────────┘
                                  │
                                  ▼
                          標準出力（例：「[abc1234]」）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| git.zsh | `lib/git.zsh` | ソース | git_prompt_short_sha関数の実装 |
| *.zsh-theme | `themes/*.zsh-theme` | テーマ | BEFORE/AFTER変数の定義 |
