# バッチ設計書 19-toolkit run

## 概要

本ドキュメントは、Nushellプロジェクトにおける`toolkit run`コマンドのバッチ設計書です。Nushellをソースコードから直接実行するコマンドの仕様を定義します。

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

`toolkit run`は、Nushellをcargo runで直接実行し、開発中のNushellを即座に試すことができるバッチ処理です。

**業務上の目的・背景**：Nushellの開発中、コード変更後にその動作を確認するため、毎回ビルドとインストールを行うのは時間がかかります。本コマンドはcargo runを使用してソースから直接Nushellを起動し、開発中の変更を素早く検証できるようにします。開発サイクルを高速化し、効率的なデバッグを可能にします。

**バッチの実行タイミング**：開発者がコード変更後、動作確認を行いたい際に手動で実行します。インストールせずに開発版Nushellを試したい場合に使用します。

**主要な処理内容**：
1. 実験的オプションの設定（オプション）
2. cargo runでNushellを起動
3. 開発中であることを示すプロンプトインジケータを設定

**前後の処理との関連**：コード変更後に直接実行できます。正式にインストールする場合は`toolkit install`を使用します。

**影響範囲**：一時的なNushellセッションを開始します。システムにインストールされているNushellには影響しません。

## バッチ種別

開発用実行

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

Cargoプロジェクトとして正常に構成されており、Rustツールチェーンが利用可能であれば実行可能。コンパイルエラーがある場合は起動に失敗します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --experimental-options | oneof<list<string>, string> | No | [] | 有効化または無効化する実験的オプション |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | Nushellの出力 |
| 標準エラー出力 | テキスト | エラーメッセージ |

### 出力ファイル仕様

ファイル出力はありません（インタラクティブシェルを起動）。

## 処理フロー

### 処理シーケンス

```
1. 実験的オプションの処理
   └─ デフォルト値[]を設定
   └─ リストに変換
   └─ カンマ区切りで結合
   └─ [option1,option2]形式に整形

2. cargo runの実行
   └─ cargo run -- --experimental-options {options}
   └─ -e でプロンプトコマンドを設定
   └─ PROMPT_COMMAND_RIGHT に開発中インジケータを設定

3. インタラクティブシェルの開始
   └─ 右プロンプトに"trying Nushell inside Cargo"を表示
   └─ マゼンタ反転色で表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[実験的オプション処理]
    B --> C[オプションをリスト化]
    C --> D[カンマ区切りで結合]
    D --> E[cargo run実行]
    E --> F[プロンプトインジケータ設定]
    F --> G[Nushellシェル起動]
    G --> H[ユーザー操作待ち]
    H --> I{終了コマンド?}
    I -->|No| H
    I -->|Yes| J[シェル終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンパイルエラー | ソースコードの問題 | エラーメッセージに従い修正 |
| - | 依存関係エラー | クレートが見つからない | Cargo.lockを確認 |
| - | ランタイムエラー | 実行時の問題 | デバッグして修正 |

### リトライ仕様

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

### 障害時対応

コンパイルエラーが発生した場合、エラーメッセージを確認してソースコードを修正し、再度実行します。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 該当なし（インタラクティブ） |
| 目標処理時間 | ビルド後即座に起動 |
| メモリ使用量上限 | Nushell実行に依存 |

## 排他制御

同一ディレクトリでの複数Cargo操作は競合する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| ビルドログ | cargo run実行時 | Cargoのビルド出力 |
| シェルログ | シェル内操作時 | ユーザーコマンドと結果 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | なし | なし（インタラクティブ） |

## 備考

- 右プロンプトに「trying Nushell inside Cargo」と表示されることで、開発版を使用していることが視覚的に分かります
- マゼンタ反転色（`ansi magenta_reverse`）で目立つように表示されます
- 実験的オプションを指定することで、開発中の機能をテストできます
- `--experimental-options`は文字列またはリストで指定可能です
- cargo runのため、ビルドが必要な場合は自動的にビルドされます
