# バッチ設計書 17-toolkit build

## 概要

本ドキュメントは、Nushellプロジェクトにおける`toolkit build`コマンドのバッチ設計書です。Nushell本体およびオプションで全プラグインをビルドするコマンドの仕様を定義します。

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

`toolkit build`は、Nushell本体を指定された機能（features）でビルドし、オプションで全プラグインもビルドするバッチ処理です。

**業務上の目的・背景**：Nushellの開発において、ソースコードからバイナリをビルドすることは基本的な作業です。本コマンドは、機能フラグの指定や全プラグインの一括ビルドを簡単に行えるインターフェースを提供し、開発効率を向上させます。CI/CDでのビルド処理や、ローカル開発でのビルド作業に使用されます。

**バッチの実行タイミング**：開発者がコード変更後にビルドを行う際、または新しいバイナリを作成する際に手動で実行します。

**主要な処理内容**：
1. 指定された機能（features）でNushell本体をビルド
2. `--all`オプション指定時は全プラグインをビルド
3. ビルド進捗をコンソールに表示

**前後の処理との関連**：ビルド後、`toolkit install`でインストールするか、`toolkit run`で直接実行できます。`toolkit add plugins`でプラグインを登録できます。

**影響範囲**：targetディレクトリにビルド成果物が生成されます。既存のビルド成果物は上書きされます。

## バッチ種別

ビルド処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動 / CI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rust環境 | Rustツールチェーンがインストールされていること |
| Nushell環境 | Nushellがインストールされ、toolkitモジュールが利用可能であること |
| プロジェクトディレクトリ | Nushellプロジェクトのルートディレクトリで実行すること |
| 依存関係 | 必要なシステムライブラリがインストールされていること |

### 実行可否判定

Cargoプロジェクトとして正常に構成されており、Rustツールチェーンが利用可能であれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| ...features | string | No | [] | Nushellに含める機能のリスト（スペース区切り） |
| --all | flag | No | false | 全プラグインもビルドする |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースコード | Rustファイル群 | ワークスペース配下の全ソースファイル |
| Cargo.toml | TOML | ワークスペースとクレートの設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | ビルド進捗メッセージ |
| target/debug/ | バイナリ | ビルドされた実行ファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | nu（Windows: nu.exe） |
| 出力先 | target/debug/ |
| プラグイン | nu_plugin_*（target/debug/配下） |

## 処理フロー

### 処理シーケンス

```
1. Nushell本体のビルド
   └─ "Building nushell"メッセージ表示
   └─ cargo build --features {features} --locked

2. プラグインビルド判定
   └─ --all未指定: 処理終了
   └─ --all指定: プラグインビルドへ

3. 各プラグインのビルド
   └─ nu_plugin_inc
   └─ nu_plugin_gstat
   └─ nu_plugin_query
   └─ nu_plugin_polars
   └─ nu_plugin_example
   └─ nu_plugin_custom_values
   └─ nu_plugin_formats
   └─ 各プラグインディレクトリでcargo build
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Nushell本体ビルド]
    B --> C[cargo build --features --locked]
    C --> D{--all指定?}
    D -->|No| E[正常終了]
    D -->|Yes| F[プラグインリスト取得]
    F --> G[各プラグインをループ]
    G --> H[プラグインディレクトリへ移動]
    H --> I[cargo build実行]
    I --> J{全プラグイン完了?}
    J -->|No| G
    J -->|Yes| E
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンパイルエラー | ソースコードの問題 | エラーメッセージに従い修正 |
| - | 依存関係エラー | クレートが見つからない | Cargo.lockを確認/削除して再試行 |
| - | リンクエラー | システムライブラリ不足 | 必要なライブラリをインストール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動再実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

ビルドエラーが発生した場合、エラーメッセージを確認してソースコードまたは依存関係を修正し、再度ビルドを実行します。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | プロジェクト全体のソースファイル |
| 目標処理時間 | 数分〜数十分（環境・変更量依存） |
| メモリ使用量上限 | Cargoビルドに依存（数GB） |

## 排他制御

同一ディレクトリでの複数Cargo操作は競合する可能性があります。Cargo.lockによるファイルロックが使用されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド開始時 | "Building nushell"/"Building {plugin}" |
| 進捗ログ | コンパイル中 | Cargoの標準出力 |
| 区切り線 | 各ビルド開始時 | "----------------------------" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 環境依存 | なし（手動実行） |
| ビルド成功 | 終了コード0 | なし |

## 備考

- `--locked`オプションにより、Cargo.lockに記載された正確なバージョンの依存関係を使用します
- 利用可能な機能はCargo.tomlのfeaturesセクションで定義されています
- 機能の自動補完が利用可能です（`nu-complete list features`）
- ビルド対象プラグイン一覧:
  - nu_plugin_inc
  - nu_plugin_gstat
  - nu_plugin_query
  - nu_plugin_polars
  - nu_plugin_example
  - nu_plugin_custom_values
  - nu_plugin_formats
