# バッチ設計書 11-normalize-3rd-path.lua

## 概要

本ドキュメントは、サードパーティライブラリのパスを正規化するツールスクリプト `normalize-3rd-path.lua` のバッチ設計書です。

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

このバッチは、サードパーティライブラリ（meta/3rd）配下のLuaファイル名に含まれるドット（.）区切りの命名規則を、ディレクトリ構造に変換するツールです。例えば、`love.graphics.lua` のようなファイル名を `love/graphics.lua` のようなディレクトリ構造に変換します。

**業務上の目的・背景**：Lua言語サーバーがサードパーティライブラリ（LOVE2D、LOVRなど）のメタデータを管理する際、ライブラリのモジュール構造を反映した適切なファイル配置が必要です。APIドキュメントからメタデータを生成する際、ドット区切りのモジュール名がファイル名として使用されることがあり、これをLuaの `require` パス解決と一致させるためにディレクトリ構造に変換する必要があります。

**バッチの実行タイミング**：サードパーティライブラリのメタデータ生成後、手動で実行。主にbuild-3rd-meta.lua実行後やライブラリ更新時に使用されます。

**主要な処理内容**：
1. meta/3rdディレクトリ配下の全サブディレクトリを走査
2. 各ディレクトリのlibraryフォルダ内のファイルを検索
3. ファイル名にドット（.）が含まれるファイルを検出
4. ドット区切りをディレクトリ区切りに変換した新しいパスを計算
5. 必要なディレクトリを作成し、ファイルを移動（リネーム）

**前後の処理との関連**：build-3rd-meta.lua、love-api.lua、lovr-api.luaなどのメタデータ生成スクリプトの後に実行されることを想定しています。これらのスクリプトがドット区切りのファイル名でメタデータを出力した場合に、本スクリプトで正規化します。

**影響範囲**：meta/3rd/*/library/ 配下のLuaファイル。ファイルシステム上のファイル配置が変更されます。

## バッチ種別

ファイル変換・パス正規化

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 / メタデータ生成後 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| meta/3rdディレクトリの存在 | サードパーティライブラリのメタデータ格納ディレクトリが存在すること |
| libraryサブディレクトリの存在 | 各サードパーティライブラリにlibraryディレクトリが存在すること |
| ファイルシステムへの書き込み権限 | ファイル移動・ディレクトリ作成のための権限があること |

### 実行可否判定

meta/3rdディレクトリが存在し、その配下にlibraryディレクトリを持つサブディレクトリが存在する場合に処理を実行します。対象ファイルがない場合は何も行わずに終了します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| meta/3rd/*/library/*.lua | ファイルシステム | 変換対象のLuaメタデータファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| meta/3rd/*/library/**/*.lua | ファイルシステム | 正規化後のLuaメタデータファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 元ファイルのドットをスラッシュに変換し、末尾に.luaを付与 |
| 出力先 | 元ファイルと同じlibraryディレクトリ配下の新規作成されたディレクトリ |
| 文字コード | 変更なし（ファイル移動のため） |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. モジュール初期化
   └─ bee.filesystem と fs-utility モジュールを読み込み

2. meta/3rdディレクトリの走査
   └─ thirdPath (meta/3rd) 配下のディレクトリを列挙

3. 各サードパーティディレクトリの処理
   └─ libraryサブディレクトリの存在確認

4. libraryディレクトリ内のファイル走査
   └─ fsu.scanDirectory で全ファイルを列挙

5. ドット区切りファイル名の検出
   └─ ファイル名（stem）にドットが含まれるか確認

6. 新しいパスの計算
   └─ ドットをスラッシュに置換し、.lua拡張子を付与

7. ディレクトリ作成
   └─ 新パスの親ディレクトリを再帰的に作成

8. ファイル移動
   └─ fs.rename で元ファイルを新パスに移動
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[meta/3rd ディレクトリ走査]
    B --> C{ディレクトリあり?}
    C -->|なし| Z[バッチ終了]
    C -->|あり| D[次のディレクトリを取得]
    D --> E{library サブディレクトリあり?}
    E -->|なし| C
    E -->|あり| F[library 内ファイル走査]
    F --> G{ファイルあり?}
    G -->|なし| C
    G -->|あり| H[次のファイルを取得]
    H --> I{ファイル名にドットあり?}
    I -->|なし| G
    I -->|あり| J[新パスを計算]
    J --> K[親ディレクトリ作成]
    K --> L[ファイル移動]
    L --> G
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベースは使用しない |

### テーブル別操作詳細

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ディレクトリ作成失敗 | 権限不足またはディスク容量不足 | 権限確認・ディスク空き容量確認 |
| - | ファイル移動失敗 | 移動先ファイルが既に存在・権限不足 | 既存ファイルの確認・権限確認 |

### リトライ仕様

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

### 障害時対応

ファイル移動が部分的に失敗した場合、一部ファイルのみが移動された状態になる可能性があります。再実行することで残りのファイルを処理できます。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百ファイル程度 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

ファイルシステム操作のみのため、同時実行は避けることを推奨します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | ログ出力機能は実装されていない |

## 監視・アラート

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

## 備考

- このスクリプトは `tools/normalize-3rd-path.lua` に配置されています
- bee.filesystem と fs-utility モジュールに依存します
- ファイル名のstem（拡張子を除いた部分）にドットが含まれる場合のみ処理対象となります
