# 通知設計書 7-Code style issues fixed

## 概要

本ドキュメントは、Prettierの`--check --write`オプション組み合わせ使用時にフォーマット修正が完了した場合に表示される通知「Code style issues fixed」の設計を記述する。

### 本通知の処理概要

「Code style issues fixed」は、`--check`と`--write`オプションを組み合わせて使用した際に、フォーマットが必要なファイルが検出され、それらが自動的に修正された場合に表示される通知である。

**業務上の目的・背景**：CI/CDパイプラインやpre-commitフックでコードスタイルのチェックと自動修正を同時に行いたい場合がある。`--check`と`--write`を組み合わせることで、スタイルの問題を検出しつつ自動的に修正し、修正されたファイル数をユーザーに報告することができる。これにより、ユーザーは何件のファイルが修正されたかを把握できる。

**通知の送信タイミング**：`prettier --check --write`コマンド実行後、すべてのファイルの処理が完了した時点で、フォーマット修正が行われたファイルが1つ以上あった場合に表示される。`src/cli/format.js`の`formatFiles`関数の終了時に出力される。

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

**通知内容の概要**：フォーマット修正されたファイル数。

**期待されるアクション**：ユーザーは修正されたファイルを確認し、必要に応じてコミットする。

## 通知種別

CLI警告出力（標準エラー出力への出力）

## 送信仕様

### 基本情報

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

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

`--check`と`--write`オプション両方指定時、すべてのファイル処理完了後に、フォーマット修正が行われたファイル数（`numberOfUnformattedFilesFound`）が1以上の場合に`context.logger.warn()`を通じて出力される。

## 通知テンプレート

### メール通知の場合

該当なし（CLI出力のみ）

### 本文テンプレート

1ファイルの場合：
```
[warn] Code style issues fixed in the above file.
```

複数ファイルの場合：
```
[warn] Code style issues fixed in {count} files.
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| count | フォーマット修正されたファイル数 | numberOfUnformattedFilesFound | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | prettier --check --write完了 | 修正ファイル >= 1 | --write指定時のみ |
| CLI実行 | prettier --check --write完了 | エラーなし、修正ファイル >= 1 | numberOfFilesWithError === 0 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --write なし | この場合は「Code style issues found」が表示される |
| エラーが発生したファイルがある場合 | 代わりに「Error occurred when checking code style」が表示される |
| 修正ファイル数が0 | 代わりに「All matched files use Prettier code style!」が表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[prettier --check --write実行] --> B[formatFiles開始]
    B --> C[ファイルごとの処理]
    C --> D{フォーマット差分あり?}
    D -->|Yes| E[ファイル書き込み]
    E --> F[numberOfUnformattedFilesFound++]
    D -->|No| G[次のファイルへ]
    F --> G
    G --> H{全ファイル処理完了?}
    H -->|No| C
    H -->|Yes| I{argv.check?}
    I -->|No| J[終了]
    I -->|Yes| K{エラーあり?}
    K -->|Yes| L[Error occurredメッセージ]
    K -->|No| M{修正ファイルあり?}
    M -->|No| N[All matched filesメッセージ]
    M -->|Yes| O{argv.write?}
    O -->|Yes| P[Code style issues fixedメッセージ]
    O -->|No| Q[Code style issues foundメッセージ]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| - | この通知自体はエラーではなく警告 | 修正ファイルを確認 |

### リトライ仕様

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

## 配信設定

### レート制限

該当なし

### 配信時間帯

該当なし

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

ファイル数のみが表示されるため、機密情報漏洩のリスクはない。

## 備考

- `--check --write`の組み合わせで使用した場合にのみ表示される
- `--write`なしの`--check`のみの場合は「Code style issues found」が表示される
- ファイルが1つの場合は「the above file」、複数の場合は「{count} files」と表示される
- このメッセージが表示されても、--writeでファイルが修正されているため、通常は終了コードは影響しない

---

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

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

### 推奨読解順序

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

この通知で使用される主要な変数を理解する。

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

**読解のコツ**:
- 278行目: `let numberOfUnformattedFilesFound = 0` - フォーマットが必要だったファイル数のカウンター
- 464行目: `numberOfUnformattedFilesFound += 1` - 差分がある場合にインクリメント

#### Step 2: ファイル書き込み処理を理解する

--write時のファイル書き込み処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | format.js | `src/cli/format.js` | --write時の処理（411-440行目） |

**主要処理フロー**:
- **411行目**: `if (context.argv.write)` - --writeオプションが指定されている場合
- **415行目**: `if (isDifferent)` - 差分がある場合
- **421行目**: `await mockable.writeFormattedFile(filename, output)` - ファイル書き込み

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

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

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

**主要処理フロー**:
- **487-491行目**: context.argv.writeの条件分岐
- **489行目**: `Code style issues fixed in ${files}.` - --write時のメッセージ

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

```
prettier --check --write [files]
    │
    └─ formatFiles() [src/cli/format.js:272]
           │
           ├─ ファイルごとのループ [305行目]
           │      │
           │      ├─ format() [379行目]
           │      ├─ isDifferent = output !== input [398行目]
           │      ├─ writeFormattedFile() [421行目]
           │      └─ numberOfUnformattedFilesFound++ [464行目]
           │
           └─ サマリー出力 [471行目]
                  │
                  └─ --check && --write && numberOfUnformattedFilesFound > 0
                         └─ "Code style issues fixed..." [489行目]
```

### データフロー図

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

--check --write      formatFiles()            警告メッセージ
  │                    │                         │
  v                    v                         │
ファイルリスト      ファイルごとの処理            │
                     │                          │
                     v                          v
              output !== input判定        context.logger.warn()
                     │                          │
                     v                          v
              ファイル書き込み              stderr出力
                     │                    [warn] Code style issues fixed...
                     v
              カウンターインクリメント
                     │
                     v
              サマリー出力判定
              └─ --check && --write
                 └─ "Code style issues fixed in {files}."
```

### 関連ファイル一覧

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