# 機能設計書 12-スクリプト実行

## 概要

本ドキュメントは、F#スクリプトファイル（.fsx）を実行するスクリプト実行機能の設計を記述する。この機能は、スクリプトファイルの依存関係（#load、#r等のディレクティブ）を解析し、必要なソースファイルとアセンブリ参照を収集する「ロードクロージャ」を計算する。

### 本機能の処理概要

スクリプト実行機能は、F#スクリプトファイル（.fsx）を解析し、そのファイルが参照するすべてのソースファイル、アセンブリ、NuGetパッケージを特定して依存関係のクロージャを構築する。

**業務上の目的・背景**：F#スクリプトは、複数のソースファイルやライブラリに依存することがある。これらの依存関係を正確に解決し、必要なすべてのリソースを収集することで、スクリプトの実行やIDE上での編集支援を可能にする。ビルドシステムを使わずに素早くF#コードを実行したい場面で重要な役割を果たす。

**機能の利用シーン**：
- F# Interactive（fsi.exe）でのスクリプトファイル実行
- Visual StudioやVS Codeでのスクリプト編集時のIntelliSense提供
- #loadディレクティブによる他のスクリプトファイルの読み込み
- #rディレクティブによるアセンブリ/NuGetパッケージ参照
- コマンドラインからのスクリプト実行（dotnet fsi script.fsx）

**主要な処理内容**：
1. スクリプトファイルの読み込みとパース
2. #loadディレクティブの解析と依存スクリプトの再帰的収集
3. #rディレクティブの解析とアセンブリ参照の解決
4. NuGetパッケージマネージャーとの連携（#r "nuget:..."）
5. 依存関係グラフの構築（LoadClosure）
6. 参照解決の診断情報収集

**関連システム・外部連携**：
- NuGet依存関係マネージャー（DependencyProvider）
- アセンブリ参照解決（TcAssemblyResolutions）
- F# Interactive（fsi.fs）
- F#コンパイラサービス（service.fs）

**権限による制御**：特になし。ファイルシステムへのアクセス権限に依存する。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 7 | F# Interactive ツールウィンドウ | 補助機能 | F#スクリプトファイル（.fsx）の実行 |

## 機能種別

依存関係解決 / ファイル解析 / パッケージ管理連携

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| fileName | string | Yes | スクリプトファイルのパス | .fsxまたは.fsファイル |
| sourceText | ISourceText | Yes | スクリプトのソースコード | - |
| caret | Position option | No | キャレット位置（編集時） | - |
| codeContext | CodeContext | Yes | 実行コンテキスト（FSI/コンパイル/編集） | 有効なCodeContext値 |
| tcConfig | TcConfig | Yes | コンパイラ設定 | - |

### 入力データソース

- F#スクリプトファイル（.fsx）
- #loadディレクティブで参照されるソースファイル
- NuGetパッケージ情報

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| LoadClosure | LoadClosure | 依存関係クロージャ |
| SourceFiles | (string * range list) list | ソースファイルと#load位置 |
| References | (string * AssemblyResolution list) list | 解決されたアセンブリ参照 |
| PackageReferences | (range * string list)[] | NuGetパッケージ参照 |
| Diagnostics | PhasedDiagnostic list | 解決時の診断情報 |

### 出力先

- LoadClosure構造体としてF# Interactiveまたはコンパイラサービスに返却

## 処理フロー

### 処理シーケンス

```
1. 初期TcConfig生成
   └─ スクリプト用のコンパイラ設定を作成
2. 基本参照の解決
   └─ FSharp.Core.dll等の標準参照を先に解決
3. ソースファイルの収集開始
   └─ ルートスクリプトからClosureSourceを生成
4. 再帰的なクロージャ解析
   └─ FindClosureFilesで依存関係を探索
5. #loadディレクティブ処理
   └─ 参照先スクリプトを再帰的に処理
6. #rディレクティブ処理
   └─ アセンブリ参照またはNuGetパッケージを解決
7. パッケージマネージャー連携
   └─ NuGet参照の依存解決とダウンロード
8. LoadClosure構築
   └─ すべての情報を集約してLoadClosureを生成
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプトファイル] --> B[TcConfig生成]
    B --> C[基本参照解決]
    C --> D[ClosureSource生成]
    D --> E[FindClosureFiles]
    E --> F{#loadあり?}
    F -->|Yes| G[依存ファイル読み込み]
    G --> H[再帰的処理]
    H --> E
    F -->|No| I{#rあり?}
    I -->|Yes| J[参照解決]
    J --> K{NuGet?}
    K -->|Yes| L[パッケージ解決]
    K -->|No| M[アセンブリ解決]
    L --> N[LoadClosure構築]
    M --> N
    I -->|No| N
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | INTERACTIVE定義 | スクリプト実行時はINTERACTIVEシンボルが定義される | CodeContext.CompilationAndEvaluation |
| BR-02 | COMPILED定義 | コンパイル時はCOMPILEDシンボルが定義される | CodeContext.Compilation |
| BR-03 | EDITING定義 | 編集時はEDITINGシンボルが追加定義される | CodeContext.Editing |
| BR-04 | 依存順序 | #loadされたファイルは依存順に処理される | 常時 |
| BR-05 | 最終ファイルマーク | 最後のファイルはisLastCompilandとしてマーク | 常時 |

### 計算ロジック

依存関係の解析アルゴリズム：
1. 既に観察済みのファイルはスキップ（Observed.HaveSeen）
2. スクリプトファイル（.fsx）または明示的に解析が必要なファイルのみ処理
3. パースしてメタコマンドを抽出
4. 依存ファイルを再帰的に処理

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

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

該当なし（データベース操作は行わない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル未発見 | #loadで指定されたファイルが存在しない | errorRecoveryでエラーを記録し処理継続 |
| - | パッケージ解決失敗 | NuGetパッケージが見つからない | エラー診断を出力してパッケージ行を未処理としてマーク |
| - | アセンブリ解決失敗 | 指定されたアセンブリが見つからない | UnresolvedReferencesリストに追加 |
| - | パースエラー | スクリプトの構文が不正 | parseDiagnosticsに記録 |

### リトライ仕様

NuGetパッケージのダウンロード失敗時は、キャッシュされた結果を再利用する可能性あり。

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

該当なし（読み取り専用の解析処理）

## パフォーマンス要件

- キャレット位置にあるパッケージ行は除外して高速化
- 既に観察済みのソースファイルはスキップ
- パッケージマネージャー結果はキャッシュされる

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

- #rディレクティブでのパッケージダウンロード時のセキュリティ
- ファイルシステムへのアクセス権限の確認
- 外部パッケージソースへの信頼性確認

## 備考

- .NET Frameworkと.NET Core両方に対応（assumeDotNetFramework設定）
- SDKディレクトリのオーバーライドが可能

---

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

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

### 推奨読解順序

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

まず、スクリプトクロージャで使用される主要なデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | LoadClosureInput型（28-34行目） |
| 1-2 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | LoadClosure型（36-74行目） |
| 1-3 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | CodeContext列挙型（76-80行目） |

**読解のコツ**: LoadClosureはスクリプトの依存関係のすべてを保持する。SourceFiles、References、PackageReferencesが主要なフィールド。

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

処理の起点となる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | LoadClosure.ComputeClosureOfScriptText（715-754行目） |
| 2-2 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | LoadClosure.ComputeClosureOfScriptFiles（757-767行目） |

**主要処理フロー**:
1. **715-733行目**: ComputeClosureOfScriptText - スクリプトテキストからクロージャを計算
2. **737-754行目**: GetFullClosureOfScriptTextの呼び出し
3. **757-767行目**: ComputeClosureOfScriptFiles - 複数スクリプトファイルからクロージャを計算

#### Step 3: TcConfig生成を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | CreateScriptTextTcConfig（144-243行目） |

**主要処理フロー**:
- **163-180行目**: TcConfigBuilderの初期化
- **182-188行目**: primaryAssemblyの設定（.NET Framework vs .NET Core）
- **194-225行目**: デフォルト参照の解決と診断情報の収集
- **227-243行目**: 解決環境の設定

#### Step 4: ファイル探索を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | FindClosureFiles（289-506行目） |
| 4-2 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | processClosureSource（449-498行目） |

**主要処理フロー**:
- **299-304行目**: 状態管理（observedSources, loadScripts, packageReferences）
- **306-328行目**: resolveDependencyManagerSources - パッケージ依存解決
- **338-446行目**: processPackageManagerLines/resolvePackageManagerLines - NuGet処理
- **449-498行目**: processClosureSource - 個別ソースの処理

#### Step 5: LoadClosure構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | GetLoadClosure（531-612行目） |

**主要処理フロー**:
- **534-539行目**: 最後のファイルをisLastCompilandとしてマーク
- **542-560行目**: ソースファイルと入力の収集
- **563-572行目**: 参照の解決
- **599-612行目**: LoadClosure構造体の構築

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

```
LoadClosure.ComputeClosureOfScriptText
    │
    ├─ CreateScriptTextTcConfig (初回 - 基本参照)
    │      └─ TcConfigBuilder.CreateNew
    │
    ├─ TcAssemblyResolutions.GetAssemblyResolutionInformation
    │
    ├─ CreateScriptTextTcConfig (2回目 - 完全設定)
    │
    └─ GetFullClosureOfScriptText
           │
           ├─ FindClosureFiles
           │      ├─ processClosureSource (再帰)
           │      │      ├─ ParseScriptClosureInput
           │      │      └─ ApplyMetaCommandsFromInputToTcConfig
           │      │
           │      └─ resolveDependencyManagerSources
           │             └─ processPackageManagerLines
           │                    └─ DependencyProvider.Resolve
           │
           └─ GetLoadClosure
                  ├─ MarkLastCompiland
                  └─ TcAssemblyResolutions.GetAssemblyResolutionInformation
```

### データフロー図

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

.fsxファイル ────────▶ CreateScriptTextTcConfig ─────▶ TcConfig
                              │
                              ▼
                    FindClosureFiles
                         │
            ┌────────────┼────────────┐
            ▼            ▼            ▼
     #load解析      #r解析     NuGet解析
         │            │            │
         ▼            ▼            ▼
     依存.fsx    アセンブリ    パッケージ
     (再帰)       参照          ダウンロード
            │            │            │
            └────────────┼────────────┘
                         ▼
                   GetLoadClosure
                         │
                         ▼
LoadClosure ◀────── 依存関係クロージャ
   │
   ├─ SourceFiles
   ├─ References
   ├─ PackageReferences
   └─ Diagnostics
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ScriptClosure.fs | `src/Compiler/Driver/ScriptClosure.fs` | ソース | スクリプトクロージャ計算のコア実装 |
| fsi.fs | `src/Compiler/Interactive/fsi.fs` | ソース | F# Interactiveからのスクリプト実行 |
| service.fs | `src/Compiler/Service/service.fs` | ソース | コンパイラサービスからの利用 |
| DependencyProvider.fs | `src/Compiler/DependencyManager/DependencyProvider.fs` | ソース | NuGet依存関係の解決 |
| CompilerConfig.fs | `src/Compiler/Driver/CompilerConfig.fs` | ソース | TcConfig/TcConfigBuilder定義 |
| ParseAndCheckInputs.fs | `src/Compiler/Driver/ParseAndCheckInputs.fs` | ソース | パース処理 |
