# 通知設計書 21-Explicitly specified file was ignored

## 概要

明示的に指定されたファイルがネガティブグロブパターンにより除外された場合に発生するエラー通知の設計書です。

### 本通知の処理概要

本通知は、ユーザーがコマンドラインで明示的にファイルパスを指定したにもかかわらず、そのファイルがネガティブグロブパターン（`!`で始まるパターン）によって除外された場合に表示されるエラーメッセージです。

**業務上の目的・背景**：開発者がPrettierでフォーマット対象として明示的にファイルを指定した場合、そのファイルが処理されることを期待しています。しかし、`.prettierignore`やコマンドライン引数で指定されたネガティブグロブパターンにより、そのファイルが除外されることがあります。この通知は、ユーザーに対して「指定したファイルが除外された」という事実を明確に伝え、設定の見直しを促すことを目的としています。

**通知の送信タイミング**：Prettierがファイルパターンを展開し、各パターンに対してfast-globを使用してファイルを検索した際に、明示的に指定されたファイルパスが結果として0件だった場合に発生します。具体的には、`expand-patterns.js`の`expandPatternsInternal`関数内で、ファイルタイプのエントリに対するglob結果が空であった場合に通知されます。

**通知の受信者**：CLIを実行している開発者（標準エラー出力経由）。

**通知内容の概要**：エラーメッセージは `Explicitly specified file was ignored due to negative glob patterns: "{ファイルパス}".` という形式で出力されます。ファイルパスにはユーザーが入力した元のパターン文字列が含まれます。

**期待されるアクション**：開発者は、ネガティブグロブパターンの設定を見直すか、`--no-error-on-unmatched-pattern`オプションを使用してエラーを抑制するか、対象ファイルを除外リストから外すかを判断します。

## 通知種別

CLI標準エラー出力（stderr）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（通常処理の一環として出力） |
| リトライ | 無 |

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

標準エラー出力（stderr）に対して直接出力されます。loggerモジュールの`error`メソッドを使用して出力されます。ただし、このエラーは`expand-patterns.js`から`error`プロパティを持つオブジェクトとして返され、`format.js`の`formatFiles`関数内で`context.logger.error()`を呼び出して出力されます。

## 通知テンプレート

### CLI出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr |
| プレフィックス | `[error]`（赤色） |
| 形式 | テキスト |

### 本文テンプレート

```
[error] Explicitly specified file was ignored due to negative glob patterns: "{input}".
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| input | ユーザーが入力したファイルパス/パターン | expand-patterns.js内のentriesオブジェクトのinputプロパティ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | ファイルパターン展開時 | type="file"のエントリに対するfast-glob結果が0件 | ユーザー指定のファイルがネガティブグロブパターンで除外された |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--no-error-on-unmatched-pattern` | このオプションが指定されている場合、エラーは発生せず警告もなく処理が続行される |
| `context.argv.errorOnUnmatchedPattern === false` | 内部的に上記オプションがfalseに設定されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI実行開始] --> B[ファイルパターン解析]
    B --> C{パターンはファイルパス？}
    C -->|Yes| D[ファイル存在確認]
    D -->|存在| E[entries配列にtype=fileで追加]
    E --> F[fast-globで検索実行]
    F --> G{結果が0件？}
    G -->|Yes| H{errorOnUnmatchedPattern?}
    H -->|true| I[エラーオブジェクト生成]
    I --> J[format.jsでlogger.error呼び出し]
    J --> K[stderr出力]
    H -->|false| L[スキップして継続]
    G -->|No| M[ファイル処理継続]
    C -->|No| N[他のパターンタイプ処理]
```

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

### 参照テーブル一覧

なし（ファイルシステム操作のみ）

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル除外エラー | 明示的指定ファイルがネガティブパターンで除外 | エラーメッセージを出力し、exitCode=2を設定 |

### リトライ仕様

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

## 配信設定

### レート制限

なし（CLI実行ごとに1回）

### 配信時間帯

制限なし

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

- ファイルパスがそのまま出力されるため、機密性のあるパス情報が露出する可能性がある
- ユーザー入力がそのまま出力に含まれるが、シェルエスケープは不要（単なるテキスト出力）

## 備考

- このエラーは`process.exitCode = 2`を設定するが、処理は継続される（複数ファイル処理の場合）
- `--no-error-on-unmatched-pattern`オプションを使用することでエラーを抑制可能
- エラーメッセージは`errorMessages.emptyResults.file`で定義されている

---

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

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

### 推奨読解順序

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

まず、ファイルパターン展開時に使用されるデータ構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | expand-patterns.js | `src/cli/expand-patterns.js` | entries配列の構造（type, glob, input, ignoreUnknown）を理解する |
| 1-2 | expand-patterns.js | `src/cli/expand-patterns.js` | errorMessagesオブジェクトでエラーメッセージテンプレートを確認する |

**読解のコツ**: 61〜62行目でentriesの型定義を確認し、139〜150行目でエラーメッセージの定義を確認する。

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

処理の起点となるファイル・関数を特定します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.js | `src/cli/index.js` | CLIのエントリーポイント、main関数からformatFilesへの流れを確認 |
| 2-2 | format.js | `src/cli/format.js` | formatFiles関数でexpandPatternsの結果を処理する箇所を確認 |

**主要処理フロー**:
1. **111〜113行目**: formatFiles関数の呼び出し
2. **305〜312行目**: expandPatternsからのエラー処理

#### Step 3: パターン展開処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | expand-patterns.js | `src/cli/expand-patterns.js` | expandPatternsInternal関数の全体構造を理解する |

**主要処理フロー**:
- **64〜113行目**: パターンの種類判定（ファイル/ディレクトリ/グロブ）
- **83〜88行目**: ファイルタイプのエントリ作成
- **116〜136行目**: fast-globによる検索とエラー処理
- **129〜131行目**: 結果が0件の場合のエラー生成

#### Step 4: ロガーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | logger.js | `src/cli/logger.js` | createLogFunc関数でerrorメソッドの実装を確認 |

**主要処理フロー**:
- **25行目**: error関数は赤色でフォーマットされる
- **35〜47行目**: stderrへの出力処理

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

```
src/cli/index.js::run()
    │
    ├─ src/cli/index.js::main()
    │      │
    │      └─ src/cli/format.js::formatFiles()
    │             │
    │             ├─ src/cli/expand-patterns.js::expandPatterns()
    │             │      │
    │             │      └─ expandPatternsInternal()
    │             │             │
    │             │             ├─ fast-glob検索実行
    │             │             │
    │             │             └─ エラーオブジェクト生成
    │             │
    │             └─ context.logger.error()
    │                    │
    │                    └─ src/cli/logger.js::createLogFunc()
```

### データフロー図

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

ユーザー入力              expand-patterns.js              stderr
ファイルパス ─────▶ パターン解析・展開 ─────▶ エラーメッセージ
                         │
                         ├─ ファイル存在確認
                         │
                         ├─ entries配列作成
                         │
                         ├─ fast-glob検索
                         │
                         └─ 結果判定・エラー生成
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| expand-patterns.js | `src/cli/expand-patterns.js` | ソース | パターン展開とエラーメッセージ定義 |
| format.js | `src/cli/format.js` | ソース | ファイルフォーマット処理とエラー出力 |
| index.js | `src/cli/index.js` | ソース | CLIエントリーポイント |
| logger.js | `src/cli/logger.js` | ソース | ログ出力機能 |
| utilities.js | `src/cli/utilities.js` | ソース | ユーティリティ関数（lstatSafe等） |
| cli-options.evaluate.js | `src/cli/cli-options.evaluate.js` | ソース | CLIオプション定義（errorOnUnmatchedPattern） |
