# 通知設計書 37-warnRstStyle

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（nim doc）において、RST/Markdownドキュメント内のスタイル上の問題が検出された場合に出力される警告「warnRstStyle」の設計仕様を記述する。

### 本通知の処理概要

本警告は、RST（reStructuredText）またはMarkdown形式のドキュメント内で、文法的には正しいが推奨されないスタイルや、潜在的な問題がある記述が検出された場合に開発者へ通知するものである。これは純粋なRSTモードではエラーとなる問題が、Markdown優先モードでは警告として扱われる場合にも使用される。

**業務上の目的・背景**：ドキュメントの品質と一貫性を維持するため、RSTの厳密な仕様に従わない記述や、誤解を招きやすい記述を検出する。特にMarkdown優先モード（roPreferMarkdown）では、RSTパースエラーを警告に降格させることで、より寛容なパース処理を実現しつつも、問題点を通知する。

**通知の送信タイミング**：`nim doc`コマンドによるドキュメント生成時、RSTパーサー内で以下のような状況が検出された場合にトリガーされる：
- インデントが不適切な場合
- コロンの使用が不適切な場合
- 引用リテラルブロックの形式が不正な場合
- 列挙リストの記述が曖昧な場合

**通知の受信者**：Nimソースコードまたはスタンドアロンのドキュメントファイル（.rst/.md）を編集している開発者・ドキュメント作成者。

**通知内容の概要**：「RST style: $1」形式で、スタイル上の問題の詳細が通知される。$1には具体的な問題の説明が入る。

**期待されるアクション**：開発者は指摘されたスタイル上の問題を修正し、より明確で一貫性のあるドキュメントを作成する必要がある。

## 通知種別

コンパイラ警告メッセージ（標準エラー出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（Warning） |
| リトライ | 無 |

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

コンパイラの設定に基づき、標準エラー出力へ警告メッセージを出力する。`--warning[warnRstStyle]:off`オプションで抑止可能。

## 通知テンプレート

### コンパイラ警告メッセージの場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準エラー出力 |
| 重要度 | Warning |
| メッセージID | warnRstStyle |
| 形式 | テキスト |

### メッセージテンプレート

```
{ファイルパス}({行},{列}) Warning: RST style: {問題の詳細} [warnRstStyle]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | スタイル問題の詳細説明 | RSTパーサー | Yes |
| filename | ソースファイルパス | TLineInfo.fileIndex | Yes |
| line | 行番号 | TLineInfo.line | Yes |
| col | 列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | nim doc コマンド実行 | Markdownコードブロックのインデント不正 | 1623行目付近 |
| ドキュメント生成 | nim doc コマンド実行 | ディレクティブ後の空白不足 | 1919行目付近 |
| ドキュメント生成 | nim doc コマンド実行 | コロンの数が不正 | 1923,1927行目付近 |
| ドキュメント生成 | nim doc コマンド実行 | 引用リテラルブロックの改行不足 | 2153行目付近 |
| ドキュメント生成 | nim doc コマンド実行 | 引用リテラルブロックのインデント不正 | 2156行目付近 |
| ドキュメント生成 | nim doc コマンド実行 | 見出しテキストのインデント | 2209行目付近 |
| ドキュメント生成 | nim doc コマンド実行 | 引用ブロック後に非引用行 | 2477行目付近 |
| ドキュメント生成 | nim doc コマンド実行 | 列挙リストの記述が曖昧 | 3043行目付近 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning[warnRstStyle]:off | コマンドラインオプションで警告を無効化 |
| {.warning[warnRstStyle]:off.} | ソースコード内プラグマで警告を無効化 |
| 純粋RSTモード | stopOrWarn関数でエラーとして扱われる |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc コマンド実行] --> B[RSTパーサー]
    B --> C{スタイル問題検出}
    C -->|インデント問題| D[stopOrWarn呼び出し]
    C -->|コロン問題| D
    C -->|引用ブロック問題| D
    C -->|列挙リスト問題| D
    D --> E{isPureRst?}
    E -->|Yes| F[元のエラーとして発行]
    E -->|No| G[mwRstStyleとして発行]
    G --> H[compilerMsgHandler呼び出し]
    H --> I[warnRstStyleに変換]
    I --> J[警告メッセージ出力]
    F --> K[エラー処理]
    J --> L[処理継続]
```

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

### 参照テーブル一覧

なし

### テーブル別参照項目詳細

なし

### 更新テーブル一覧

なし（読み取り専用処理）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| スタイル警告 | 推奨されない記述スタイル | 警告出力、処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- スタイル警告はユーザー入力由来だが、警告メッセージへの出力のみで特別なセキュリティリスクなし

## 備考

- mwRstStyleは「メタ警告」として機能し、純粋RSTモードではエラーとなる問題をMarkdown優先モードで警告に降格させる
- stopOrWarn関数により、モードに応じてエラー/警告が切り替わる
- rstWarnings集合に含まれる（範囲の終端）

---

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

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

### 推奨読解順序

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

まず、警告の種類定義とstopOrWarnの仕組みを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnRstStyleの定義（63行目）とメッセージ文字列（157行目）を確認 |
| 1-2 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型でmwRstStyleの定義（77行目）を確認 |
| 1-3 | rst.nim | `lib/packages/docutils/rst.nim` | stopOrWarn関数（608-614行目）でモードに応じた警告/エラー切り替えを確認 |

**読解のコツ**: stopOrWarnはisPureRst()がtrueの場合は元のエラー種別を使用し、falseの場合はmwRstStyleに変換する。

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

処理の起点となるドキュメント生成モジュールを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | docgen.nim | `compiler/docgen.nim` | compilerMsgHandler関数（242-277行目）でRSTメッセージをコンパイラ警告に変換 |

**主要処理フロー**:
1. **266行目**: `of mwRstStyle: k = warnRstStyle` - メッセージ種別のマッピング
2. **271-277行目**: `globalError`または`liMessage`で警告出力

#### Step 3: 各種スタイル警告の発生箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rst.nim | `lib/packages/docutils/rst.nim` | 各stopOrWarn呼び出し箇所を確認 |

**主要処理フロー**:
- **1623行目**: Markdownコードブロックのインデント不正
- **1919行目**: ディレクティブ後の空白不足
- **1923行目**: ダブルコロン欠落の警告
- **1927行目**: コロンの数が多すぎる警告
- **2153行目**: 引用リテラルブロック後の改行不足
- **2156行目**: 引用リテラルブロックのインデント不正
- **2209行目**: 見出しテキストのインデント警告
- **2477行目**: 引用ブロック後に非引用行が続く
- **3043行目**: 列挙リストの記述が曖昧

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

```
nim doc (main.nim)
    │
    ├─ commandDoc (docgen2.nim)
    │      │
    │      └─ generateDoc (docgen.nim)
    │             │
    │             ├─ newDocumentor
    │             │      └─ declareClosures
    │             │             └─ compilerMsgHandler [266行目]
    │             │
    │             └─ RSTパース
    │                    ├─ parseMarkdownCodeblock [1623行目]
    │                    │      └─ mwRstStyle (インデント)
    │                    │
    │                    ├─ getDirective [1919,1923,1927行目]
    │                    │      └─ mwRstStyle (コロン)
    │                    │
    │                    ├─ parseQuotedLiteralBlock [2153,2156行目]
    │                    │      └─ stopOrWarn → mwRstStyle
    │                    │
    │                    ├─ parseSection [2209行目]
    │                    │      └─ mwRstStyle (見出し)
    │                    │
    │                    ├─ parseQuoteBlock [2477行目]
    │                    │      └─ mwRstStyle (引用)
    │                    │
    │                    └─ parseEnumList [3043行目]
    │                           └─ mwRstStyle (列挙)
    │
    └─ 警告出力 (msgs.nim)
```

### データフロー図

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

.nim/.rst/.md ───▶ RSTパーサー ───▶ PRstNode (AST)
     ファイル         │
                      │
                      ├─ スタイル問題検出
                      │      │
                      │      └─ stopOrWarn
                      │             │
                      │             ├─ isPureRst=true ───▶ 元のエラー種別
                      │             │
                      │             └─ isPureRst=false ───▶ mwRstStyle ───▶ 警告出力
                      │
                      └─ 処理継続（可能な限り）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義（TMsgKind） |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成、メッセージハンドラ |
| rst.nim | `lib/packages/docutils/rst.nim` | ソース | RSTパーサー本体、stopOrWarn関数 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
