# バッチ設計書 8-locale.lua

## 概要

本ドキュメントは、ロケールファイルの同期・管理を行うツール「locale.lua」の設計仕様を定義するものである。

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

locale.luaは、lua-language-serverの多言語対応（i18n）を管理するためのツールである。script、meta、settingの各カテゴリのロケールファイルを読み込み、言語間でキーを同期し、翻訳が必要な項目にTODOマークを付けて出力する。

**業務上の目的・背景**：lua-language-serverは多言語対応しており、各言語のロケールファイルを同期的に管理する必要がある。英語（en-us）をベースとして、他の言語への翻訳状況を追跡し、未翻訳項目を明示する。このツールにより、国際化対応の品質を維持できる。

**バッチの実行タイミング**：手動実行。新しいメッセージキーが追加された場合、またはロケールファイルを整理する場合に実行する。

**主要な処理内容**：
1. locale/配下の全言語ディレクトリを列挙
2. script.lua、meta.lua、setting.luaの各ロケールファイルを読み込み
3. 全言語のキーをマージして統一キーリストを作成
4. 各言語ファイルを再生成（未翻訳項目にはTODOコメントを付加）
5. キーをカテゴリごとにブロック分けして出力

**前後の処理との関連**：単独で実行される。ロケールファイルの更新後、build-doc.luaを実行してドキュメントを再生成することが推奨される。

**影響範囲**：locale/配下の全言語ディレクトリのscript.lua、meta.lua、setting.luaが更新される。

## バッチ種別

ロケール管理・同期処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Luaランタイム | Luaインタープリタが利用可能であること |
| localeディレクトリ | locale/配下に言語ディレクトリが存在すること |
| ベース言語 | en-usロケールファイルが存在すること |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| locale/{lang}/script.lua | Lua | スクリプトメッセージのロケール |
| locale/{lang}/meta.lua | Lua | メタデータのロケール |
| locale/{lang}/setting.lua | Lua | 設定項目のロケール |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| locale/{lang}/script.lua | Lua | 同期済みスクリプトロケール |
| locale/{lang}/meta.lua | Lua | 同期済みメタロケール |
| locale/{lang}/setting.lua | Lua | 同期済み設定ロケール |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | script.lua / meta.lua / setting.lua |
| 出力先 | locale/{言語}/ |
| 文字コード | UTF-8 |
| 区切り文字 | 改行 |

## 処理フロー

### 処理シーケンス

```
1. 言語ディレクトリ列挙
   └─ locale/配下のディレクトリ名を収集
2. ファイルタイプループ（script, meta, setting）
   └─ 各ファイルタイプについて以下を実行
3. ロケールファイル読み込み
   └─ loadLocaleFile関数で各言語のファイルをパース
   └─ キー、行番号、スペース、コメント、内容を抽出
   └─ ロングストリング（[=[...]=]形式）に対応
4. キーマージ
   └─ mergeList関数で全言語のキーを統合
   └─ キーの順序を保持
5. ファイル再生成
   └─ buildLocaleFile関数で各言語のファイルを生成
   └─ 未翻訳項目には" -- TODO: need translate!"を付加
   └─ キーをブロック分け（先頭文字が異なる場合）
6. ファイル保存
   └─ util.saveFileで出力
```

### フローチャート

```mermaid
flowchart TD
    A[locale.lua開始] --> B[言語ディレクトリ列挙]
    B --> C[ファイルタイプループ開始]
    C --> D[各言語のロケールファイル読み込み]
    D --> E[ロングストリング解析]
    E --> F[キーマージ処理]
    F --> G[言語ループ開始]
    G --> H[ファイル内容生成]
    H --> I{翻訳あり?}
    I -->|Yes| J[そのまま出力]
    I -->|No| K[TODOコメント付加]
    J --> L[ブロック分け]
    K --> L
    L --> M[ファイル保存]
    M --> N{次の言語あり?}
    N -->|Yes| G
    N -->|No| O{次のファイルタイプあり?}
    O -->|Yes| C
    O -->|No| P[完了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル読み込みエラー | ロケールファイルが読み込めない | ファイル権限を確認 |
| - | パースエラー | ロケールファイルの形式が不正 | ファイル内容を確認 |

### リトライ仕様

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

### 障害時対応

エラーメッセージを確認し、対象のロケールファイルの構文を確認する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 言語数 × ファイルタイプ数（3） × キー数 |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | Luaランタイム依存 |

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | なし | - |
| 標準エラー | エラー発生時 | エラー詳細 |

## 監視・アラート

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

## 備考

- ロングストリング（[=[ ... ]=]形式）の解析に対応
- en-usの内容がUTF-8文字比率0.8未満の場合、翻訳が必要としてマーク
- meta.luaにはファイル先頭に`---@diagnostic disable: undefined-global, lowercase-global`を追加
- setting.luaにはファイル先頭に`---@diagnostic disable: undefined-global`を追加
- キーの先頭文字（アルファベット/数字部分）が変わる場所で空行を挿入してブロック分け
- 同一キーが複数回出現した場合、最初の定義のみを使用
