# 通知設計書 13-errRstInvalidDirectiveX

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（docgen）およびRST/Markdownパーサーにおける無効ディレクティブエラー通知「errRstInvalidDirectiveX」の設計について記述する。

### 本通知の処理概要

errRstInvalidDirectiveXは、reStructuredText（RST）またはMarkdownドキュメント内で認識されないディレクティブが使用された場合に発生するエラー通知である。

**業務上の目的・背景**：RST/Markdownドキュメントでは、`.. directive::` 形式でディレクティブを使用して特別な処理（コードブロック、画像挿入、警告ボックスなど）を指定する。パーサーがサポートしていないディレクティブ名が指定された場合、ユーザーに修正を促すためにこのエラーを報告する。これにより、タイプミスや未サポート機能の使用を早期に検出できる。

**通知の送信タイミング**：以下の状況でRST/Markdownパーサーがディレクティブを解析する際に発生する：
1. selectDir関数でサポートされていないディレクティブ名が指定された場合
2. `.. raw::` ディレクティブでroSupportRawDirectiveオプションが無効な場合
3. 置換定義（`.. |name|`）で無効なディレクティブが使用された場合

**通知の受信者**：Nimコンパイラを使用してドキュメント生成（nim doc）を実行している開発者。

**通知内容の概要**：エラーが発生したファイル名、行番号、列番号、および無効なディレクティブ名を含むエラーメッセージ。

**期待されるアクション**：開発者はエラーメッセージに基づいて、正しいディレクティブ名に修正するか、カスタムディレクティブの場合は適切な設定を追加する。

## 通知種別

コンパイラ標準エラー出力（stderr）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高（エラー） |
| リトライ | なし |

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

コンパイラのエラー出力設定（`ConfigRef.m.errorOutputs`）に基づいて、標準エラー出力またはフックされたハンドラに送信される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（docgen/rst） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Error: invalid directive: '{ディレクティブ名}'
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 無効なディレクティブ名 | パーサーが検出したディレクティブ文字列 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | ディレクティブ解析 | 未知のディレクティブ名 | selectDir関数でのマッチング失敗 |
| ドキュメント生成 | rawディレクティブ解析 | roSupportRawDirective無効 | rawディレクティブのセキュリティ制限 |
| ドキュメント生成 | 置換定義解析 | 無効なディレクティブ | `.. |name|` 構文での無効指定 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| errorsAsWarnings | roPreferMarkdownオプション有効かつスタンドアロンドキュメントでない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[RST/Markdownパース開始] --> B[ディレクティブ検出]
    B --> C[selectDir関数呼び出し]
    C --> D{サポートされたディレクティブ?}
    D -->|Yes| E[ディレクティブ処理実行]
    D -->|No| F{rawディレクティブ?}
    F -->|Yes| G{roSupportRawDirective有効?}
    G -->|Yes| E
    G -->|No| H[meInvalidDirective発行]
    F -->|No| H
    H --> I[docgen.compilerMsgHandler]
    I --> J[errRstInvalidDirectiveXに変換]
    J --> K[globalErrorとして出力]
    E --> L[終了]
    K --> L
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 未知のディレクティブ | サポートされていないディレクティブ名 | 正しいディレクティブ名を確認して修正 |
| rawディレクティブ制限 | roSupportRawDirectiveオプション無効 | セキュリティ要件を確認し必要なら有効化 |
| タイプミス | ディレクティブ名のスペルミス | 正しいスペルに修正 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（コンパイル実行時に即時出力）

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

- `raw` ディレクティブはroSupportRawDirectiveオプションで制御され、デフォルトで無効
- サンドボックスモードでは、許可リスト（SandboxDirAllowlist）に含まれるディレクティブのみ使用可能

## 備考

- サポートされているディレクティブ: admonition, attention, caution, code, code-block, container, contents, danger, default-role, error, figure, hint, image, important, include, index, note, raw, role, tip, title, warning
- サンドボックスモードで許可されるディレクティブはSandboxDirAllowlistで定義

---

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

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

### 推奨読解順序

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

RSTパーサーで使用されるメッセージ種別とサポートディレクティブリストを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型のmeInvalidDirective定義（68行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のerrRstInvalidDirectiveX定義（42行目） |
| 1-3 | rst.nim | `lib/packages/docutils/rst.nim` | SandboxDirAllowlist定義（139-142行目） |

**読解のコツ**: サンドボックスモードで許可されるディレクティブのリストを確認することで、セキュリティ制限を理解できる。

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

ディレクティブ選択とエラー発行箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | rst.nim | `lib/packages/docutils/rst.nim` | selectDir関数（3469-3503行目） |
| 2-2 | rst.nim | `lib/packages/docutils/rst.nim` | dirRaw関数（3456行目）での無効チェック |
| 2-3 | rst.nim | `lib/packages/docutils/rst.nim` | parseDotDot関数（3551行目）での置換定義チェック |

**主要処理フロー**:
1. **3469行目**: selectDir関数でディレクティブ名に基づいて処理を分岐
2. **3497行目**: rawディレクティブでroSupportRawDirectiveチェック
3. **3503行目**: 未知のディレクティブでmeInvalidDirective発行
4. **3456行目**: dirRawで無効な出力形式に対してmeInvalidDirective発行
5. **3551行目**: parseDotDotで置換定義の無効ディレクティブチェック

#### Step 3: メッセージ変換レイヤーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | docgen.nim | `compiler/docgen.nim` | compilerMsgHandler関数（255行目）でメッセージ変換 |

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

```
nim doc (ドキュメント生成コマンド)
    │
    ├─ docgen.nim::generateDoc
    │      │
    │      └─ rst.nim::rstParse
    │             │
    │             └─ parseDotDot
    │                    │
    │                    ├─ selectDir (3469-3503行目)
    │                    │      │
    │                    │      ├─ case d of "code", "image", etc. -> 処理実行
    │                    │      │
    │                    │      └─ else -> rstMessage(meInvalidDirective)
    │                    │
    │                    └─ 置換定義解析 (3551行目)
    │                           └─ rstMessage(meInvalidDirective)
    │
    └─ docgen.nim::compilerMsgHandler (255行目)
           │
           └─ msgs.nim::globalError (errRstInvalidDirectiveX)
```

### データフロー図

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

RST/Markdownファイル ───▶ rst.nim::parseDotDot ───▶ ディレクティブ名抽出
(".. unknown_dir::")           │
                               ▼
                         selectDir(d)
                               │
                               ▼ [未知のディレクティブ]
                         rstMessage(meInvalidDirective, d)
                               │
                               ▼
                         docgen.nim::compilerMsgHandler
                               │
                               ▼
                         TMsgKind(errRstInvalidDirectiveX)
                               │
                               ▼
                         stderr / 構造化エラーフック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| rst.nim | `lib/packages/docutils/rst.nim` | ソース | RST/Markdownパーサー本体、selectDir関数 |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成器、メッセージハンドラ |
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | コンパイラメッセージシステム |
