# バッチ設計書 6-build-3rd-meta.lua

## 概要

本ドキュメントは、サードパーティライブラリのメタデータを生成するツール「build-3rd-meta.lua」の設計仕様を定義するものである。

### 本バッチの処理概要

build-3rd-meta.luaは、LOVE2DおよびLOVR（VRフレームワーク）のAPIメタデータを生成するためのオーケストレーションスクリプトである。このスクリプトは、love-api.luaとlovr-api.luaを順次実行し、さらにnormalize-3rd-path.luaでパスの正規化を行う。

**業務上の目的・背景**：lua-language-serverは、Luaの標準ライブラリだけでなく、LOVE2DやLOVRなどの人気フレームワークの補完・診断機能も提供する。これらのフレームワークのAPI定義をLua Language Serverが理解できる形式（メタデータ）に変換する必要がある。このツールにより、サードパーティライブラリのサポートを自動的に更新できる。

**バッチの実行タイミング**：手動実行。LOVE2DやLOVRのAPIが更新された場合、または新しいバージョンのフレームワークをサポートする場合に実行する。

**主要な処理内容**：
1. package.pathにscript/とtools/を追加
2. love-api.luaを実行してLOVE2Dメタデータを生成
3. lovr-api.luaを実行してLOVRメタデータを生成
4. normalize-3rd-path.luaを実行してパスを正規化

**前後の処理との関連**：このツールは単独で実行される。生成されたメタデータはmeta/3rd/ディレクトリに出力され、言語サーバーが参照する。

**影響範囲**：meta/3rd/love2d/およびmeta/3rd/lovr/ディレクトリ配下のファイルが更新される。

## バッチ種別

メタデータ生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Luaランタイム | Luaインタープリタが利用可能であること |
| サブモジュール | 3rd/love-api、3rd/lovr-apiが初期化済みであること |
| 依存スクリプト | tools/love-api.lua、tools/lovr-api.lua、tools/normalize-3rd-path.luaが存在すること |

### 実行可否判定

プロジェクトルートディレクトリで実行すること。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 3rd/love-api/ | Lua | LOVE2D API定義 |
| 3rd/lovr-api/ | Lua | LOVR API定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| meta/3rd/love2d/library/ | Luaファイル | LOVE2Dメタデータ |
| meta/3rd/lovr/library/ | Luaファイル | LOVRメタデータ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | モジュール名.lua（例: love.audio.lua） |
| 出力先 | meta/3rd/{フレームワーク}/library/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. package.path設定
   └─ script/?.luaとtools/?.luaを追加
2. love-api.lua実行
   └─ LOVE2Dメタデータを生成
3. lovr-api.lua実行
   └─ LOVRメタデータを生成
4. normalize-3rd-path.lua実行
   └─ ファイルパスを正規化
```

### フローチャート

```mermaid
flowchart TD
    A[build-3rd-meta.lua開始] --> B[package.path設定]
    B --> C[dofile love-api.lua]
    C --> D[dofile lovr-api.lua]
    D --> E[dofile normalize-3rd-path.lua]
    E --> F[完了]
```

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

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

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル不在 | dofile対象が見つからない | サブモジュールを初期化 |
| - | API解析エラー | APIデータの形式が不正 | サードパーティAPIを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動リトライ） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

エラーメッセージを確認し、対象のAPIファイルが正しく取得されているか確認する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行 |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | Luaランタイム依存 |

## 排他制御

同一ディレクトリでの同時実行は非推奨。出力ファイルの競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理中 | 生成ファイル情報（サブスクリプト依存） |
| 標準エラー | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | 該当なし | 該当なし |

## 備考

- dofileで各サブスクリプトを実行するため、各スクリプトのグローバル状態が共有される
- LOVE2DとLOVRのAPIバージョンは3rd/ディレクトリのサブモジュールバージョンに依存
- 新しいサードパーティフレームワークを追加する場合は、このスクリプトにdofile呼び出しを追加する
