# 通知設計書 22-Explicitly specified pattern is a symbolic link

## 概要

明示的に指定されたパターンがシンボリックリンクである場合に発生するエラー通知の設計書です。

### 本通知の処理概要

本通知は、ユーザーがコマンドラインで明示的にファイルパスを指定したにもかかわらず、そのパスがシンボリックリンクであった場合に表示されるエラーメッセージです。Prettierはデフォルトでシンボリックリンクをフォローしない設計になっており、セキュリティと予測可能性を重視しています。

**業務上の目的・背景**：シンボリックリンクをフォローすることは、予期しないディレクトリへのアクセスや循環参照の問題を引き起こす可能性があります。また、シンボリックリンク先のファイルをフォーマットすると、リンク元を期待しているユーザーに混乱を与える可能性があります。この通知は、ユーザーに対してシンボリックリンクが検出されたことを明確に伝え、実際のファイルパスを指定するよう促すことを目的としています。

**通知の送信タイミング**：Prettierがファイルパターンを展開し、各パスに対して`fs.lstat`でファイル情報を取得した際に、そのパスがシンボリックリンクであると判定された場合に発生します。具体的には、`expand-patterns.js`の`expandPatternsInternal`関数内で、`stat.isSymbolicLink()`がtrueを返した場合に通知されます。

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

**通知内容の概要**：エラーメッセージは `Explicitly specified pattern "{パターン}" is a symbolic link.` という形式で出力されます。パターンにはユーザーが入力した元のパス文字列が含まれます。

**期待されるアクション**：開発者は、シンボリックリンクではなく実際のファイルパスを指定するか、`--no-error-on-unmatched-pattern`オプションを使用してエラーを警告に変更するかを判断します。

## 通知種別

CLI標準エラー出力（stderr）

## 送信仕様

### 基本情報

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

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

`context.argv.errorOnUnmatchedPattern`の値に応じて出力先が変わります：
- `true`（デフォルト）: errorオブジェクトとしてyieldされ、format.jsで`logger.error`経由でstderrに出力
- `false`: `logger.debug`経由でstderrにデバッグメッセージとして出力（通常は非表示）

## 通知テンプレート

### CLI出力の場合（エラー時）

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

### 本文テンプレート（エラー時）

```
[error] Explicitly specified pattern "{pattern}" is a symbolic link.
```

### 本文テンプレート（デバッグ時）

```
[debug] Skipping pattern "{pattern}", as it is a symbolic link.
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| pattern | ユーザーが入力したファイルパス/パターン | expand-patterns.js内のpattern変数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | ファイルパターン展開時 | `stat.isSymbolicLink()` がtrue | ユーザー指定のパスがシンボリックリンクだった |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--no-error-on-unmatched-pattern` | このオプションが指定されている場合、エラーではなくデバッグログとして出力される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI実行開始] --> B[ファイルパターン解析]
    B --> C[パスごとにlstat実行]
    C --> D{stat取得成功？}
    D -->|Yes| E{isSymbolicLink？}
    E -->|Yes| F{errorOnUnmatchedPattern？}
    F -->|true| G[エラーオブジェクト生成]
    G --> H[format.jsでlogger.error呼び出し]
    H --> I[stderr出力]
    F -->|false| J[logger.debug呼び出し]
    J --> K[デバッグログ出力]
    E -->|No| L{isFile？}
    L -->|Yes| M[entries配列に追加]
    L -->|No| N[isDirectory判定へ]
    D -->|No| O[グロブパターン処理へ]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| シンボリックリンクエラー | 指定パスがシンボリックリンク | エラーメッセージを出力し、exitCode=2を設定 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- シンボリックリンクをフォローしないことで、意図しないディレクトリアクセスを防止
- ファイルパスがそのまま出力されるため、機密性のあるパス情報が露出する可能性がある
- 循環参照によるDoS攻撃を防止

## 備考

- `fs.lstat`を使用することで、シンボリックリンク自体の情報を取得（リンク先ではなく）
- `globOptions.followSymbolicLinks = false`により、fast-glob実行時もシンボリックリンクをフォローしない
- `--no-error-on-unmatched-pattern`オプションを使用するとエラーではなくデバッグログになる

---

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

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

### 推奨読解順序

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

まず、シンボリックリンク判定に使用されるデータ構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | utilities.js | `src/cli/utilities.js` | lstatSafe関数の実装を確認（fs.lstatのラッパー） |

**読解のコツ**: 75〜84行目でlstatSafe関数を確認。ENOENTエラーを安全にハンドリングしている。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.js | `src/cli/index.js` | CLIのエントリーポイント |
| 2-2 | format.js | `src/cli/format.js` | formatFiles関数でexpandPatternsの結果を処理 |

**主要処理フロー**:
1. **305〜312行目**: expandPatternsからのエラー処理

#### Step 3: シンボリックリンク判定処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | expand-patterns.js | `src/cli/expand-patterns.js` | expandPatternsInternal関数のシンボリックリンク処理 |

**主要処理フロー**:
- **57行目**: `followSymbolicLinks: false`の設定
- **71行目**: `lstatSafe(absolutePath)`の呼び出し
- **73〜82行目**: シンボリックリンク判定とエラー/デバッグ出力の分岐

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | logger.js | `src/cli/logger.js` | errorメソッドとdebugメソッドの実装 |

**主要処理フロー**:
- **25行目**: error関数は赤色でフォーマット
- **26行目**: debug関数は青色でフォーマット

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

```
src/cli/index.js::run()
    │
    ├─ src/cli/index.js::main()
    │      │
    │      └─ src/cli/format.js::formatFiles()
    │             │
    │             ├─ src/cli/expand-patterns.js::expandPatterns()
    │             │      │
    │             │      └─ expandPatternsInternal()
    │             │             │
    │             │             ├─ utilities.js::lstatSafe()
    │             │             │
    │             │             ├─ stat.isSymbolicLink()判定
    │             │             │
    │             │             └─ エラーオブジェクト生成 or logger.debug
    │             │
    │             └─ context.logger.error() or context.logger.debug()
```

### データフロー図

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

ユーザー入力              expand-patterns.js                   stderr
ファイルパス ─────▶ lstatSafe()でstat取得 ─────▶ エラーメッセージ
                         │                               or デバッグログ
                         ├─ isSymbolicLink()判定
                         │
                         └─ errorOnUnmatchedPattern判定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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） |
