# バッチ設計書 6-build-all-windows.cmd

## 概要

本ドキュメントは、Nushell本体および全プラグインをビルドするWindowsバッチファイル `build-all-windows.cmd` のバッチ設計書です。Windows CMD環境向けのビルドバッチとして設計されています。

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

このバッチは、Nushellプロジェクトのローカルソースコードから、Nushell本体（nu.exe）と複数の公式プラグインをcargoを使用してビルドします。Windows CMD環境で実行可能なバッチファイルとして実装されており、Nushellがまだインストールされていない環境でも実行可能です。

**業務上の目的・背景**：Windows環境のNushell開発者がソースコードの変更後にビルドを確認したい場合に使用します。PowerShellやNushellに依存しないCMDバッチファイルとして実装されているため、最小限の環境でビルドが可能です。インストールせずにビルドのみを行うことで、コンパイルエラーの早期検出が可能です。

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

**主要な処理内容**：
1. Nushell本体（nu.exe）を `cargo build --locked` でビルド
2. build サブルーチンを使用して各プラグインを順次ビルド
3. プラグイン（nu_plugin_example, nu_plugin_gstat, nu_plugin_inc, nu_plugin_query, nu_plugin_custom_values）をビルド

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

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

## バッチ種別

ビルド処理 / 開発支援

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

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

## 処理フロー

### 処理シーケンス

```
1. 開始メッセージ出力
   └─ "Building nushell (nu.exe) and all the plugins"
2. Nushell本体ビルド
   └─ cargo build --locked
3. プラグインビルド処理
   └─ call :build でサブルーチンを呼び出し各プラグインをビルド
4. 終了処理
   └─ リポジトリルートに戻り終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[開始メッセージ出力]
    B --> C[Nushell本体ビルド]
    C --> D[nu_plugin_example ビルド]
    D --> E[nu_plugin_gstat ビルド]
    E --> F[nu_plugin_inc ビルド]
    F --> G[nu_plugin_query ビルド]
    G --> H[nu_plugin_custom_values ビルド]
    H --> I[リポジトリルートに戻る]
    I --> J[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

CMDバッチはデフォルトでエラー継続します。エラー発生時はcargoの出力を確認し、ソースコードを修正後に再実行してください。

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- `@echo off` でコマンドエコーを抑制
- `:build` サブルーチンを使用してプラグインビルドを共通化
- `setlocal` / `endlocal` で環境変数のスコープを制限
- プラグインリストは5個で、他のスクリプト（7個）より少ない
  - nu_plugin_formats と nu_plugin_polars が含まれていない
- ディレクトリパスの扱いに相対パスを使用（`..\..\crates\` など）しているため、カレントディレクトリの状態に注意が必要
- `exit /b 0` で正常終了コードを返す
