# 通知設計書 83-warnStdPrefix

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnStdPrefix」（stdプレフィックス警告）に関する設計仕様を記載する。

### 本通知の処理概要

本通知は、標準ライブラリモジュールをインポートする際に `std/` プレフィックスが付いていない場合に警告を発行するものである。これにより、標準ライブラリとサードパーティライブラリの区別を明確にし、名前衝突を防止する。

**業務上の目的・背景**：Nimの標準ライブラリは `std/` プレフィックスを付けてインポートすることが推奨される（例：`import std/strutils`）。プレフィックスなしでのインポート（例：`import strutils`）も動作するが、将来的にサードパーティライブラリと名前が衝突する可能性がある。この警告は、推奨されるインポートスタイルへの移行を促し、コードの移植性と明確性を向上させる。

**通知の送信タイミング**：インポート文の処理中（importer.nim内）に、標準ライブラリに属するモジュールが `std/` や `system/` 、`packages/` プレフィックスなしでインポートされていることを検出した時点で発行される。

**通知の受信者**：コンパイルを実行している開発者。ターミナルまたはIDEの出力ウィンドウに表示される。

**通知内容の概要**：「{モジュール名} needs the 'std' prefix」という形式で、stdプレフィックスが必要なモジュール名を示す。

**期待されるアクション**：開発者は警告を確認し、インポート文に `std/` プレフィックスを追加することが期待される（例：`import strutils` を `import std/strutils` に変更）。

## 通知種別

コンパイラ警告（Warning） - ターミナル/IDE出力

## 送信仕様

### 基本情報

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

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

コンパイラの標準エラー出力（stderr）または設定されたwritelnHookに出力される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: {モジュール名} needs the 'std' prefix [StdPrefix]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | モジュール名 | realModule.name.s | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | インポート文の処理 | 標準ライブラリモジュールがstd/プレフィックスなしでインポート | importer.nim内でのインポート解決時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:StdPrefix:off | コマンドラインオプションで抑制可能 |
| {.warning[StdPrefix]:off.} | プラグマで抑制可能 |
| デフォルトで無効 | NotesVerbosity[3]から除外されている |
| std/プレフィックス使用 | 正しいプレフィックスが使用されている場合 |
| system/プレフィックス使用 | systemモジュール配下の場合 |
| packages/プレフィックス使用 | packagesディレクトリ配下の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[インポート文解析] --> B{標準ライブラリに属する?}
    B -->|No| C[通常処理]
    B -->|Yes| D{std/プレフィックスあり?}
    D -->|Yes| C
    D -->|No| E{system/プレフィックスあり?}
    E -->|Yes| C
    E -->|No| F{packages/プレフィックスあり?}
    F -->|Yes| C
    F -->|No| G[警告メッセージ発行]
    G --> H[message関数呼び出し]
    H --> C
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

### 更新テーブル一覧

本通知はデータベースを使用しない。

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

なし。コンパイラ警告メッセージであり、機密情報を含まない。

## 備考

- デフォルトで無効（NotesVerbosity[3]から除外）
- 有効にするには `--warning:StdPrefix:on` が必要
- 警告IDは "StdPrefix"
- 標準ライブラリの推奨インポートスタイルへの移行を促進

---

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

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

### 推奨読解順序

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

警告メッセージの種類と定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnStdPrefixの定義（96行目）、MsgKindToStr配列でメッセージテンプレート（205行目）を確認 |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | NotesVerbosity計算（265行目）でwarnStdPrefixがデフォルト除外されていることを確認 |

**読解のコツ**: メッセージテンプレートは "$1 needs the 'std' prefix" で、$1にモジュール名が入る。

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

警告が発行される箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | importer.nim | `compiler/importer.nim` | 308-310行目でstd/プレフィックスなしのインポートを検出し、警告を発行 |

**主要処理フロー**:
1. **308行目**: belongsToStdlib関数で標準ライブラリ所属を確認
2. **308行目**: startsWith(moduleName, stdPrefix)でstd/プレフィックスを確認
3. **309行目**: system/やpackages/も除外条件として確認
4. **310行目**: message関数呼び出しで警告を出力

#### Step 3: 標準ライブラリ判定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | importer.nim | `compiler/importer.nim` | belongsToStdlib関数の実装を確認（モジュールが標準ライブラリに属するかの判定） |

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

```
importer.nim: myImportModule (インポート処理)
    │
    ├─ belongsToStdlib (標準ライブラリ判定)
    │
    ├─ getModuleName (モジュール名取得)
    │
    └─ msgs.nim: message (警告発行)
           │
           └─ msgs.nim: liMessage (メッセージ処理)
```

### データフロー図

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

インポート文 ───▶ importer.nim ───▶ 標準ライブラリ判定
   AST              myImportModule        │
                                          ▼
                                   プレフィックス確認
                                          │
                                          ▼
                                   msgs.nim ───▶ stderr/stdout
                                (message関数)     (警告メッセージ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義とメッセージテンプレート |
| importer.nim | `compiler/importer.nim` | ソース | インポート処理、警告発行トリガー |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| options.nim | `compiler/options.nim` | ソース | コンパイラオプション管理 |
