# 通知設計書 61-warnInconsistentSpacing

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnInconsistentSpacing` の設計仕様を定義する。この警告は、演算子の前後のスペース数が一貫していない場合に出力される。

### 本通知の処理概要

この警告は、Nimソースコードの構文解析（パース）フェーズにおいて、二項演算子周辺のスペーシングの一貫性をチェックし、不整合を検出した際に開発者に通知する機能を提供する。

**業務上の目的・背景**：Nimのコーディングスタイルでは、演算子の前後のスペースを一貫させることが推奨されている。例えば `a + b` のように前後にスペースを入れるか、`a+b` のようにスペースを入れないかを統一すべきである。`a +b` や `a+ b` のような不整合なスペーシングはコードの可読性を低下させ、意図しない構文解釈を招く可能性がある。この警告により、開発者はスタイルの不整合を早期に発見し、一貫性のある読みやすいコードを維持できる。

**通知の送信タイミング**：コンパイラのパーサー（構文解析器）が二項演算子を処理する際に、トークンの `spacing` 属性を検査する。演算子の後ろにのみスペースがある（`tsTrailing` のみがセットされている）状態を検出した場合に警告が発生する。

**通知の受信者**：Nimコンパイラを使用してソースコードをコンパイルしている開発者。コンパイル時の警告メッセージとして標準エラー出力またはビルドログに表示される。

**通知内容の概要**：「Number of spaces around '$#' is not consistent」（'$#' の周囲のスペース数が一貫していません）というメッセージが出力される。$# には該当する演算子のトークン表現が挿入される。

**期待されるアクション**：開発者は該当箇所のコードを確認し、演算子の前後のスペースを統一する。前後両方にスペースを入れる（推奨）か、両方ともスペースを入れないかのいずれかに修正する。

## 通知種別

コンパイラ警告メッセージ（stderr/ビルドログ出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル処理中に即座に出力） |
| 優先度 | 中（Warning） |
| リトライ | 無（コンパイル時の一度きりの出力） |

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

警告は、コンパイラオプションで `warnInconsistentSpacing`（短縮形: `Spacing`）が有効になっている場合に出力される。デフォルトで有効であり、`--warning:Spacing:off` で無効化可能。

## 通知テンプレート

### コンパイラ警告出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr |
| メッセージ種別 | Warning |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {カラム番号}) Warning: Number of spaces around '{演算子}' is not consistent [Spacing]
```

### 添付ファイル

なし（コンパイラ出力のため）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $# | 不整合が検出された演算子 | Token.ident.s または prettyTok(tok) | Yes |
| ファイルパス | ソースファイルのパス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告発生行 | TLineInfo.line | Yes |
| カラム番号 | 警告発生カラム | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | 二項演算子のパース | tok.spacing == {tsTrailing} | 演算子トークンの後ろにのみスペースがある |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:Spacing:off | コマンドラインオプションで明示的に無効化 |
| {.warning[Spacing]:off.} | プラグマで無効化 |
| verbosity レベル 0 | 最小出力モードでは出力されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[パーサーが演算子トークンを検出] --> B[checkBinary関数呼び出し]
    B --> C{tok.tokType == tkOpr?}
    C -->|No| D[処理終了]
    C -->|Yes| E{tok.spacing == tsTrailing?}
    E -->|No| D
    E -->|Yes| F[parMessage呼び出し]
    F --> G[警告メッセージ生成]
    G --> H[メッセージ出力]
    H --> D
```

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

本警告はコンパイラ内部処理であり、データベースは使用しない。

### 参照テーブル一覧

なし

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 警告メッセージのため、エラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

特になし。ソースコードの構文情報のみを扱い、機密情報は含まれない。

## 備考

- この警告は主にコードスタイルの一貫性を促すためのものであり、コンパイル結果には影響しない
- Nimのオフサイドルール（インデントベースの構文）との兼ね合いで、スペーシングの一貫性は特に重要
- `..` 演算子はこのチェックから除外されている（過度な警告を防ぐため）

---

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

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

### 推奨読解順序

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

まず、警告メッセージの種別とトークンのスペーシング情報を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnInconsistentSpacingの定義（76行目）とメッセージテンプレート（183行目）を確認 |
| 1-2 | lexbase.nim | `compiler/lexbase.nim` | Token構造体とspacing属性（TTokenSpacing）の定義を確認 |

**読解のコツ**: TMsgKindの命名規則を理解する。`warn`プレフィックスは警告を、`err`プレフィックスはエラーを、`hint`プレフィックスはヒントを示す。

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

処理の起点となるパーサーのcheckBinary関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | parser.nim | `compiler/parser.nim` | checkBinary関数（309-314行目）でスペーシングチェックが行われる |

**主要処理フロー**:
1. **309行目**: `proc checkBinary(p: Parser)` - 二項演算子チェック関数の定義
2. **312行目**: `if p.tok.tokType == tkOpr:` - トークンが演算子かどうかの判定
3. **313行目**: `if p.tok.spacing == {tsTrailing}:` - 後ろにのみスペースがあるかの判定
4. **314行目**: `parMessage(p, warnInconsistentSpacing, prettyTok(p.tok))` - 警告メッセージの出力

#### Step 3: メッセージ出力処理を理解する

警告メッセージがどのように出力されるかを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | parMessage関数とmessage関数の実装を確認 |
| 3-2 | lineinfos.nim | `compiler/lineinfos.nim` | MsgKindToStr配列でメッセージテンプレートを確認（183行目） |

**主要処理フロー**:
- **lineinfos.nim 183行目**: `warnInconsistentSpacing: "Number of spaces around '$#' is not consistent"` - メッセージテンプレート

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

```
parser.nim::parseExpr（式のパース）
    │
    ├─ parser.nim::checkBinary（二項演算子チェック）
    │      │
    │      └─ msgs.nim::parMessage（パーサーメッセージ出力）
    │              │
    │              └─ msgs.nim::message（一般メッセージ出力）
    │                      │
    │                      └─ lineinfos.nim::MsgKindToStr（テンプレート参照）
    │
    └─ 通常のパース処理継続
```

### データフロー図

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

ソースコード ───▶ Lexer（字句解析）───▶ Token列
                          │
                          ▼
                 Parser（構文解析）
                          │
                          ▼
                 checkBinary
                 ┌─────────────────┐
Token.spacing ───▶│ tsTrailingのみ？ │
                 └────────┬────────┘
                          │Yes
                          ▼
                    parMessage ───▶ stderr（警告出力）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義とメッセージテンプレート |
| parser.nim | `compiler/parser.nim` | ソース | 構文解析とcheckBinary関数 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数 |
| lexbase.nim | `compiler/lexbase.nim` | ソース | Token構造体の定義 |
