# バッチ設計書 21-koch.nim（zip）

## 概要

本ドキュメントは、Nimコンパイラのインストール用ZIPパッケージを生成するバッチ処理「koch zip」の設計書です。kochコマンドのzipサブコマンドとして実行され、Windows向けの配布パッケージを作成します。

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

**業務上の目的・背景**：Nimコンパイラをユーザーに配布するためには、実行ファイル、ライブラリ、ドキュメント、設定ファイルなどを一つのパッケージにまとめる必要があります。本バッチは、Windows環境でNimを簡単にインストール・利用できるようZIPアーカイブ形式でパッケージングを行います。これにより、エンドユーザーはZIPファイルを展開するだけでNimコンパイラを利用開始できます。

**バッチの実行タイミング**：リリース作業時（新バージョンの公開前）に手動で実行します。通常、コンパイラのビルド（koch boot）完了後、Cソースコード生成（koch csource）後に実行されます。

**主要な処理内容**：
1. checksums依存パッケージのクローンと準備（bundleChecksums）
2. Nimbleパッケージマネージャの実行ファイルビルド（bundleNimbleExe）
3. Atlasパッケージマネージャの実行ファイルビルド（bundleAtlasExe）
4. nimsuggestツールのビルド（bundleNimsuggest）
5. nimprettyツールのビルド（bundleNimpretty）
6. Windowsツール群のビルド（bundleWinTools: finish.nim, vccexe, nimgrab, nimgrep, testament）
7. niminstによるスクリプト生成
8. niminstによるZIPアーカイブ作成

**前後の処理との関連**：
- 前提バッチ：koch boot（コンパイラビルド）が完了していること
- 後続バッチ：生成されたZIPファイルは配布サーバへアップロードされる

**影響範囲**：buildディレクトリ配下にZIPファイルが生成されます。dist/配下に依存パッケージがクローンされます。bin/配下にツール群の実行ファイルが生成されます。

## バッチ種別

パッケージ生成 / リリース処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Nimコンパイラ | bin/nim.exe が存在すること（koch bootで生成済み） |
| Git | Gitコマンドが利用可能であること（依存パッケージのクローンに使用） |
| 7z | 7-Zipが利用可能であること（ZIPアーカイブ作成に使用） |
| ネットワーク接続 | 依存パッケージをGitHubからクローンするため必要 |

### 実行可否判定

koch.nimのzip関数が呼び出される際、特別な実行可否判定は行われません。必要な依存ツールが存在しない場合は処理中にエラーとなります。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --latest | フラグ | No | false | 最新版の依存パッケージを使用する場合に指定 |
| --stable | フラグ | No | true | 安定版の依存パッケージを使用（デフォルト） |
| args | string | No | "" | niminstに渡す追加引数 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| compiler/installer.ini | INIファイル | インストーラ設定ファイル、パッケージに含めるファイル一覧を定義 |
| NimbleStableCommit | 定数 | Nimbleの安定版コミットハッシュ |
| AtlasStableCommit | 定数 | Atlasの安定版コミットハッシュ |
| ChecksumsStableCommit | 定数 | checksumsの安定版コミットハッシュ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| build/nim-{version}.zip | ZIPアーカイブ | Nimコンパイラのインストール用ZIPパッケージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | nim-{version}.zip（例：nim-2.0.0.zip） |
| 出力先 | build/ |
| 文字コード | バイナリ |
| 圧縮形式 | ZIP |

## 処理フロー

### 処理シーケンス

```
1. bundleChecksums(latest)
   └─ checksums/nimonyリポジトリをdist/配下にクローン
   └─ nifler/nifmakeツールをビルド

2. bundleNimbleExe(latest, args)
   └─ nimbleリポジトリをdist/配下にクローン
   └─ サブモジュールを更新
   └─ nimble.exeをビルド

3. bundleAtlasExe(latest, args)
   └─ atlasリポジトリをdist/配下にクローン
   └─ satリポジトリをdist/atlas/dist/配下にクローン
   └─ atlas.exeをビルド

4. bundleNimsuggest(args)
   └─ nimsuggest.exeをビルド

5. bundleNimpretty(args)
   └─ nimpretty.exeをビルド

6. bundleWinTools(args)
   └─ finish.exe, vccexe.exe, nimgrab.exe, nimgrep.exe, testament.exeをビルド

7. niminstスクリプト生成
   └─ compiler/installer.iniに基づきスクリプトを生成

8. niminstでZIP生成
   └─ ZIPアーカイブを作成しbuild/配下に出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[bundleChecksums]
    B --> C[bundleNimbleExe]
    C --> D[bundleAtlasExe]
    D --> E[bundleNimsuggest]
    E --> F[bundleNimpretty]
    F --> G[bundleWinTools]
    G --> H[niminstスクリプト生成]
    H --> I[niminst ZIP生成]
    I --> J[バッチ終了]
```

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

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

本バッチはデータベースを使用しません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Git clone失敗 | ネットワーク接続エラー、リポジトリが存在しない | ネットワーク接続を確認、コミットハッシュを確認 |
| - | コンパイルエラー | Nimコンパイラが正常に動作しない | koch bootを再実行 |
| - | 7z実行エラー | 7-Zipがインストールされていない | 7-Zipをインストール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Git cloneのみretryCallで自動リトライ |
| リトライ間隔 | deps.nimのretryCall実装による |
| リトライ対象エラー | Gitコマンドの一時的な失敗 |

### 障害時対応

1. dist/配下の該当リポジトリを削除し、再実行
2. ネットワーク接続を確認
3. 必要な外部ツール（Git, 7z）のインストールを確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイル操作のみ） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし（エラー時は中断、手動で再実行） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のリリースで1回実行 |
| 目標処理時間 | 数分〜十数分（ネットワーク速度・マシン性能による） |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行は想定していません。同一ディレクトリで複数のkoch zipを並列実行すると、dist/やbuild/配下のファイルが競合する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各処理実行時 | 実行中のコマンド（echo出力） |
| エラーログ | エラー発生時 | エラーメッセージ（quit呼び出し） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | 手動実行のため自動監視なし |

## 備考

- Windows向けのパッケージ生成を目的としているため、主にWindows環境での実行を想定
- --latestオプションを使用すると、依存パッケージの最新版（HEAD）を使用
- installer.iniファイルでパッケージに含めるファイルが定義されている
- ZIPファイル生成には7-Zip（7z）コマンドが必要
