# バッチ設計書 16-toolkit add plugins

## 概要

本ドキュメントは、Nushellプロジェクトにおける`toolkit add plugins`コマンドのバッチ設計書です。インストール済みのNushellプラグインをNushellに登録するコマンドの仕様を定義します。

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

`toolkit add plugins`は、Nushellバイナリと同じディレクトリにインストールされているプラグイン（nu_plugin_*）を検出し、Nushellに登録するバッチ処理です。

**業務上の目的・背景**：Nushellのプラグインシステムでは、プラグインをインストールした後、Nushellに登録する必要があります。この登録作業を手動で行うのは煩雑であるため、本コマンドで一括登録を自動化します。これにより、プラグインのセットアップ時間を短縮し、開発者体験を向上させます。

**バッチの実行タイミング**：プラグインをインストール（`toolkit install --all`等）した後に手動で実行します。新しいプラグインを追加した際にも実行します。

**主要な処理内容**：
1. Nushellバイナリのインストールディレクトリを特定
2. nu_plugin_*パターンに一致するプラグイン実行ファイルを検索
3. 各プラグインに対して`plugin add`コマンドを実行
4. 登録完了メッセージを表示

**前後の処理との関連**：`toolkit install --all`や`toolkit build --all`でプラグインをビルド/インストールした後に実行します。登録後はNushellの再起動が必要です。

**影響範囲**：Nushellのプラグイン登録設定に影響します。ソースコードやバイナリファイルは変更しません。

## バッチ種別

設定登録 / プラグイン管理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Nushell環境 | Nushellがインストールされ、toolkitモジュールが利用可能であること |
| プラグインのインストール | nu_plugin_*実行ファイルがNushellと同じディレクトリにあること |
| 実行権限 | プラグイン実行ファイルに実行権限があること |

### 実行可否判定

Nushellがインストールされており、which nuでパスが取得できれば実行可能。プラグインが見つからない場合は、メッセージを表示して終了します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| （なし） | - | - | - | パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| プラグイン実行ファイル | バイナリ | nu_plugin_*パターンのファイル |
| Nushellバイナリパス | ファイルパス | which nuの結果 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 登録状況メッセージ |
| 標準エラー出力 | テキスト | エラーメッセージ（赤色表示） |

### 出力ファイル仕様

ファイル出力はありません（Nushellのプラグイン設定を更新）。

## 処理フロー

### 処理シーケンス

```
1. Nushellのインストールパスを取得
   └─ which nu | get path.0 | path dirname

2. プラグインの検索
   └─ ls $plugin_path | where name =~ nu_plugin
   └─ Windows: .exe拡張子でフィルタ
   └─ その他: .dファイルを除外

3. プラグインの存在確認
   └─ 空の場合: メッセージを表示して終了

4. 各プラグインの登録
   └─ for plugin in $plugins { plugin add $plugin }
   └─ エラー発生時: 赤色でエラーメッセージを表示

5. 完了メッセージの表示
   └─ "plugins registered, please restart nushell"
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Nushellパス取得]
    B --> C[プラグインディレクトリ特定]
    C --> D[nu_plugin_*を検索]
    D --> E{OS判定}
    E -->|Windows| F[.exeファイルをフィルタ]
    E -->|その他| G[.dファイルを除外]
    F --> H{プラグインあり?}
    G --> H
    H -->|No| I[なしメッセージ表示]
    I --> J[終了]
    H -->|Yes| K[各プラグインをループ]
    K --> L[plugin add実行]
    L --> M{エラー?}
    M -->|Yes| N[エラーメッセージ表示]
    N --> O[次のプラグインへ]
    M -->|No| O
    O --> P{全プラグイン処理完了?}
    P -->|No| K
    P -->|Yes| Q[完了メッセージ表示]
    Q --> J
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | プラグインなし | プラグインが見つからない | プラグインをインストール |
| - | 登録失敗 | プラグインの追加に失敗 | エラーメッセージを確認して対処 |
| - | パス取得失敗 | Nushellが見つからない | Nushellのインストールを確認 |

### リトライ仕様

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

### 障害時対応

プラグイン登録に失敗した場合、エラーメッセージを確認し、問題のあるプラグインを個別に`plugin add`コマンドで登録してみます。プラグインファイルの整合性や実行権限を確認します。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | インストール済みプラグイン数（通常1〜10個） |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | Nushell実行に依存 |

## 排他制御

特に排他制御はありません。ただし、プラグイン設定の同時更新は避けることを推奨します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各プラグイン登録時 | "> plugin add {plugin}" |
| エラーログ | 登録失敗時 | "Failed to add {plugin}: {error}" |
| 終了ログ | 処理完了時 | "plugins registered, please restart nushell" |
| 警告ログ | プラグインなし | "no plugins found in {path}..." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | なし | なし（手動実行） |
| 登録失敗数 | なし | コンソール出力 |

## 備考

- プラグイン登録後はNushellの再起動が必要です
- Windowsでは`.exe`拡張子のファイルのみを対象とします
- Linux/macOSでは`.d`ファイル（デバッグシンボル等）を除外します
- 登録済みのプラグインを再登録しても問題ありません
- 登録エラーが発生しても処理は継続し、他のプラグインの登録を試みます
