# バッチ設計書 65-WindowsCheckPSVersion.ps1

## 概要

本ドキュメントは、Windows環境でPowerShell Core（pwsh.exe）の利用可能性を確認するスクリプト `WindowsCheckPSVersion.ps1` のバッチ設計書である。pwsh.exeコマンドがPATH上に存在するかを確認し、存在しない場合はエラーを出力する。

### 本バッチの処理概要

本スクリプトは、Windows環境においてPowerShell Core（pwsh.exe）がインストールされ利用可能な状態であるかを確認するガードスクリプトである。

**業務上の目的・背景**：OpenConsoleプロジェクトのスクリプト群はPowerShell Core 7以上を前提としているが、Windows環境ではWindows PowerShell（powershell.exe）がデフォルトで利用可能である一方、PowerShell Core（pwsh.exe）は別途インストールが必要である。本スクリプトは、Windows PowerShellのセッション内からpwsh.exeの存在を確認することで、開発者にPowerShell Coreのインストールを促す役割を果たす。CheckPSVersion.ps1（No.64）がPowerShellセッション内のバージョンを直接チェックするのに対し、本スクリプトはpwsh.exeのコマンド存在確認を行う点が異なる。

**バッチの実行タイミング**：ビルド環境セットアップ時やCI/CDパイプラインの前提条件チェックとして実行される。Windows PowerShellセッションから呼び出されることを想定している。

**主要な処理内容**：
1. `Get-Command "pwsh.exe"` でpwsh.exeの存在を確認する（ErrorAction SilentlyContinue）
2. コマンドが見つからない場合、Write-Errorでエラーメッセージを出力する

**前後の処理との関連**：CheckPSVersion.ps1（No.64）と同様の目的を持つ姉妹スクリプトである。ビルドスクリプトやrazzle.cmd等から呼び出される可能性がある。

**影響範囲**：標準エラー出力にのみ影響する。ファイルシステムやプロセスへの変更はない。なお、No.64とは異なり明示的なExit文は含まれていない。

## バッチ種別

環境チェック / バリデーション

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（環境チェック時） |
| 実行時刻 | 呼び出し元に依存 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | ビルドスクリプト/環境セットアップからの呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Windows環境 | Windows OSで実行されることを想定 |
| PowerShell実行環境 | PowerShell（Windows PowerShell含む）が実行されていること |

### 実行可否判定

PowerShellセッションが存在すれば常に実行可能。pwsh.exeが見つからない場合はエラーメッセージを出力する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本スクリプトはパラメータを受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| PATH環境変数 | 文字列 | pwsh.exeの検索対象パス |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準エラー | テキスト | pwsh.exe未検出時のエラーメッセージ |

### 出力ファイル仕様

ファイル出力はなし。

| 項目 | 内容 |
|-----|------|
| ファイル名 | 該当なし |
| 出力先 | 標準エラー出力 |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. pwsh.exeコマンド存在確認
   └─ Get-Command "pwsh.exe" -ErrorAction SilentlyContinue
2. エラー処理（未検出時）
   └─ コマンドが見つからない場合、Write-Errorでメッセージ出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Get-Command pwsh.exe 実行]
    B --> C{pwsh.exeが見つかったか?}
    C -->|Yes| D[正常終了]
    C -->|No| E[Write-Error: バージョン不足メッセージ]
    E --> F[終了]
```

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

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

データベース操作は行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | - | - | - |

### テーブル別操作詳細

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | pwsh.exe未検出 | pwsh.exeがPATH上に存在しない場合 | PowerShell Core 7.0.0以上をインストールする |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし（環境問題のため自動リトライ不可） |

### 障害時対応

PowerShell Core 7.0.0以上をインストールし、pwsh.exeがPATHに含まれていることを確認する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のコマンド存在確認 |
| 目標処理時間 | 即座（ミリ秒以内） |
| メモリ使用量上限 | 特に制限なし（極小） |

## 排他制御

排他制御は不要。読み取り専用の環境情報参照のみ。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | pwsh.exe未検出時 | `Incorrect version of PowerShell installed. Make sure you have at least PowerShell Core 7.0.0.` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| エラー出力 | Write-Error発生時 | 呼び出し元スクリプト |

## 備考

- スクリプトは3行のみの非常に小規模なガードスクリプトである
- CheckPSVersion.ps1（No.64）との違い：本スクリプトはpwsh.exeの存在確認（Get-Command）を行い、No.64は$PSVersionTableによるバージョン番号チェックを行う
- 本スクリプトにはExit文が含まれておらず、Write-Errorによるエラー出力のみを行う。呼び出し元の$ErrorActionPreferenceの設定により挙動が異なる
- ErrorAction SilentlyContinueにより、Get-Command自体のエラーは抑制される
- ソースファイル: `tools/WindowsCheckPSVersion.ps1`
