# バッチ設計書 1-install-all.sh

## 概要

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

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

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

**業務上の目的・背景**：Nushell開発者やコントリビューターが、ソースコードから最新のNushell環境を構築する必要があります。通常の `cargo install` を個別に実行するのは手間がかかるため、本バッチにより一括でNushell本体と全プラグインをインストールできます。これにより開発サイクルの効率化と、全プラグインを含む完全な環境構築が可能になります。

**バッチの実行タイミング**：開発者が新しい開発環境をセットアップする際、またはソースコードの変更後に最新版をインストールしたい場合に手動で実行します。CI/CDパイプラインでのインストール検証時にも使用されます。

**主要な処理内容**：
1. スクリプトのディレクトリからリポジトリルートパスを解決
2. Nushell本体を `cargo install --force --locked` でインストール
3. 各プラグイン（nu_plugin_inc, nu_plugin_gstat, nu_plugin_query, nu_plugin_example, nu_plugin_custom_values, nu_plugin_formats, nu_plugin_polars）を順次インストール

**前後の処理との関連**：本バッチは単独で実行可能ですが、事前にRust/Cargoのセットアップが完了している必要があります。アンインストールには `uninstall-all.sh` を使用します。

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

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rust/Cargo環境 | Rustツールチェーンがインストールされていること |
| ソースコード | Nushellリポジトリのクローンが存在すること |
| シェル環境 | Bash互換シェルが利用可能であること |
| 権限 | `~/.cargo/bin` への書き込み権限があること |

### 実行可否判定

- `cargo` コマンドが実行可能であること
- スクリプトがNushellリポジトリ内の `scripts/` ディレクトリに配置されていること
- `set -euo pipefail` によりエラー発生時は即座に停止

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | nu, nu_plugin_inc, nu_plugin_gstat, nu_plugin_query, nu_plugin_example, nu_plugin_custom_values, nu_plugin_formats, nu_plugin_polars |
| 出力先 | ~/.cargo/bin/ |
| 形式 | ELF/Mach-O 実行可能バイナリ |

## 処理フロー

### 処理シーケンス

```
1. 環境設定
   └─ set -euo pipefail でエラー時即停止を設定
2. パス解決
   └─ スクリプトディレクトリからリポジトリルートを算出
3. Nushell本体インストール
   └─ cargo install --force --path "$REPO_ROOT" --locked
4. プラグインループ処理
   └─ 7個のプラグインを順次 cargo install --force --path でインストール
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[環境変数設定]
    B --> C[リポジトリルート解決]
    C --> D[Nushell本体インストール]
    D --> E{プラグインループ}
    E -->|次のプラグイン| F[プラグインインストール]
    F --> E
    E -->|全完了| G[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

`set -e` により任意のコマンドが失敗した時点でスクリプトは停止します。再実行時は `--force` オプションにより既存インストールを上書きします。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各インストールコマンド単位 |
| コミットタイミング | 各 cargo install 完了時 |
| ロールバック条件 | 自動ロールバックなし（手動で uninstall-all.sh を実行） |

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- `--locked` オプションにより `Cargo.lock` ファイルの依存関係バージョンが厳密に使用されます
- `--force` オプションにより既存インストールが上書きされます
- プラグインリストはスクリプト内にハードコードされているため、新規プラグイン追加時はスクリプトの更新が必要です
