# 通知設計書 89-hintSuccess

## 概要

本ドキュメントは、Nimコンパイラのヒント通知「hintSuccess」（操作成功ヒント）に関する設計仕様を記載する。

### 本通知の処理概要

本通知は、コンパイラの操作が成功した際に簡潔な成功メッセージを表示するものである。主にドキュメント生成やビルドファイル生成などの特定の操作が正常に完了したことを開発者に通知する。

**業務上の目的・背景**：コンパイラの様々な操作（ドキュメント生成、依存関係グラフ生成、NIF形式のビルドファイル生成など）が正常に完了したことを開発者に即座にフィードバックする。これにより、操作の成功を確認でき、次のステップに進むことができる。詳細な成功情報は別のヒント（hintSuccessX）で提供される。

**通知の送信タイミング**：各種操作の完了時に発行される。具体的には、ドキュメント生成の実行可能サンプル処理（docgen.nim）、NIF形式ビルドファイル生成（deps.nim）などで使用される。

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

**通知内容の概要**：「operation successful: {詳細情報}」という形式で、成功した操作の詳細を示す。

**期待されるアクション**：特になし。成功メッセージを確認し、必要に応じて生成されたファイルを使用したり、次のステップに進む。

## 通知種別

コンパイラヒント（Hint） - ターミナル/IDE出力

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Hint: operation successful: {詳細情報} [Success]
```

または（ファイル情報なしの場合）：

```
Hint: operation successful: {詳細情報} [Success]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $# | 操作の詳細情報 | 呼び出し元で指定 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | 実行可能サンプル処理完了 | 正常完了時 | docgen.nim内 |
| ビルドファイル生成 | NIF形式ファイル生成完了 | 正常完了時 | deps.nim内 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --hint:Success:off | コマンドラインオプションで抑制可能 |
| {.hint[Success]:off.} | プラグマで抑制可能 |
| 低verbosityレベル | NotesVerbosity[0]から除外 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[操作完了] --> B{操作成功?}
    B -->|No| C[エラー処理]
    B -->|Yes| D[成功メッセージ生成]
    D --> E[rawMessage関数呼び出し]
    E --> F[styledMsgWriteln出力]
    F --> G[処理継続]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- ヒントIDは "Success"
- hintSuccessXと対になるシンプルな成功メッセージ
- NotesVerbosity[0]から除外されている（低verbosity時は非表示）
- 警告の最大値（warnMax）はpred(hintSuccess)で定義されている

---

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

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

### 推奨読解順序

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

ヒントメッセージの種類と定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でhintSuccessの定義（103行目）、MsgKindToStr配列でメッセージテンプレート（211行目）を確認 |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | warnMax定義（254行目）でpred(hintSuccess)を確認 |
| 1-3 | lineinfos.nim | `compiler/lineinfos.nim` | NotesVerbosity計算（270行目）でhintSuccessがverbosity 0から除外されていることを確認 |

**読解のコツ**: メッセージテンプレートは "operation successful: $#" で、$#に詳細情報が入る。

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

ヒントが発行される箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | docgen.nim | `compiler/docgen.nim` | 611行目で実行可能サンプル処理完了時にhintSuccessを使用 |
| 2-2 | deps.nim | `compiler/deps.nim` | 382行目、387行目でNIF形式ビルドファイル生成時にhintSuccessを使用 |

**主要処理フロー**:
1. **docgen.nim 611行目**: rawMessage(d.conf, hintSuccess, ["runnableExamples: " & outp.string])
2. **deps.nim 382行目**: rawMessage(conf, hintSuccess, "generated: " & buildFile)
3. **deps.nim 387行目**: rawMessage(conf, hintSuccess, "run: nifmake run " & buildFile)

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | rawMessageテンプレート（610-615行目）の実装を確認 |

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

```
docgen.nim / deps.nim (操作完了)
    │
    └─ msgs.nim: rawMessage (メッセージ発行)
           │
           └─ msgs.nim: liMessage (メッセージ処理)
                  │
                  └─ msgs.nim: styledMsgWriteln (出力)
```

### データフロー図

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

操作完了 ───▶ rawMessage ───▶ メッセージ生成
                                     │
                                     ▼
                              liMessage ───▶ stderr/stdout
                                            (ヒントメッセージ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | ヒント種別定義とメッセージテンプレート |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成（hintSuccess使用） |
| deps.nim | `compiler/deps.nim` | ソース | 依存関係処理（hintSuccess使用） |
