# バッチ設計書 2-install-all.ps1

## 概要

本ドキュメントは、Nushell本体および全プラグインをcargoでインストールするPowerShellスクリプト `install-all.ps1` のバッチ設計書です。Windows環境向けのインストールバッチとして設計されています。

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

このバッチは、Nushellプロジェクトのローカルソースコードから、Nushell本体と全ての公式プラグインをcargoを使用してWindowsシステムにインストールします。Windows環境の開発者がローカル環境でNushellの最新開発版を素早くインストールし、動作確認やテストを行うためのスクリプトです。

**業務上の目的・背景**：Windows環境のNushell開発者やコントリビューターが、ソースコードから最新のNushell環境を構築する必要があります。Linux/macOS向けの `install-all.sh` と同等の機能をWindows PowerShell環境で提供します。これにより、プラットフォームを問わず統一された開発体験が可能になります。

**バッチの実行タイミング**：開発者が新しいWindows開発環境をセットアップする際、またはソースコードの変更後に最新版をインストールしたい場合に手動で実行します。

**主要な処理内容**：
1. Nushell本体を `cargo install --force --locked` でインストール
2. 各プラグインディレクトリに移動して順次インストール
3. プラグイン（nu_plugin_example, nu_plugin_gstat, nu_plugin_inc, nu_plugin_query, nu_plugin_custom_values, nu_plugin_formats, nu_plugin_polars）を順次インストール

**前後の処理との関連**：本バッチは単独で実行可能ですが、事前にRust/Cargoのセットアップが完了している必要があります。Nushellリポジトリのルートディレクトリから実行する必要があります。

**影響範囲**：`%USERPROFILE%\.cargo\bin` ディレクトリにNushellバイナリ（nu.exe）と各プラグインバイナリがインストールされます。

## バッチ種別

インストール処理 / 環境構築

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rust/Cargo環境 | Rustツールチェーンがインストールされていること |
| ソースコード | Nushellリポジトリのクローンが存在すること |
| シェル環境 | PowerShellが利用可能であること |
| 実行ディレクトリ | Nushellリポジトリのルートディレクトリから実行すること |
| 権限 | `%USERPROFILE%\.cargo\bin` への書き込み権限があること |

### 実行可否判定

- `cargo` コマンドが実行可能であること
- カレントディレクトリがNushellリポジトリのルートであること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| カレントディレクトリ（.） | ディレクトリ | Nushell本体のソースコード |
| crates/nu_plugin_* | ディレクトリ | 各プラグインのソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| %USERPROFILE%\.cargo\bin\nu.exe | バイナリ | Nushell本体の実行ファイル |
| %USERPROFILE%\.cargo\bin\nu_plugin_*.exe | バイナリ | 各プラグインの実行ファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | nu.exe, nu_plugin_example.exe, nu_plugin_gstat.exe, nu_plugin_inc.exe, nu_plugin_query.exe, nu_plugin_custom_values.exe, nu_plugin_formats.exe, nu_plugin_polars.exe |
| 出力先 | %USERPROFILE%\.cargo\bin\ |
| 形式 | Windows PE 実行可能バイナリ |

## 処理フロー

### 処理シーケンス

```
1. 開始メッセージ出力
   └─ "Installing nushell (nu) and all the plugins"
2. Nushell本体インストール
   └─ cargo install --force --path . --locked
3. プラグインループ処理
   └─ 各プラグインディレクトリに移動 → cargo install --force --path . → 元に戻る
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[開始メッセージ出力]
    B --> C[Nushell本体インストール]
    C --> D{プラグインループ}
    D -->|次のプラグイン| E[プラグインディレクトリに移動]
    E --> F[プラグインインストール]
    F --> G[元のディレクトリに戻る]
    G --> D
    D -->|全完了| H[バッチ終了]
```

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

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

本バッチはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | コンパイルエラー | ソースコードに問題がある場合 | ソースコードを修正 |
| 非0 | 依存関係エラー | Cargoの依存関係解決に失敗 | `cargo update` を実行 |
| 非0 | パス不正 | カレントディレクトリが不正 | リポジトリルートから実行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（自動リトライなし） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

PowerShellはデフォルトでエラー継続します。エラー発生時は手動で確認し、問題を解決後に再実行してください。`--force` オプションにより既存インストールは上書きされます。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各インストールコマンド単位 |
| コミットタイミング | 各 cargo install 完了時 |
| ロールバック条件 | 自動ロールバックなし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 8件（本体1 + プラグイン7） |
| 目標処理時間 | 環境依存（数分〜数十分） |
| メモリ使用量上限 | cargoビルドに依存 |

## 排他制御

同一環境での並列実行は非推奨です。Cargoのロック機構により競合が発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | "Installing nushell (nu) and all the plugins" |
| 進捗ログ | 各インストール時 | "Install plugin {name} from local..." |
| 終了ログ | 該当なし | cargoの出力に依存 |
| エラーログ | エラー発生時 | cargoのエラー出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 環境依存 | 手動確認 |
| エラー件数 | 1件以上 | 標準エラー出力 |

## 備考

- `--locked` オプションはNushell本体のインストール時のみ使用（プラグインでは使用しない）
- `--force` オプションにより既存インストールが上書きされます
- プラグインリストはスクリプト内にハードコードされているため、新規プラグイン追加時はスクリプトの更新が必要です
- ディレクトリ移動（Set-Location）を使用するため、リポジトリルートから実行する必要があります
