# バッチ設計書 4-build-all.nu

## 概要

本ドキュメントは、Nushell本体および全プラグインをビルドするNushellスクリプト `build-all.nu` のバッチ設計書です。Nushell環境で実行可能なビルドバッチとして設計されていますが、現在は非推奨となっており、`toolkit build` コマンドの使用が推奨されています。

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

このバッチは、Nushellプロジェクトのローカルソースコードから、Nushell本体と全ての公式プラグインをcargoを使用してビルドします。Nushellスクリプトとして実装されており、Nushell環境がすでにインストールされている開発者向けのスクリプトです。

**業務上の目的・背景**：Nushell開発者がソースコードの変更後にビルドを確認したい場合に使用します。インストールせずにビルドのみを行うことで、コンパイルエラーの早期検出が可能です。ただし、現在は `toolkit build` コマンドへの移行が推奨されており、本スクリプトは非推奨（deprecated）です。

**バッチの実行タイミング**：ソースコード変更後のビルド確認時、またはCI/CDパイプラインでのビルド検証時に手動で実行します。

**主要な処理内容**：
1. 非推奨警告を出力
2. リポジトリルートパスを環境変数から解決
3. Nushell本体を `cargo build --locked` でビルド
4. 各プラグイン（nu_plugin_inc, nu_plugin_gstat, nu_plugin_query, nu_plugin_example, nu_plugin_custom_values, nu_plugin_formats, nu_plugin_polars）を順次ビルド

**前後の処理との関連**：ビルド成功後、`install-all.sh` や `install-all.ps1` でインストールを行うか、`target/debug` ディレクトリから直接実行できます。`toolkit build` への移行が推奨されます。

**影響範囲**：`target/` ディレクトリにビルド成果物が生成されます。

## バッチ種別

ビルド処理 / 開発支援

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Nushell環境 | Nushellがインストールされていること |
| Rust/Cargo環境 | Rustツールチェーンがインストールされていること |
| ソースコード | Nushellリポジトリのクローンが存在すること |

### 実行可否判定

- `nu` コマンドが実行可能であること
- `cargo` コマンドが実行可能であること
- スクリプトがNushellリポジトリ内の `scripts/` ディレクトリに配置されていること

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| $env.CURRENT_FILE | 環境変数 | スクリプト自身のパス |
| リポジトリルート | ディレクトリ | Nushell本体のソースコード |
| crates/nu_plugin_* | ディレクトリ | 各プラグインのソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| target/debug/nu | バイナリ | Nushell本体のデバッグビルド |
| target/debug/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 |
| 出力先 | target/debug/ |
| 形式 | デバッグビルド実行可能バイナリ |

## 処理フロー

### 処理シーケンス

```
1. 非推奨警告出力
   └─ "build-all.nu will be deprecated, please use the toolkit build command instead"
2. パス解決
   └─ $env.CURRENT_FILE から2階層上のディレクトリをリポジトリルートとして取得
3. Nushell本体ビルド
   └─ cargo build --locked
4. プラグインループ処理
   └─ 7個のプラグインを順次 cargo build でビルド
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[非推奨警告出力]
    B --> C[リポジトリルート解決]
    C --> D[Nushell本体ビルド]
    D --> E{プラグインループ}
    E -->|次のプラグイン| F[プラグインディレクトリに移動]
    F --> G[プラグインビルド]
    G --> E
    E -->|全完了| H[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

ビルドエラー発生時はNushellの標準エラー処理により停止します。エラーメッセージを確認し、ソースコードを修正後に再実行してください。

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 警告ログ | バッチ開始時 | 非推奨警告メッセージ |
| 開始ログ | バッチ開始時 | "Building nushell (nu) and all the plugins" |
| 進捗ログ | 各ビルド時 | "Building nushell" / "Building {plugin}" |
| 終了ログ | 該当なし | cargoの出力に依存 |
| エラーログ | エラー発生時 | cargoのエラー出力 |

## 監視・アラート

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

## 備考

- **非推奨（Deprecated）**：本スクリプトは非推奨です。代わりに `toolkit build` コマンドを使用してください
- `std/log` モジュールの `warning` 関数を使用して非推奨警告を出力します
- `--locked` オプションはNushell本体のビルドのみで使用されます
- プラグインリストはスクリプト内にハードコードされているため、新規プラグイン追加時はスクリプトの更新が必要です
- `$env.CURRENT_FILE` を使用してスクリプトの位置からリポジトリルートを算出します
