# 通知設計書 34-Error-occurred-when-checking-code-style

## 概要

本ドキュメントは、Prettier CLIの`--check`オプション使用時にファイル処理中にエラーが発生した場合に表示されるサマリー通知「Error occurred when checking code style」の設計仕様を記載する。

### 本通知の処理概要

本通知は、`--check`モードでのフォーマットチェック処理においてエラーが発生したファイルがあることをユーザーに報告するサマリーメッセージを出力する機能を提供する。

**業務上の目的・背景**：Prettierの`--check`オプションは、ファイルがPrettierのコードスタイルに従っているかを検証するために使用される。CIパイプラインなどで一括してコードスタイルをチェックする際、一部のファイルでパースエラーや読み込みエラーが発生することがある。このサマリー通知により、チェック処理中にエラーが発生したことを明確にユーザーに伝え、問題のあるファイルへの対処を促す。

**通知の送信タイミング**：全ファイルの処理が完了した後、`formatFiles`関数の終了時点でサマリーが出力される。エラーが発生したファイル数（`numberOfFilesWithError`）が1以上の場合にこの通知が表示される。

**通知の受信者**：Prettier CLIを`--check`オプション付きで実行しているユーザー（開発者）またはCIシステム。

**通知内容の概要**：エラーが発生したファイル数に応じて以下のいずれかのメッセージが出力される：
- 1ファイルの場合：「Error occurred when checking code style in the above file.」
- 複数ファイルの場合：「Error occurred when checking code style in {N} files.」

**期待されるアクション**：ユーザーは以下の対応を行うことが期待される：
1. 出力されたエラーメッセージから問題のあるファイルを特定する
2. 各ファイルのエラー原因（パースエラー、読み込みエラー等）を確認する
3. 問題を修正して再度チェックを実行する

## 通知種別

CLI標準出力（stdout）へのログメッセージ

## 送信仕様

### 基本情報

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

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

CLIを実行したプロセスの標準出力に直接出力される。ロガーの`log`メソッドを経由し、プレフィックスなしで出力される。

## 通知テンプレート

### CLI出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stdout |
| プレフィックス | なし |
| 色 | なし（デフォルト） |

### 本文テンプレート

単一ファイルの場合：
```
Error occurred when checking code style in the above file.
```

複数ファイルの場合：
```
Error occurred when checking code style in {numberOfFiles} files.
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| numberOfFiles | エラーが発生したファイル数 | numberOfFilesWithError変数 | Yes（複数の場合） |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイル処理完了 | formatFiles関数のループ完了後 | `context.argv.check && numberOfFilesWithError > 0` | --checkモードでエラーありの場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--check`オプションが未指定の場合 | サマリー出力対象外 |
| エラーが発生していない場合 | 別のサマリーメッセージが出力される |
| performanceTestFlagが設定されている場合 | パフォーマンステストモードではチェックメッセージが抑制される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[formatFiles開始] --> B[ファイルループ開始]
    B --> C{ファイル処理}
    C -->|成功| D[次のファイルへ]
    C -->|エラー| E[numberOfFilesWithError++]
    E --> D
    D --> F{全ファイル完了?}
    F -->|No| C
    F -->|Yes| G{--checkモード?}
    G -->|No| H[終了]
    G -->|Yes| I{エラーあり?}
    I -->|No| J[別サマリー出力]
    I -->|Yes| K[エラーサマリー出力]
    K --> L[logger.log呼び出し]
    L --> H
    J --> H
```

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

### 参照テーブル一覧

該当なし（CLIツールのためデータベースは使用しない）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

この通知自体がエラー発生を報告するサマリーであり、エラーケースは想定しない。

### リトライ仕様

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

## 配信設定

### レート制限

該当なし（CLI同期処理のため）

### 配信時間帯

該当なし（CLI実行時即座に出力）

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

本通知は固定メッセージとファイル数のみを出力し、ファイルパスやファイル内容を含まないため、セキュリティ上の考慮事項は特にない。個別のファイルエラーは事前に別途出力されている。

## 備考

- この通知は`--check`モードでのみ表示される
- エラーが発生した各ファイルの詳細エラーは、この通知より前に個別に出力されている
- `numberOfFilesWithError`はhandleError関数で`errorIsIgnored`が`false`の場合にインクリメントされる
- `--write`オプションと併用した場合でも、エラーが発生したファイルはカウントされる
- エラーが発生していない場合は「All matched files use Prettier code style!」または「Code style issues found in {N} files.」が表示される

---

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

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

### 推奨読解順序

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

エラーカウントの管理方法を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | format.js | `src/cli/format.js` | numberOfFilesWithError変数の定義と使用（279行目、392行目） |

**読解のコツ**: `numberOfFilesWithError`はformatFiles関数のローカル変数として定義され、handleErrorの戻り値に応じてインクリメントされる。

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

サマリー出力が行われる場所を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | format.js | `src/cli/format.js` | formatFiles関数のサマリー出力部分（471-493行目） |

**主要処理フロー**:
1. **471行目**: `if (context.argv.check)`でcheckモード判定
2. **472行目**: `if (numberOfFilesWithError > 0)`でエラー有無判定
3. **473-476行目**: ファイル数に応じたメッセージ生成
4. **477-479行目**: `logger.log`でサマリー出力

#### Step 3: エラーカウント処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | format.js | `src/cli/format.js` | handleError関数とエラーカウント処理（26-72行目、382-395行目） |

**主要処理フロー**:
- **383-389行目**: format実行時のtry-catchでhandleErrorを呼び出し
- **391-393行目**: `errorIsIgnored`がfalseの場合のみカウントアップ

#### Step 4: --checkオプションの動作を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | cli-options.evaluate.js | `src/cli/cli-options.evaluate.js` | checkオプションの定義（87-95行目） |
| 4-2 | format.js | `src/cli/format.js` | checkモード開始時のログ出力（282-284行目） |

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

```
formatFiles (src/cli/format.js:272)
    │
    ├─ ファイルループ (305-466行目)
    │      │
    │      ├─ format (379行目)
    │      │      └─ エラー発生時
    │      │             └─ handleError (383-389行目)
    │      │                    └─ errorIsIgnored判定
    │      │
    │      └─ numberOfFilesWithError++ (391-393行目)
    │
    └─ サマリー出力 (471-493行目)
           │
           ├─ if (argv.check)
           │      │
           │      ├─ if (numberOfFilesWithError > 0)
           │      │      └─ logger.log("Error occurred when...")
           │      │
           │      ├─ else if (numberOfUnformattedFilesFound == 0)
           │      │      └─ logger.log("All matched files use...")
           │      │
           │      └─ else
           │             └─ logger.warn("Code style issues found...")
           │
           └─ 終了
```

### データフロー図

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

--check指定
  │
複数ファイル ───────▶  formatFiles開始
                            ↓
                      ファイルループ
                            ↓
                      format実行 → エラー発生
                            ↓
                      handleError
                            ↓
                      errorIsIgnored == false
                            ↓
                      numberOfFilesWithError++
                            ↓
                      (ループ終了)
                            ↓
                      サマリー判定 ─────────▶ stdout: "Error occurred when..."
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| format.js | `src/cli/format.js` | ソース | formatFiles関数、handleError関数、サマリー出力 |
| cli-options.evaluate.js | `src/cli/cli-options.evaluate.js` | ソース | checkオプション定義 |
| logger.js | `src/cli/logger.js` | ソース | ログ出力機能（log/warn/error） |
| index.js | `src/cli/index.js` | ソース | CLI エントリーポイント |
