# 機能設計書 14-設定ファイルパス検索（resolveConfigFile）

## 概要

本ドキュメントは、Prettierにおける設定ファイルパス検索機能（resolveConfigFile）について記述する。

### 本機能の処理概要

**業務上の目的・背景**：開発者やツールが、特定のファイルに適用されるPrettier設定ファイルの場所を知る必要がある場合がある。resolveConfigFile関数は、指定されたファイルパスに対して適用される設定ファイルのパスを返す。これにより、エディタ統合やデバッグツールが設定ファイルの場所を特定し、直接編集やトラブルシューティングを行える。

**機能の利用シーン**：
- エディタプラグインが「設定ファイルを開く」機能を提供する際
- CLIの`--find-config-path`オプション使用時
- CI/CD環境での設定ファイル存在確認時
- デバッグや設定トラブルシューティング時

**主要な処理内容**：
1. 指定されたファイルパスからディレクトリを取得
2. ディレクトリから上位に向かって設定ファイルを検索
3. 最初に見つかった設定ファイルのパスを返却
4. 見つからない場合はnullを返却

**関連システム・外部連携**：
- 設定ファイル検索システム（config-searcher.js）
- search-closest ライブラリ（ファイル検索）
- url-or-path（URL/パス変換）

**権限による制御**：なし（全ユーザーが利用可能）

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 16 | Usage - API | 補助機能 | APIでの設定ファイルパス検索の使い方を説明 |
| 20 | Configuration - Configuration File | 補助機能 | 設定ファイルのパス検索方法を説明 |

## 機能種別

データ取得処理（ファイルパス検索）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| fileUrlOrPath | string \| URL | No | 検索起点となるファイルのパスまたはURL | 有効なファイルパスまたはURL（省略時はcwd） |

### 入力データソース

- ファイルシステムからの設定ファイル検索

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| configFilePath | string \| null | 見つかった設定ファイルの絶対パス。見つからない場合はnull |

### 出力先

- 呼び出し元へのパス文字列返却

## 処理フロー

### 処理シーケンス

```
1. resolveConfigFile関数が呼び出される
   └─ fileUrlOrPathの有無を確認
2. ファイルパスからディレクトリを取得
   └─ path.dirname(path.resolve(toPath(fileUrlOrPath)))
3. searchPrettierConfig関数で設定ファイルを検索
   └─ shouldCache: falseで常に新鮮な結果を取得
4. 結果を返却
   └─ 見つかった場合はパス、見つからない場合はnull
```

### フローチャート

```mermaid
flowchart TD
    A[開始: resolveConfigFile] --> B{fileUrlOrPath指定?}
    B -->|Yes| C[path.dirname取得]
    B -->|No| D[undefined使用]
    C --> E[searchPrettierConfig]
    D --> E
    E --> F{設定ファイル発見?}
    F -->|Yes| G[パスを返却]
    F -->|No| H[null返却]
    G --> I[終了]
    H --> I
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-014-01 | キャッシュ無効 | 常にshouldCache: falseで検索（最新の状態を反映） | 常時 |
| BR-014-02 | 検索優先順位 | CONFIG_FILE_NAMESの順序で検索 | 同じディレクトリに複数の設定ファイルがある場合 |
| BR-014-03 | 上位検索 | 設定ファイルが見つかるまでディレクトリを上位に遡る | 常時 |
| BR-014-04 | null返却 | 設定ファイルが見つからない場合はnull（undefinedではない） | 検索結果なしの場合 |

### 計算ロジック

特になし

## データベース操作仕様

### 操作別データベース影響一覧

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイルシステムエラー | 検索中のI/Oエラー | エラーをそのままスロー |

### リトライ仕様

ファイルシステムエラー時のリトライは行わない

## トランザクション仕様

トランザクション管理なし（読み取り専用処理）

## パフォーマンス要件

- 通常の検索: 5ms以下
- キャッシュを使用しないため、resolveConfigより若干遅い可能性あり

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

- ファイルシステムの読み取りのみ
- 任意のパスを検索対象にできるため、意図しないディレクトリへのアクセスに注意

## 備考

- resolveConfigFileはキャッシュを使用しない点がresolveConfigと異なる
- CLIの`--find-config-path`オプションで使用される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | index.js | `src/index.js` | resolveConfigFile関数のエクスポート |
| 1-2 | resolve-config.js | `src/config/resolve-config.js` | resolveConfigFile関数の実装 |

**主要処理フロー**:
1. **102-108行目**: resolveConfigFile関数本体
2. **103-105行目**: ディレクトリパスの取得
3. **106行目**: searchPrettierConfigの呼び出し（shouldCache: false）
4. **107行目**: 結果がない場合はnullに変換（?? null）

#### Step 2: 検索処理の詳細を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | prettier-config/index.js | `src/config/prettier-config/index.js` | searchPrettierConfig関数 |
| 2-2 | config-searcher.js | `src/config/prettier-config/config-searcher.js` | FileSearcher設定 |

**主要処理フロー**:
- **54-64行目（index.js）**: searchPrettierConfig - 検索関数
- **59行目**: mockable.getPrettierConfigSearchStopDirectoryで停止ディレクトリ取得
- **12-39行目（config-searcher.js）**: CONFIG_FILE_NAMES - 検索対象ファイル一覧

#### Step 3: CLI連携を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | find-config-path.js | `src/cli/find-config-path.js` | CLI --find-config-path実装 |

**主要処理フロー**:
- resolveConfigFileを呼び出してパスを出力

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

```
prettier.resolveConfigFile(filePath)
    │
    ├─ path.dirname(path.resolve(toPath(filePath)))
    │
    └─ searchPrettierConfig(directory, {shouldCache: false})
           │
           ├─ mockable.getPrettierConfigSearchStopDirectory()
           │
           └─ FileSearcher.search(startDirectory)
                  │
                  └─ CONFIG_FILE_NAMES順に検索
                         ├─ package.json (prettierキー確認)
                         ├─ package.yaml (prettierキー確認)
                         ├─ .prettierrc
                         ├─ .prettierrc.json
                         ├─ .prettierrc.yml
                         └─ ... (その他の設定ファイル)
```

### データフロー図

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

fileUrlOrPath ───▶ path.dirname() ───▶ directory
                          │
                          ▼
               searchPrettierConfig()
                          │
                          ├─ FileSearcher.search()
                          │      │
                          │      └─ ディレクトリを上位に遡りながら検索
                          │
                          ▼
                  result ?? null ───▶ configFilePath | null
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| resolve-config.js | `src/config/resolve-config.js` | ソース | resolveConfigFile関数実装 |
| index.js | `src/config/prettier-config/index.js` | ソース | searchPrettierConfig関数 |
| config-searcher.js | `src/config/prettier-config/config-searcher.js` | ソース | FileSearcher設定・CONFIG_FILE_NAMES |
| find-config-path.js | `src/cli/find-config-path.js` | ソース | CLI --find-config-path実装 |
| index.js | `src/index.js` | ソース | API公開エントリーポイント |
| mockable.js | `src/common/mockable.js` | ソース | テスト用モック可能関数 |
