# 通知設計書 8-Checking formatting...

## 概要

本ドキュメントは、Prettierの`--check`オプション使用時にフォーマットチェック開始を示すログ通知「Checking formatting...」の設計を記述する。

### 本通知の処理概要

「Checking formatting...」は、`--check`オプションを使用してコードスタイルをチェックする際に、処理開始を示すログメッセージとして表示される通知である。

**業務上の目的・背景**：CI/CDパイプラインやpre-commitフックでPrettierを実行する際、処理が開始されたことをユーザーに通知することで、コマンドが正常に動作していることを確認できる。特に多数のファイルをチェックする場合、処理開始の通知があることで、ユーザーは待機状態であることを理解できる。

**通知の送信タイミング**：`prettier --check`コマンド実行直後、ファイル処理を開始する前に表示される。`src/cli/format.js`の`formatFiles`関数の冒頭で出力される。

**通知の受信者**：CLIを使用しているユーザー、CI/CDシステム、pre-commitフック。

**通知内容の概要**：フォーマットチェックが開始されたことを示す固定メッセージ。

**期待されるアクション**：特にアクションは不要。処理が進行中であることの確認のみ。

## 通知種別

CLIログ出力（標準出力への出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低 |
| リトライ | なし |

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

`--check`オプション指定時、かつパフォーマンステストフラグ（`--debug-benchmark`等）がない場合に、ファイル処理開始前に`context.logger.log()`を通じて出力される。

## 通知テンプレート

### メール通知の場合

該当なし（CLI出力のみ）

### 本文テンプレート

```
Checking formatting...
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | prettier --check開始 | --checkオプション指定 | 処理開始時 |
| CLI実行 | prettier --check開始 | パフォーマンステストフラグなし | --debug-benchmark等がない場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --check なし | --writeのみの場合は表示されない |
| パフォーマンステストフラグあり | --debug-benchmark, --debug-repeat等の場合 |
| --log-level silent | ログレベルがsilentの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[prettier --check実行] --> B[formatFiles開始]
    B --> C{argv.check?}
    C -->|No| D[通知なしで処理開始]
    C -->|Yes| E{performanceTestFlag?}
    E -->|Yes| F[通知なしで処理開始]
    E -->|No| G[Checking formatting...出力]
    G --> H[ファイル処理開始]
    D --> H
    F --> H
```

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

### 参照テーブル一覧

該当なし（Prettierはデータベースを使用しない）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| - | この通知ではエラーは発生しない | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | - |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

該当なし

### 配信時間帯

該当なし

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

固定メッセージのみのため、機密情報漏洩のリスクはない。

## 備考

- 処理開始を示すシンプルな通知
- パフォーマンステスト時は出力を抑止してベンチマークへの影響を避ける
- `context.logger.log()`を使用するため、標準出力（stdout）に出力される

---

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

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

### 推奨読解順序

#### Step 1: 通知出力ロジックを理解する

通知が出力される条件と処理フローを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | format.js | `src/cli/format.js` | formatFiles関数冒頭の通知出力（282-284行目） |

**読解のコツ**:
- **282行目**: `if (context.argv.check && !performanceTestFlag)` - 条件判定
- **283行目**: `context.logger.log("Checking formatting...")` - メッセージ出力

#### Step 2: ロガーの実装を理解する

logメソッドの実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | logger.js | `src/cli/logger.js` | createLogger関数とlogメソッドの実装（21-80行目） |

**主要処理フロー**:
- **27行目**: `log: createLogFunc("log")` - logメソッド定義（色なし、プレフィックスなし）
- **35行目**: logは標準出力（stdout）に出力される

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

```
prettier --check [files]
    │
    └─ formatFiles() [src/cli/format.js:272]
           │
           ├─ 条件判定 [282行目]
           │      └─ context.argv.check && !performanceTestFlag
           │
           └─ "Checking formatting..." 出力 [283行目]
                  └─ context.logger.log()
                         └─ stdout.write()
```

### データフロー図

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

--check オプション    formatFiles()            ログメッセージ
  │                    │                         │
  v                    v                         │
              条件判定                           │
              ├─ argv.check?                    │
              └─ performanceTestFlag?           v
                     │                    context.logger.log()
                     v                          │
              メッセージ出力                    v
                                          stdout出力
                                          Checking formatting...
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| format.js | `src/cli/format.js` | ソース | formatFiles関数、通知出力ロジック |
| logger.js | `src/cli/logger.js` | ソース | log関数の実装 |
| index.js | `src/cli/index.js` | ソース | CLIエントリーポイント |
