# 機能設計書 37-ファイル監視

## 概要

本ドキュメントは、Nushellにおけるファイル監視機能（watch）の設計を記述する。このコマンドはファイルやディレクトリの変更を監視し、変更時にクロージャを実行するかイベントストリームを出力する。

### 本機能の処理概要

**業務上の目的・背景**：
ファイルの変更を監視して自動的にアクションを実行する機能は、開発時の自動テスト実行、ログファイルの監視、ホットリロードなど多くのシーンで活用される。Nushellのwatchコマンドは、従来のファイル監視ツールと同等の機能を提供しつつ、Nushellのクロージャやパイプラインと統合された使いやすいインターフェースを提供する。

**機能の利用シーン**：
- ソースコードの変更を検知してテストを自動実行
- 設定ファイルの変更を検知して設定を再読み込み
- ログファイルの変更を監視してアラートを発行
- ディレクトリ内のファイル変更を追跡

**主要な処理内容**：
1. 指定されたパスの監視を開始
2. ファイル変更イベントを検知（作成、削除、変更、リネーム）
3. globパターンによるフィルタリング
4. クロージャ実行またはイベントストリーム出力

**関連システム・外部連携**：
- notify-debouncer-full クレート（ファイルシステムイベント監視）
- nu-glob クレート（globパターンマッチング）

**権限による制御**：
- 監視対象のファイル/ディレクトリへの読み取り権限が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | メインREPL | 参照画面 | コマンド入力・結果表示 |

## 機能種別

ファイルシステム監視

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| path | Filepath | Yes | 監視対象のパス | 有効なファイル/ディレクトリパス |
| closure | Closure | No | 変更時に実行するクロージャ | operation, path, new_pathを受け取る |
| --debounce | Duration | No | デバウンス期間（デフォルト100ms） | 正の期間 |
| --glob | String | No | フィルタリング用globパターン | 有効なglobパターン |
| --recursive | Boolean | No | 再帰的に監視（デフォルトtrue） | - |
| --quiet | Switch | No | 初期メッセージを非表示 | - |
| --verbose | Switch | No | 詳細モードで実行 | - |

### 入力データソース

コマンドライン引数

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| クロージャモード出力 | Nothing | クロージャの実行結果を出力 |
| ストリームモード出力 | Table | operation, path, new_pathカラムを持つイベントテーブル |

### イベント種別

| operation | 説明 |
|-----------|------|
| Create | ファイル/ディレクトリが作成された |
| Remove | ファイル/ディレクトリが削除された |
| Write | ファイルの内容が変更された |
| Rename | ファイル/ディレクトリがリネームされた |

### 出力先

- クロージャモード: クロージャの出力先に依存
- ストリームモード: パイプライン出力

## 処理フロー

### 処理シーケンス

```
1. パスの検証と絶対パスへの変換
   └─ 空白のトリミングと絶対パス化
2. 監視オプションの設定
   └─ デバウンス、glob、再帰モードの設定
3. Debouncerの作成と監視開始
   └─ notify_debouncer_fullを使用
4. イベントループの開始
   └─ Ctrl+Cで中断されるまで継続
5. イベントの処理
   └─ クロージャ実行またはストリーム出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[パスを絶対パスに変換]
    B --> C[監視オプションの設定]
    C --> D[Debouncer作成]
    D --> E{作成成功?}
    E -->|No| F[エラー返却]
    E -->|Yes| G[ウォッチャー開始]
    G --> H{クロージャ指定?}
    H -->|Yes| I[クロージャモード]
    H -->|No| J[ストリームモード]
    I --> K[イベント待機]
    J --> L[イベントストリーム生成]
    K --> M{イベント受信?}
    M -->|Yes| N{globマッチ?}
    N -->|Yes| O[クロージャ実行]
    N -->|No| K
    O --> P[結果出力]
    P --> K
    M -->|Ctrl+C| Q[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-37-1 | デバウンス | 連続する変更を1つにまとめる | 常に |
| BR-37-2 | 再帰監視 | デフォルトでサブディレクトリも監視 | ディレクトリ指定時 |
| BR-37-3 | globフィルタ | 指定パターンにマッチするファイルのみ通知 | --glob指定時 |
| BR-37-4 | リネーム追跡 | リネーム時は元パスと新パスの両方を通知 | Rename操作時 |
| BR-37-5 | ストリームモード | クロージャ未指定時はイベントストリームを返す | クロージャなし |

### 計算ロジック

- デバウンス期間: デフォルト100ms、--debounceで変更可能
- Ctrl+Cチェック間隔: 100ms

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

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

該当なし（ファイルシステム監視のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| GenericError | 一般エラー | ウォッチャー作成失敗 | パスを確認 |
| GenericError | 一般エラー | 監視開始失敗 | 権限を確認 |
| TypeMismatch | 型エラー | 無効なglobパターン | 正しいパターンを使用 |
| Disconnected | 接続エラー | ウォッチャーが切断 | 再実行 |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- デバウンスによるイベント統合で重複通知を削減
- 並列処理でイベント処理とCtrl+Cチェックを同時実行
- イテレータベースのストリーム処理で低メモリ消費

## セキュリティ考慮事項

- 監視対象パスへの読み取り権限が必要
- クロージャは現在のユーザー権限で実行

## 備考

- --debounce-msは非推奨、--debounceを使用（0.107.0で非推奨化）
- クロージャは(operation, path, new_path)の3引数を受け取る
- ストリームモードではパイプライン処理が可能

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

WatchEventとWatchEventRecordの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | watch.rs | `crates/nu-command/src/filesystem/watch.rs` | WatchEvent構造体（309-313行目） |
| 1-2 | watch.rs | `crates/nu-command/src/filesystem/watch.rs` | WatchEventRecord構造体（315-320行目） |

**読解のコツ**: WatchEventはイベント種別とパス情報を保持。WatchEventRecordはIntoValue deriveでValue型に自動変換。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | watch.rs | `crates/nu-command/src/filesystem/watch.rs` | Watchコマンドの実装 |

**主要処理フロー**:
1. **104-126行目**: run関数でパス取得とオプション解析
2. **127-133行目**: デバウンス期間の解決
3. **165-186行目**: Debouncerの作成と監視開始
4. **194-247行目**: クロージャモードとストリームモードの分岐

#### Step 3: イベント変換ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | watch.rs | `crates/nu-command/src/filesystem/watch.rs` | TryFrom<DebouncedEvent>実装（332-369行目） |

**主要処理フロー**:
- **338-342行目**: Create イベントの処理
- **343-347行目**: Remove イベントの処理
- **348-354行目**: Write イベントの処理
- **355-365行目**: Rename イベントの処理

#### Step 4: イテレータ実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | watch.rs | `crates/nu-command/src/filesystem/watch.rs` | WatchIterator実装（371-434行目） |

### プログラム呼び出し階層図

```
Watch::run()
    │
    ├─ call.req() [パス取得]
    │
    ├─ nu_path::absolute_with() [絶対パス化]
    │
    ├─ resolve_duration_arguments() [デバウンス解決]
    │
    ├─ new_debouncer() [Debouncer作成]
    │
    ├─ debouncer.watcher().watch() [監視開始]
    │
    └─ [分岐] closure指定?
           │
           ├─ [Yes] ClosureEval::new()
           │         │
           │         └─ closure.run_with_input() [繰り返し実行]
           │
           └─ [No] WatchIterator::new()
                    │
                    └─ into_pipeline_data() [ストリーム出力]
```

### データフロー図

```
[入力]               [処理]                    [出力]

パス ───────────▶ Watch::run() ──────────▶ Nothing/Table
    │                  │
    │                  ├─ Debouncer作成
    │                  │
    │                  ├─ 監視開始
    │                  │
    │                  └─ イベントループ
    │
クロージャ ────────────┤
                       │
globパターン ──────────┘

[ファイルシステム]        [処理]                    [出力]

ファイル変更 ──────▶ DebouncedEvent ──────▶ WatchEvent
                          │
                          └─ イベント種別判定
                                  │
                                  ├─ Create
                                  ├─ Remove
                                  ├─ Write
                                  └─ Rename
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| watch.rs | `crates/nu-command/src/filesystem/watch.rs` | ソース | watch コマンド実装 |
| mod.rs | `crates/nu-command/src/filesystem/mod.rs` | ソース | filesystemモジュール定義 |
