# 通知設計書 9-All matched files use Prettier code style!

## 概要

本ドキュメントは、Prettierの`--check`オプション使用時にすべてのファイルがフォーマット済みの場合に表示される成功通知「All matched files use Prettier code style!」の設計を記述する。

### 本通知の処理概要

「All matched files use Prettier code style!」は、`--check`オプションを使用してコードスタイルをチェックした際に、すべてのファイルが既にPrettierのスタイルでフォーマットされている場合に表示される成功メッセージである。

**業務上の目的・背景**：CI/CDパイプラインやpre-commitフックでコードスタイルの一貫性を確認する際、すべてのファイルがフォーマット済みであることを明確に示す成功メッセージは、ユーザーに安心感を与え、コードベースの品質が維持されていることを確認できる。この通知により、チェックが正常に完了し、問題がないことが明示される。

**通知の送信タイミング**：`prettier --check`コマンド実行後、すべてのファイルの処理が完了した時点で、フォーマットが必要なファイルが0件、かつエラーも0件の場合に表示される。`src/cli/format.js`の`formatFiles`関数の終了時に出力される。

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

**通知内容の概要**：すべてのファイルがPrettierのコードスタイルを使用していることを示す固定メッセージ。

**期待されるアクション**：特にアクションは不要。コードスタイルが一貫していることの確認のみ。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

`--check`オプション指定時、すべてのファイル処理完了後に、フォーマットが必要なファイル数（`numberOfUnformattedFilesFound`）が0、かつエラーが発生したファイル数（`numberOfFilesWithError`）が0の場合に`context.logger.log()`を通じて出力される。

## 通知テンプレート

### メール通知の場合

該当なし（CLI出力のみ）

### 本文テンプレート

```
All matched files use Prettier code style!
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | prettier --check完了 | numberOfUnformattedFilesFound === 0 | フォーマット必要ファイルなし |
| CLI実行 | prettier --check完了 | numberOfFilesWithError === 0 | エラーなし |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --check なし | --checkオプションなしでは表示されない |
| フォーマット必要ファイルあり | 代わりに「Code style issues found」が表示される |
| エラーあり | 代わりに「Error occurred when checking code style」が表示される |
| --log-level silent | ログレベルがsilentの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[prettier --check実行] --> B[formatFiles開始]
    B --> C[ファイルごとのチェック]
    C --> D[全ファイル処理完了]
    D --> E{argv.check?}
    E -->|No| F[終了]
    E -->|Yes| G{エラーあり?}
    G -->|Yes| H[Error occurredメッセージ]
    G -->|No| I{未フォーマットあり?}
    I -->|Yes| J[Code style issuesメッセージ]
    I -->|No| K[All matched files...メッセージ]
    K --> L[終了コード0]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

該当なし

### 配信時間帯

該当なし

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

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

## 備考

- 成功を示すメッセージとして、終了コード0で処理が終了する
- CI/CDパイプラインでの成功判定に使用できる
- エラーがあった場合は表示されず、代わりにエラーメッセージが表示される

---

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

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

### 推奨読解順序

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

この通知の条件判定に使用される変数を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | format.js | `src/cli/format.js` | カウンター変数（278-279行目） |

**読解のコツ**:
- 278行目: `let numberOfUnformattedFilesFound = 0` - フォーマットが必要なファイル数
- 279行目: `let numberOfFilesWithError = 0` - エラーが発生したファイル数

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | format.js | `src/cli/format.js` | checkサマリー出力ロジック（471-493行目） |

**主要処理フロー**:
- **471行目**: `if (context.argv.check)` - --checkオプションが指定されている場合
- **472-479行目**: エラーがあった場合の処理（この場合は出力されない）
- **480行目**: `else if (numberOfUnformattedFilesFound === 0)` - フォーマット必要ファイルが0の場合
- **481行目**: `context.logger.log("All matched files use Prettier code style!")` - 成功メッセージ出力

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

```
prettier --check [files]
    │
    └─ formatFiles() [src/cli/format.js:272]
           │
           ├─ ファイルごとのループ [305行目]
           │      └─ カウンター更新
           │
           └─ サマリー出力 [471行目]
                  │
                  └─ numberOfFilesWithError === 0 && numberOfUnformattedFilesFound === 0
                         └─ "All matched files use Prettier code style!" [481行目]
                                └─ context.logger.log()
```

### データフロー図

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

--check オプション    formatFiles()            ログメッセージ
  │                    │                         │
  v                    v                         │
ファイルリスト      ファイルごとの処理            │
                     │                          │
                     v                          v
              カウンター集計             context.logger.log()
              ├─ numberOfUnformattedFilesFound    │
              └─ numberOfFilesWithError           v
                     │                       stdout出力
                     v                       All matched files use Prettier code style!
              条件判定
              └─ エラー0 && 未フォーマット0
                 └─ 成功メッセージ出力
```

### 関連ファイル一覧

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