# 通知設計書 39-file removal log

## 概要

本ドキュメントは、CoffeeScriptコンパイラでファイル監視中にソースファイルが削除された際に表示される情報通知「file removal log」の設計仕様を記載する。

### 本通知の処理概要

CoffeeScriptのCLI（`coffee`コマンド）で`--watch`オプションを使用してファイル監視を行っている際、監視対象のソースファイルが削除されると、対応するコンパイル済みJavaScriptファイル（およびソースマップファイル）も自動的に削除され、その旨をタイムスタンプ付きのログメッセージとして標準出力に表示する通知機能である。

**業務上の目的・背景**：ファイル監視モードでは、ソースファイルと生成ファイルの同期を維持することが重要である。ソースファイルが削除された場合、対応するJavaScriptファイルも削除することで、不要なファイルが残ることを防ぐ。この通知により、開発者はどのファイルが削除されたかを認識できる。

**通知の送信タイミング**：`--watch`モードでファイル監視中にソースファイルが検出できなくなった（ENOENTエラーが発生した）際、`removeSource`関数内でコンパイル済みファイルの削除処理後に通知される。

**通知の受信者**：コマンドラインでCoffeeScriptコンパイラをwatchモードで実行している開発者。標準出力（stdout）に出力されるため、ターミナルに表示される。

**通知内容の概要**：「{タイムスタンプ} - removed {ソースファイルパス}」の形式でログメッセージを出力する。タイムスタンプはローカルタイムゾーンの時刻を使用する。

**期待されるアクション**：特に必要なアクションはない。開発者はこのメッセージを確認することで、ソースファイルの削除が検出され、対応するコンパイル済みファイルも削除されたことを認識できる。

## 通知種別

コンソール出力（標準出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低（情報通知） |
| リトライ | 無し |

### 送信先決定ロジック

標準出力（stdout）への直接出力のため、受信者決定ロジックは不要。コマンド実行元のターミナルに出力される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stdout（console.log経由のtimeLog関数） |
| 形式 | テキスト |

### 本文テンプレート

```
{timestamp} - removed {source}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| timestamp | ローカル時刻のタイムスタンプ | new Date().toLocaleTimeString() | Yes |
| source | 削除されたソースファイルのパス | removeSource関数の引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイル監視 | ソースファイルのENOENT検出 | !opts.join | joinモードでない場合 |

### 前提条件

| 条件 | 説明 |
|-----|------|
| opts.watch === true | --watchオプションが指定されている |
| ソースファイルが削除された | fs操作でENOENTエラーが発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| opts.join === true | --joinオプション使用時は通知されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[watchモードでファイル監視中] --> B[ファイルアクセス試行]
    B --> C{ENOENT発生?}
    C -->|No| D[正常処理継続]
    C -->|Yes| E[removeSource関数呼び出し]
    E --> F[sources配列から削除]
    F --> G{opts.join?}
    G -->|Yes| H[compileJoin呼び出し]
    G -->|No| I[silentUnlink jsファイル]
    I --> J[silentUnlink mapファイル]
    J --> K[timeLog removed source]
    K --> L[処理終了]
```

## データベース参照・更新仕様

### 参照テーブル一覧

なし

### ファイルシステム操作

| 操作 | 関数 | 目的 |
|-----|------|------|
| ファイル削除 | fs.unlinkSync（silentUnlink経由） | JSファイル・ソースマップの削除 |

### 更新テーブル一覧

なし

### 内部データ構造の更新

| 配列名 | 操作 | 説明 |
|--------|------|------|
| sources | splice | ソースファイルリストから削除 |
| sourceCode | splice | ソースコードキャッシュから削除 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ENOENT | 削除対象ファイルが存在しない | silentUnlinkでエラーを無視 |
| EPERM | 削除権限がない | silentUnlinkでエラーを無視 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

なし（ファイル削除検出ごとに表示）

### 配信時間帯

制限なし（watchモード実行中は継続的に監視）

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

- ソースファイルパスがログに出力されるため、機密性の高いパス情報が表示される可能性がある
- ローカル環境での開発用途が主であり、セキュリティリスクは低い

## 備考

- silentUnlink関数はENOENTおよびEPERMエラーを無視するため、削除対象ファイルが既に存在しない場合でもエラーにならない
- `--join`オプション使用時は、ソースファイルが削除されてもJSファイルは削除されず、結合処理が再実行される
- ディレクトリ監視（watchDir）の場合も、内部のファイル削除でremoveSourceが呼ばれる

---

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

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

### 推奨読解順序

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

ソース管理に関連するデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | command.coffee | `src/command.coffee` | sources配列、sourceCode配列（60-61行目）を確認 |
| 1-2 | command.coffee | `src/command.coffee` | timeLog関数（432-433行目）を確認 |

**読解のコツ**: sourcesとsourceCodeは同じインデックスで対応していることを理解する。

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

処理の起点となる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | command.coffee | `src/command.coffee` | watch関数（274-317行目）でファイル監視を確認 |
| 2-2 | command.coffee | `src/command.coffee` | watchErr関数（279-287行目）でENOENT処理を確認 |

**主要処理フロー**:
1. **279行目**: `watchErr = (err) ->`でエラーハンドリング定義
2. **280行目**: ENOENTエラーでない場合は例外をスロー
3. **286行目**: `removeSource source, base`呼び出し

#### Step 3: ファイル削除処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | command.coffee | `src/command.coffee` | removeSource関数（360-367行目）でログ出力を確認 |
| 3-2 | command.coffee | `src/command.coffee` | silentUnlink関数（369-373行目）でエラー無視を確認 |

**主要処理フロー**:
- **360行目**: `removeSource = (source, base) ->`
- **361-363行目**: sources、sourceCode配列からの削除
- **364行目**: `unless opts.join`条件分岐
- **365行目**: `silentUnlink outputPath source, base`
- **366行目**: `silentUnlink outputPath source, base, '.js.map'`
- **367行目**: `timeLog "removed #{source}"`

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

```
watch (command.coffee:274)
    │
    └─ watchErr (command.coffee:279)
           │
           └─ [ENOENT]
                  └─ removeSource (command.coffee:360)
                         │
                         ├─ sources.splice (ソースリスト更新)
                         │
                         ├─ sourceCode.splice (コードキャッシュ更新)
                         │
                         └─ [!opts.join]
                                │
                                ├─ silentUnlink (JSファイル削除)
                                │
                                ├─ silentUnlink (ソースマップ削除)
                                │
                                └─ timeLog "removed #{source}"
```

### データフロー図

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

ファイルアクセスエラー ───▶ watchErr()
(ENOENT)                        │
                                ▼
                         removeSource()
                                │
                    ┌───────────┴───────────┐
                    │                       │
                    ▼                       ▼
             sources.splice          [!opts.join]
             sourceCode.splice              │
                                           ▼
                                   silentUnlink(JS)
                                   silentUnlink(MAP)
                                           │
                                           ▼
                                     timeLog()
                                           │
                                           ▼
                    console.log("{timestamp} - removed {source}")
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| command.coffee | `src/command.coffee` | ソース | CLIエントリーポイント、ファイル監視、削除処理 |
