# 通知設計書 28-warnSmallLshouldNotBeUsed

## 概要

本ドキュメントは、Nimコンパイラにおける警告通知「warnSmallLshouldNotBeUsed」の設計仕様を定義する。この警告は、小文字の「l」（エル）が識別子として使用された場合に発生する警告である。

### 本通知の処理概要

この通知は、ソースコード内で単独の小文字「l」が識別子として使用された場合に発生する。小文字の「l」は数字の「1」（イチ）と視覚的に非常に似ているため、コードの可読性を低下させ、バグの原因となりうることから警告が発せられる。

**業務上の目的・背景**：プログラミングにおいて、変数名の可読性は非常に重要である。多くのフォントでは小文字の「l」と数字の「1」が視覚的にほぼ同じに見えるため、コードの読み間違いやタイプミスによるバグが発生しやすい。この警告により、開発者はより明確な変数名を選択するよう促される。これはコードレビューの効率化とバグの予防に貢献する。

**通知の送信タイミング**：コンパイル時の意味解析フェーズで、識別子が「l」であることが検出された場合に送信される可能性がある。

**通知の受信者**：Nimソースコードをコンパイルしている開発者（標準エラー出力またはIDEツール経由）。

**通知内容の概要**：「'l' should not be used as an identifier; may look like '1' (one)」というメッセージが出力される。

**期待されるアクション**：開発者は該当する変数名を、より明確で読みやすい名前（例：「len」、「length」、「left」など）に変更する。ループカウンタとして使用している場合は「i」、「j」、「idx」などを検討する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

標準エラー出力（stderr）に出力される。IDEツール（nimsuggest等）使用時は、構造化されたエラーフック経由でIDEに通知される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（デフォルト）/ stdout（--stdout指定時） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行},{列}) Warning: 'l' should not be used as an identifier; may look like '1' (one) [SmallLshouldNotBeUsed]
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| - | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | 識別子解析 | 識別子名が「l」（小文字エル）の場合 | 単一文字識別子のチェック |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:SmallLshouldNotBeUsed:off | この特定の警告が無効化されている場合 |
| --warnings:off | 全ての警告が無効化されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[識別子検出] --> B{識別子名が'l'?}
    B -->|No| C[通常処理継続]
    B -->|Yes| D[warnSmallLshouldNotBeUsed発行]
    D --> E[message呼び出し]
    E --> F[liMessage呼び出し]
    F --> G[styledMsgWriteln出力]
    G --> C
```

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

### 参照テーブル一覧

該当なし（ソースコード解析のみ）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| - | この警告自体はエラーではない | 警告を出力し処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 識別子名「l」がメッセージに間接的に含まれるが、機密情報ではないためセキュリティリスクは低い
- コードの可読性向上によりセキュリティレビューの品質向上に寄与

## 備考

- この警告はコードスタイルの観点から設計されている
- 類似の警告として、他の紛らわしい文字の使用を警告するものが追加される可能性がある
- 多くのコーディング規約でも小文字「l」の単独使用は推奨されていない
- 現在のコードベースでは、この警告の具体的な発行箇所が限定的である可能性がある

---

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

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

### 推奨読解順序

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

まず、メッセージ種別の定義と警告メッセージの文字列を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnSmallLshouldNotBeUsedの定義（55行目）、MsgKindToStr配列でメッセージ文字列の定義（148行目） |

**読解のコツ**: warnSmallLshouldNotBeUsedは「SmallLshouldNotBeUsed」という文字列キーを持つ。メッセージは固定文字列で、変数を含まない。

#### Step 2: 発行箇所を理解する

警告が発行される可能性のあるコード箇所を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.nim | `compiler/lexer.nim` | 識別子の字句解析処理 |
| 2-2 | semstmts.nim | `compiler/semstmts.nim` | 変数宣言の意味解析処理 |

**読解のコツ**: 識別子が「l」であるかどうかのチェックは、字句解析または意味解析のいずれかで行われる可能性がある。

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

```
[識別子処理]
    │
    ├─ 識別子名取得
    │      └─ 名前 = "l" かどうか判定
    │
    └─ 警告発行（該当時）
           │
           └─ message (compiler/msgs.nim:641)
                  │
                  └─ liMessage (compiler/msgs.nim:536)
                         │
                         └─ styledMsgWriteln (compiler/msgs.nim:401)
```

### データフロー図

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

識別子 ───▶ 名前チェック ───▶ 'l'判定 ───▶ warnSmallLshouldNotBeUsed
    │              │            │                    │
    └─ "l" ───────┘            │                    └─ stderr
                                │
              識別子名が'l' ────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型とメッセージ文字列の定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数群の実装 |
| lexer.nim | `compiler/lexer.nim` | ソース | 字句解析器（識別子解析） |
| semstmts.nim | `compiler/semstmts.nim` | ソース | 文の意味解析（変数宣言処理） |
