# 通知設計書 13-missing indentation

## 概要

本ドキュメントは、CoffeeScriptコンパイラにおける「missing indentation」（インデント不足エラー）通知の設計仕様を定義する。

### 本通知の処理概要

この通知は、CoffeeScriptソースコード内で初期インデントレベル（ベースインデント）より少ないインデントが検出された場合に発生する構文エラーを開発者に通知するものである。

**業務上の目的・背景**：CoffeeScriptでは、ファイルの先頭で設定されたベースインデントレベルを下回るインデントは許可されない。これは、コード構造の一貫性を保ち、意図しないブロック終了を防ぐために重要である。この通知により、開発者はインデント構造の問題を早期に発見し、修正できる。

**通知の送信タイミング**：字句解析（Lexer）フェーズにおいて、`lineToken`メソッドが改行とインデントを処理する際に発生する。現在行のインデントサイズが`@baseIndent`より小さい場合に検出される。

**通知の受信者**：CoffeeScriptコードをコンパイルしている開発者。コマンドラインツール、REPL、またはプログラムからの呼び出し時に、標準エラー出力またはエラーオブジェクトとして通知される。

**通知内容の概要**：エラーメッセージ「missing indentation」と、該当するソースコード内の位置情報（行番号・列番号）が含まれる。

**期待されるアクション**：開発者は該当行のインデントを確認し、ファイル先頭で確立されたベースインデントレベル以上になるよう修正する必要がある。または、ファイル全体のインデント構造を見直す。

## 通知種別

コンパイルエラー（SyntaxError）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時即時） |
| 優先度 | 高（コンパイル停止） |
| リトライ | なし |

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

コンパイラ呼び出し元に対してエラーがスローされる。CLIの場合は標準エラー出力、プログラムAPIの場合は例外としてスローされる。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | `[ファイル名]:行:列: error: missing indentation` |
| 形式 | テキスト |

### 本文テンプレート

```
[stdin]:2:1: error: missing indentation
  a
b-
^
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| first_line | エラー発生行番号 | Lexer.getLineAndColumnFromChunk | Yes |
| first_column | エラー発生列番号 | Lexer.getLineAndColumnFromChunk | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | lineTokenメソッド実行 | `size < @baseIndent` | インデントサイズがベースインデント未満 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 適正インデント | インデントサイズがベースインデント以上の場合はエラーなし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[lineTokenメソッド呼び出し]
    B --> C[改行・インデント検出]
    C --> D[インデントサイズ計算]
    D --> E{size < @baseIndent?}
    E -->|Yes| F[error 'missing indentation' 呼び出し]
    E -->|No| G[通常処理継続]
    F --> H[throwSyntaxError]
    H --> I[コンパイル停止]
```

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

### 参照テーブル一覧

該当なし（ファイルベースの処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | インデントがベースインデント未満 | インデントを追加するか、ファイル構造を見直す |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

該当なし（即時エラー通知）

### 配信時間帯

制限なし

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

特になし。ソースコードの内容がエラーメッセージに含まれる可能性があるが、開発時のみ表示されるため問題なし。

## 備考

- `@baseIndent`はファイル内の最初のインデント行で設定される
- トップレベルのコードでも、最初に設定されたベースインデントを下回ることはできない
- Issue #2981に関連して、初期インデントの強制が実装された

---

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

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

### 推奨読解順序

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

Lexerクラスの状態管理変数を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | `@baseIndent`変数（40行目）がベースインデントレベルを保持 |

**読解のコツ**: `@baseIndent`と`@indent`は異なる概念。`@baseIndent`は最小許容インデントレベル、`@indent`は現在のインデントレベル。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.coffee | `src/lexer.coffee` | tokenizeメソッド（37行目〜）でbaseIndentが初期化される |

**主要処理フロー**:
1. **40行目**: `@baseIndent = 0`で初期化
2. **549行目**: 最初のインデント行で`@baseIndent = @indent = size`が設定される

#### Step 3: 実際のエラー検出ロジック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` (559-560行) | ベースインデント以下のチェック |

**主要処理フロー**:
- **541行目**: `if size > @indent`で増加インデントの処理
- **559-560行目**: `else if size < @baseIndent`の条件で`'missing indentation'`エラー
- **offset: offset + indent.length**でエラー位置を指定

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

```
CoffeeScript.compile(source)
    │
    └─ Lexer.tokenize(code)
           │
           ├─ lineToken()
           │      ├─ size計算
           │      ├─ @baseIndent設定（初回）
           │      └─ size < @baseIndent チェック
           │             └─ error('missing indentation')
           │                    └─ throwSyntaxError()
           │
           └─ 他のトークン処理メソッド
```

### データフロー図

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

ソースコード ───▶ Lexer.lineToken() ───▶ SyntaxError例外
     │                    │
     │              size計算
     │              (indent.length - 1 - indent.lastIndexOf '\n')
     │                    ↓
     └─ 現在行 ────▶ size < @baseIndent 比較
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lexer.coffee | `src/lexer.coffee` | ソース | 字句解析器本体、エラー検出ロジック（559-560行目） |
| helpers.coffee | `src/helpers.coffee` | ソース | throwSyntaxError関数の定義 |
| formatting.coffee | `test/formatting.coffee` | テスト | missing indentationのテストケース（282-287行目） |
