# 通知設計書 6-Code style issues found

## 概要

本ドキュメントは、Prettierの`--check`オプション使用時にフォーマットが必要なファイルが見つかった場合に表示される警告通知「Code style issues found」の設計を記述する。

### 本通知の処理概要

「Code style issues found」は、`--check`オプションを使用してコードスタイルをチェックした際に、フォーマットが必要なファイルが検出された場合に表示される警告通知である。

**業務上の目的・背景**：CI/CDパイプラインやpre-commitフックでコードスタイルの一貫性を確認するために、Prettierは`--check`オプションを提供している。このオプションを使用すると、ファイルを実際に変更せずにフォーマットが必要かどうかをチェックできる。フォーマットが必要なファイルが見つかった場合、この警告メッセージが表示され、`--write`オプションでの修正を促す。

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

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

**通知内容の概要**：フォーマットが必要なファイル数、および`--write`オプションでの修正方法の案内。

**期待されるアクション**：ユーザーは`prettier --write`を実行してコードスタイルの問題を修正するか、手動でコードをフォーマットする。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### メール通知の場合

該当なし（CLI出力のみ）

### 本文テンプレート

1ファイルの場合：
```
[warn] Code style issues found in the above file. Run Prettier with --write to fix.
```

複数ファイルの場合：
```
[warn] Code style issues found in {count} files. Run Prettier with --write to fix.
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| count | フォーマットが必要なファイル数 | numberOfUnformattedFilesFound | Yes |

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --write オプション同時指定 | この場合は「Code style issues fixed」が表示される |
| エラーが発生したファイルがある場合 | 代わりに「Error occurred when checking code style」が表示される |
| フォーマット必要ファイル数が0 | 代わりに「All matched files use Prettier code style!」が表示される |

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| - | この通知自体はエラーではなく警告 | --writeで修正 |

### リトライ仕様

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

## 配信設定

### レート制限

該当なし

### 配信時間帯

該当なし

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

ファイル数のみが表示されるため、機密情報漏洩のリスクはない。ただし、チェック対象のファイル名は事前に1行ずつ表示される（`context.logger.warn(fileNameToDisplay)`）。

## 備考

- `--check`オプションでフォーマットが必要なファイルが見つかった場合、終了コードは1に設定される
- `--write`と組み合わせた場合は「Code style issues fixed」メッセージに変わる
- ファイルが1つの場合は「the above file」、複数の場合は「{count} files」と表示される
- 各ファイルの処理中にもフォーマットが必要なファイル名が`warn`レベルで出力される

---

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

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

### 推奨読解順序

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

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

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

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

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

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

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

**主要処理フロー**:
- **471行目**: `if (context.argv.check)` - --checkオプションが指定されている場合
- **472-479行目**: エラーがあった場合の処理
- **480-481行目**: フォーマット必要ファイルが0の場合「All matched files use Prettier code style!」
- **482-492行目**: フォーマット必要ファイルがある場合
- **483-486行目**: ファイル数に応じたメッセージ構築
- **487-491行目**: --write指定時は「fixed」、なしは「found...Run Prettier with --write」

#### Step 3: 個別ファイル処理を理解する

各ファイルの処理中にどのように差分が検出されるかを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | format.js | `src/cli/format.js` | ファイル差分検出（398, 458-465行目） |

**主要処理フロー**:
- **398行目**: `const isDifferent = output !== input` - 入力と出力の比較
- **458-465行目**: 差分がある場合の処理
- **459-460行目**: --check時はファイル名をwarnで出力
- **464行目**: `numberOfUnformattedFilesFound += 1`

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

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

### データフロー図

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

--check オプション    formatFiles()            警告メッセージ
  │                    │                         │
  v                    v                         │
ファイルリスト      ファイルごとの処理            │
                     │                          │
                     v                          v
              output !== input判定        context.logger.warn()
                     │                          │
                     v                          v
              カウンターインクリメント       stderr出力
                     │                    [warn] Code style issues found...
                     v
              サマリー出力判定
              ├─ エラーあり → Error occurred
              ├─ 差分なし → All matched files
              └─ 差分あり
                 ├─ --write → fixed
                 └─ else → found
```

### 関連ファイル一覧

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