# バッチ設計書 1-make.sh

## 概要

本ドキュメントは、lua-language-serverプロジェクトのUnix/Linux/macOS環境向けビルドスクリプト「make.sh」の設計仕様を定義するものである。

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

make.shは、lua-language-serverプロジェクトをソースコードからビルドするためのシェルスクリプトである。Git Submoduleの初期化・更新とluamakeビルドツールによるリビルドを実行し、実行可能なlua-language-serverバイナリを生成する。

**業務上の目的・背景**：lua-language-serverは、Luaプログラミング言語のLanguage Server Protocol (LSP)実装であり、VSCodeや他のエディタでLuaの補完・診断機能を提供する。このビルドスクリプトは、開発者がソースコードから最新のlua-language-serverをビルドするために必要不可欠である。プリビルドバイナリが提供されていない環境や、カスタムビルドが必要な場合に使用される。

**バッチの実行タイミング**：手動実行が基本。開発者がソースコードを取得した後、初回セットアップ時に実行する。また、ソースコードを更新した後や、クリーンビルドが必要な場合にも実行される。

**主要な処理内容**：
1. git submodule update --init --recursiveを実行し、依存サブモジュール（bee.lua、luamakeなど）を初期化・更新
2. 3rd/luamake/compile/build.shを実行し、luamakeビルドツール自体をビルド
3. luamake rebuildを実行し、lua-language-server本体をビルド

**前後の処理との関連**：このスクリプトはビルドプロセスの起点となる。ビルド完了後、bin/lua-language-serverが生成され、main.luaを介して言語サーバーを起動できる。

**影響範囲**：bin/ディレクトリ配下にビルド成果物が出力される。既存のバイナリは上書きされる。

## バッチ種別

ビルド処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Git | Gitコマンドが利用可能であること |
| Bash | Bashシェルが利用可能であること |
| C/C++コンパイラ | GCCまたはClangがインストールされていること |
| 作業ディレクトリ | プロジェクトルートディレクトリで実行すること |

### 実行可否判定

プロジェクトルートディレクトリにmake.shが存在し、実行権限があること。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $1 | string | No | なし | ターゲットプラットフォーム指定（例: linux, darwin） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースコード | ファイル | プロジェクト全体のソースコード |
| .gitmodules | 設定ファイル | Git Submoduleの定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| bin/lua-language-server | 実行可能ファイル | ビルドされた言語サーバーバイナリ |
| bin/main.lua | Luaファイル | ブートストラップスクリプト |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | lua-language-server |
| 出力先 | bin/ |
| 文字コード | バイナリ |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. Git Submodule更新
   └─ git submodule update --init --recursive
2. luamakeビルド
   └─ 3rd/luamake/compile/build.shを実行
3. lua-language-serverビルド
   └─ luamake rebuildを実行（プラットフォーム指定がある場合は--platformオプション付き）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[git submodule update --init --recursive]
    B --> C[3rd/luamakeディレクトリに移動]
    C --> D[./compile/build.sh実行]
    D --> E[元のディレクトリに戻る]
    E --> F{プラットフォーム引数あり?}
    F -->|あり| G[luamake rebuild --platform $1]
    F -->|なし| H[luamake rebuild]
    G --> I[バッチ終了]
    H --> I
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | Submodule更新失敗 | ネットワーク接続不可、認証失敗 | ネットワーク接続を確認、SSH/HTTPS認証設定を確認 |
| 1 | コンパイラ不在 | C/C++コンパイラが見つからない | GCC/Clangをインストール |
| 1 | ビルド失敗 | ソースコードエラー、依存関係不足 | ビルドログを確認し、不足パッケージをインストール |

### リトライ仕様

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

### 障害時対応

ビルド失敗時は標準エラー出力を確認し、エラーメッセージに従って対処する。一般的な対処としては、依存ライブラリのインストール、コンパイラのバージョン確認が挙げられる。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のビルド |
| 目標処理時間 | 環境依存（通常1-5分） |
| メモリ使用量上限 | コンパイラ依存 |

## 排他制御

同一ディレクトリでの同時実行は非推奨。ビルド成果物の競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理中 | git、コンパイラの進捗メッセージ |
| 標準エラー | エラー発生時 | コンパイルエラー詳細 |

## 監視・アラート

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

## 備考

- クロスコンパイルを行う場合は、$1引数でターゲットプラットフォームを指定する
- Windows環境ではmake.batを使用すること
