# バッチ設計書 5-build-all-maclin.sh

## 概要

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

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

このバッチは、Nushellプロジェクトのローカルソースコードから、Nushell本体と全ての公式プラグインをcargoを使用してビルドします。Nushellがまだインストールされていない環境でも実行可能な純粋なシェルスクリプトとして実装されています。

**業務上の目的・背景**：Nushell開発者がソースコードの変更後にビルドを確認したい場合に使用します。Nushell環境に依存しないBashスクリプトとして実装されているため、初期セットアップ時や、Nushellが動作しない状況でのビルドにも使用できます。インストールせずにビルドのみを行うことで、コンパイルエラーの早期検出が可能です。

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

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

**前後の処理との関連**：ビルド成功後、`install-all.sh` でインストールを行うか、`target/debug` ディレクトリから直接実行できます。Windows環境では `build-all-windows.cmd` を使用します。

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

## バッチ種別

ビルド処理 / 開発支援

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| target/debug/nu | バイナリ | Nushell本体のデバッグビルド |
| target/debug/nu_plugin_* | バイナリ | 各プラグインのデバッグビルド |
| 標準出力 | テキスト | ビルド進捗メッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | nu, nu_plugin_example, nu_plugin_gstat, nu_plugin_inc, nu_plugin_query, nu_plugin_custom_values, nu_plugin_polars |
| 出力先 | target/debug/ |
| 形式 | ELF/Mach-O デバッグビルド実行可能バイナリ |

## 処理フロー

### 処理シーケンス

```
1. 環境設定
   └─ set -euo pipefail でエラー時即停止を設定
2. パス解決
   └─ スクリプトディレクトリからリポジトリルートを算出
3. 開始メッセージ出力
   └─ "Building nushell (nu) and all the plugins"
4. Nushell本体ビルド
   └─ サブシェルでリポジトリルートに移動し cargo build --locked
5. プラグインループ処理
   └─ 6個のプラグインを順次 cargo build でビルド
```

### フローチャート

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

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

`set -e` により任意のコマンドが失敗した時点でスクリプトは停止します。エラーメッセージを確認し、ソースコードを修正後に再実行してください。

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- サブシェル `( )` を使用してディレクトリ移動を行い、親シェルのカレントディレクトリを保持します
- `--locked` オプションはNushell本体のビルドのみで使用されます
- プラグインリストは6個（nu_plugin_formats が含まれていない）で、他のスクリプトと異なる可能性があります
- `readlink -f` を使用するため、一部のmacOS環境では `coreutils` のインストールが必要な場合があります
