# 通知設計書 33-missing index file

## 概要

本ドキュメントは、CoffeeScriptコンパイラでディレクトリを実行対象として指定した際にインデックスファイルが見つからない場合に発生するエラー通知「missing index file」の設計仕様を記載する。

### 本通知の処理概要

CoffeeScriptのCLI（`coffee`コマンド）でディレクトリを指定して直接実行（`--run`モード）しようとした際、そのディレクトリ内に`index.coffee`、`index.litcoffee`、または`index.coffee.md`が存在しない場合に、エラーメッセージを標準エラー出力に表示し、プロセスを終了コード1で終了する通知機能である。

**業務上の目的・背景**：Node.jsの慣習に従い、ディレクトリをモジュールとして実行する場合はインデックスファイルがエントリーポイントとして必要である。このエラー通知により、ユーザーはディレクトリ構造が正しくないことを認識し、適切なインデックスファイルを作成するか、直接ファイルを指定するよう促される。

**通知の送信タイミング**：`coffee`コマンドで`--run`モード（デフォルト）でディレクトリが指定された際、`findDirectoryIndex`関数内でCoffeeScriptの拡張子を持つインデックスファイルを検索し、いずれも見つからなかった時点で即座に通知される。

**通知の受信者**：コマンドラインでCoffeeScriptコンパイラを実行している開発者またはビルドシステム。標準エラー出力（stderr）に出力されるため、ターミナルまたはログ収集システムが受信者となる。

**通知内容の概要**：「Missing index.coffee or index.litcoffee in {ディレクトリパス}」の形式でエラー内容を出力する。ディレクトリパスは指定された絶対パスが表示される。

**期待されるアクション**：ユーザーはエラーメッセージを確認し、ディレクトリ内に`index.coffee`等のインデックスファイルを作成するか、直接実行したいファイルのパスを指定してコマンドを再実行することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高 |
| リトライ | 無し |

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（console.error） |
| 形式 | テキスト |

### 本文テンプレート

```
Missing index.coffee or index.litcoffee in {source}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| source | インデックスファイルが見つからなかったディレクトリの絶対パス | compilePath引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | findDirectoryIndex関数のループ終了 | FILE_EXTENSIONSの全てでindex.*が存在しない | インデックスファイル不在 |

### 前提条件

| 条件 | 説明 |
|-----|------|
| opts.runがtrue | 実行モードである（--compile等が指定されていない） |
| stats.isDirectory() | 指定パスがディレクトリである |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --compileモード | コンパイルモードではディレクトリ内の全ファイルを再帰処理するため、このエラーは発生しない |
| --watchモード | ディレクトリ監視モードではインデックス検索は行われない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[coffee ディレクトリ 実行] --> B[compilePath関数呼び出し]
    B --> C[fs.statSync source]
    C --> D{isDirectory?}
    D -->|No| E[ファイルとして処理]
    D -->|Yes| F{opts.run?}
    F -->|No| G[ディレクトリ再帰処理]
    F -->|Yes| H[findDirectoryIndex呼び出し]
    H --> I{index.coffee存在?}
    I -->|Yes| J[そのファイルをコンパイル]
    I -->|No| K{index.litcoffee存在?}
    K -->|Yes| J
    K -->|No| L{index.coffee.md存在?}
    L -->|Yes| J
    L -->|No| M[console.error Missing index...]
    M --> N[process.exit 1]
```

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

### 参照テーブル一覧

なし（ファイルシステムのみ参照）

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

| 操作 | 関数 | 目的 |
|-----|------|------|
| ファイル存在確認 | fs.statSync | インデックスファイルの存在とタイプ確認 |

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| インデックス不在 | 全インデックスファイルが存在しない | エラーメッセージを表示して終了 |
| ENOENT以外のエラー | ファイルアクセス権限等の問題 | 例外を再スロー |

### リトライ仕様

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

## 配信設定

### レート制限

なし（コマンド実行ごとに発生）

### 配信時間帯

制限なし

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

- ディレクトリパスがエラーメッセージに含まれるため、機密性の高いパス情報がログに記録される可能性がある
- プロセス終了コード1により、シェルスクリプトやCI/CDパイプラインでエラー検知が可能

## 備考

- FILE_EXTENSIONSは`['.coffee', '.litcoffee', '.coffee.md']`として定義されている
- `node_modules`ディレクトリは自動的にスキップされ、このエラーチェックは行われない

---

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

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

### 推奨読解順序

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

ファイル拡張子の定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | coffeescript.coffee | `src/coffeescript.coffee` | FILE_EXTENSIONS定義（17行目）を確認 |

**読解のコツ**: CoffeeScriptが認識するファイル拡張子の種類を把握しておく。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | command.coffee | `src/command.coffee` | compilePath関数（151-187行目）でディレクトリ処理分岐を確認 |

**主要処理フロー**:
1. **162行目**: `if stats.isDirectory()`でディレクトリ判定
2. **166-168行目**: `opts.run`の場合に`findDirectoryIndex`を呼び出し

#### Step 3: インデックスファイル検索処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | command.coffee | `src/command.coffee` | findDirectoryIndex関数（189-197行目）でインデックス検索ロジックを確認 |

**主要処理フロー**:
- **190行目**: `for ext in CoffeeScript.FILE_EXTENSIONS`で拡張子ループ
- **191行目**: `index = path.join source, "index#{ext}"`でパス構築
- **192-195行目**: fs.statSyncで存在確認、isFileの場合はそのパスを返す
- **196行目**: `console.error "Missing index.coffee or index.litcoffee in #{source}"`
- **197行目**: `process.exit 1`

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

```
exports.run (command.coffee:72)
    │
    └─ compilePath (command.coffee:151)
           │
           ├─ fs.statSync (Node.js fs module)
           │
           └─ [isDirectory && opts.run]
                  └─ findDirectoryIndex (command.coffee:189)
                         │
                         ├─ for ext in FILE_EXTENSIONS
                         │      └─ fs.statSync(index#{ext})
                         │
                         └─ [全て不在]
                                └─ console.error + process.exit(1)
```

### データフロー図

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

source (ディレクトリ) ───▶ findDirectoryIndex()
                                    │
                                    ▼
                         FILE_EXTENSIONS ループ
                                    │
                         ┌──────────┴──────────┐
                         │                     │
                         ▼                     ▼
                   index.* 存在          index.* 不在
                         │                     │
                         ▼                     ▼
                   そのパスを返す        console.error()
                                              │
                                              ▼
                                        process.exit(1)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| command.coffee | `src/command.coffee` | ソース | CLIエントリーポイント、インデックスファイル検索 |
| coffeescript.coffee | `src/coffeescript.coffee` | ソース | FILE_EXTENSIONS定義 |
