# 通知設計書 26-warnConfigDeprecated

## 概要

本ドキュメントは、Nimコンパイラにおける警告通知「warnConfigDeprecated」の設計仕様を定義する。この警告は、非推奨（deprecated）の設定ファイルが使用された場合に発生する警告である。

### 本通知の処理概要

この通知は、コンパイラが非推奨とマークされた設定ファイル（.cfg, .nims）を読み込んだ場合に発生する。設定ファイルの非推奨化は、設定形式の変更や新しい設定方式への移行を促すために使用される。

**業務上の目的・背景**：Nimコンパイラの設定システムは進化しており、古い設定ファイルや形式が新しいものに置き換えられることがある。この警告を発することで、プロジェクト管理者に設定ファイルの更新が必要であることを通知し、将来の互換性問題を事前に回避できるようにする。

**通知の送信タイミング**：コンパイル開始時の設定ファイル読み込みフェーズで、非推奨とマークされた設定ファイルが検出された場合に送信される。

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

**通知内容の概要**：「config file '$1' is deprecated」というメッセージが出力され、$1には非推奨の設定ファイルのパスが代入される。

**期待されるアクション**：開発者は非推奨の設定ファイルを確認し、推奨される新しい設定形式または設定ファイルに移行する。ドキュメントを参照して適切な移行方法を確認する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行},{列}) Warning: config file '{設定ファイルパス}' is deprecated [ConfigDeprecated]
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 非推奨の設定ファイルパス | 設定ファイル読み込み処理 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | 設定ファイル読み込み | 非推奨マークされた設定ファイルの読み込み | 設定システムでの検出 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[設定ファイル検索] --> B[設定ファイル検出]
    B --> C{非推奨マーク?}
    C -->|No| D[通常の設定読み込み]
    C -->|Yes| E[warnConfigDeprecated発行]
    E --> F[message呼び出し]
    F --> G[liMessage呼び出し]
    G --> H[styledMsgWriteln出力]
    H --> D
```

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

### 参照テーブル一覧

該当なし（ファイルシステムと設定メタデータを参照）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 設定ファイルのパスがメッセージに含まれるが、ローカル環境でのコンパイル時のみ出力されるため、セキュリティリスクは低い
- 設定ファイルの存在情報が漏洩する可能性はあるが、影響は限定的

## 備考

- `warnDeprecated`とは異なり、設定ファイル専用の警告として設計されている
- 設定ファイルの非推奨化は通常、コンパイラのバージョンアップに伴って行われる
- 現在のコードベースでは、この警告の具体的な発行箇所が限定的である可能性がある

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: warnConfigDeprecatedは「ConfigDeprecated」という文字列キーを持つ。メッセージテンプレートは「config file '$1' is deprecated」で、$1には設定ファイルパスが代入される。

#### Step 2: 設定ファイル読み込み処理を理解する

設定ファイルの読み込み処理と非推奨チェックの実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | options.nim | `compiler/options.nim` | ConfigRef型の定義と設定ファイル管理（configFiles フィールド：432行目） |

**読解のコツ**: ConfigRef型には`configFiles`シーケンスがあり、読み込まれた設定ファイルのパスを保持する。設定ファイルの非推奨チェックはこのパスに基づいて行われる可能性がある。

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

```
[設定ファイル読み込みフェーズ]
    │
    ├─ 設定ファイル検索
    │      └─ nim.cfg, config.nims等
    │
    └─ 非推奨チェック
           │
           └─ message (compiler/msgs.nim:641)
                  │
                  └─ liMessage (compiler/msgs.nim:536)
                         │
                         └─ styledMsgWriteln (compiler/msgs.nim:401)
```

### データフロー図

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

設定ファイルパス ───▶ 非推奨チェック ───▶ 警告生成 ───▶ warnConfigDeprecated
    │                       │               │                    │
    └─ メタデータ ─────────┘               │                    └─ stderr
                                            │
                    非推奨フラグ検出 ───────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型とメッセージ文字列の定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数群の実装 |
| options.nim | `compiler/options.nim` | ソース | 設定ファイル管理とConfigRef型の定義 |
| commands.nim | `compiler/commands.nim` | ソース | コマンドライン処理と設定読み込み |
