# バッチ設計書 23-scripts/pack-and-install.sh

## 概要

本ドキュメントは、Decap CMSプロジェクトにおける全パッケージのローカルpack及びテストプロジェクトへのインストールを行うシェルスクリプト `scripts/pack-and-install.sh` の設計を記述する。

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

本スクリプトは、Decap CMSモノレポ内の全対象パッケージをビルド・packし、指定されたテストプロジェクトにローカルインストールするためのシェルスクリプトである。npmレジストリに公開する前に、パッケージの動作をローカル環境でテストするために使用する。

**業務上の目的・背景**：Decap CMSのパッケージをnpmに公開する前に、ローカル環境で実際のプロジェクトに組み込んで動作確認を行う必要がある。本スクリプトにより、30以上のパッケージを一括でpack・インストールする手順を自動化し、手作業によるミスを防止する。これにより、リリース前の品質確認を効率的に実施できる。

**バッチの実行タイミング**：手動実行。新バージョンのリリース前テストや、開発中のパッケージをローカルのテストプロジェクトで検証する際に実行される。

**主要な処理内容**：
1. 引数で指定されたテストプロジェクトパスの検証（存在チェック）
2. `npm run build` による全パッケージのビルド
3. PACKAGES配列に定義された31個のパッケージを順次 `npm pack` でtgzファイル生成
4. 生成されたtgzファイルのパスを収集
5. テストプロジェクトディレクトリに移動し、全tgzファイルを `npm install` でインストール

**前後の処理との関連**：ビルドバッチ（`npm run build`）を内部で呼び出すため、ビルド環境が正しく構成されている必要がある。後続処理としてテストプロジェクトでのアプリケーション動作確認が行われる。

**影響範囲**：テストプロジェクトのnode_modules及びpackage.jsonに影響する。各パッケージディレクトリにtgzファイルが生成される。

## バッチ種別

ユーティリティ（ローカルパッケージのpack・インストール自動化）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（`./scripts/pack-and-install.sh /path/to/test/project`） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| テストプロジェクトパスの指定 | 第1引数にテストプロジェクトのディレクトリパスを指定すること |
| テストプロジェクトの存在 | 指定されたテストプロジェクトディレクトリが存在すること |
| Node.js/npm | Node.jsとnpmが利用可能であること |
| 依存関係のインストール | プロジェクトのnode_modulesがインストール済みであること |

### 実行可否判定

1. 引数が未指定の場合、使用方法を表示して終了（exit 1）
2. テストプロジェクトディレクトリが存在しない場合、エラーメッセージを表示して終了（exit 1）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $1（TEST_PROJECT_PATH） | 文字列 | Yes | なし | テストプロジェクトのディレクトリパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| PACKAGES配列（スクリプト内定義） | Bash配列 | pack対象の31パッケージ名リスト |
| packages/*/dist | ファイルシステム | ビルド済みの各パッケージのdistディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| packages/{パッケージ名}/*.tgz | tgzファイル | npm packで生成されたパッケージアーカイブ |
| テストプロジェクトのnode_modules | ディレクトリ | インストールされたDecap CMSパッケージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | `{パッケージ名}-{バージョン}.tgz` |
| 出力先 | `packages/{パッケージ名}/` |
| 文字コード | バイナリ（tgz） |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. 引数バリデーション
   ├─ $1（テストプロジェクトパス）が未指定の場合、使用方法を表示して終了
   └─ テストプロジェクトディレクトリの存在確認。存在しない場合エラー終了
2. 全パッケージのビルド
   └─ npm run build を実行
3. 各パッケージのpack処理（ループ）
   ├─ packages/{パッケージ名} ディレクトリに移動
   ├─ npm pack を実行してtgzファイルを生成
   └─ プロジェクトルートに戻る
4. tgzファイルパスの収集
   ├─ 各パッケージディレクトリからtgzファイルを検索
   └─ find コマンドで最初に見つかったtgzファイルのパスを取得
5. テストプロジェクトへのインストール
   ├─ テストプロジェクトディレクトリに移動
   └─ 全tgzファイルパスを引数にnpm installを実行
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B{引数チェック}
    B -->|未指定| C[使用方法表示・終了]
    B -->|指定あり| D{ディレクトリ存在チェック}
    D -->|存在しない| E[エラー表示・終了]
    D -->|存在する| F[npm run build]
    F --> G[パッケージループ開始]
    G --> H[cd packages/パッケージ名]
    H --> I[npm pack]
    I --> J[cd ../../]
    J --> K{全パッケージ完了?}
    K -->|No| G
    K -->|Yes| L[tgzファイルパス収集]
    L --> M[cd テストプロジェクト]
    M --> N[npm install tgzファイル群]
    N --> O[スクリプト終了]
```

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

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

本スクリプトはデータベース操作を行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| exit 1 | 引数不足エラー | テストプロジェクトパスが未指定 | 使用方法に従いパスを指定する |
| exit 1 | ディレクトリ不在エラー | 指定されたテストプロジェクトディレクトリが存在しない | 正しいパスを指定する |
| N/A | ビルドエラー | npm run buildが失敗 | ビルドエラーの原因を解消する |
| N/A | packエラー | npm packが失敗 | パッケージのpackage.jsonを確認する |
| Warning | tgz未検出警告 | パッケージのtgzファイルが見つからない | 該当パッケージのpack結果を確認する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A（リトライ機構なし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

ビルドまたはpack処理が途中で失敗した場合、生成されたtgzファイルを手動で削除し、再度スクリプトを実行する。テストプロジェクトのnode_modulesが不整合な状態の場合は、テストプロジェクト側でnode_modulesを削除して再インストールする。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイルシステム操作のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A（途中失敗時の自動ロールバックなし） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 31パッケージのビルド・pack・インストール |
| 目標処理時間 | 数分〜10分程度（ビルド時間に依存） |
| メモリ使用量上限 | Webpackビルドプロセスに依存 |

## 排他制御

排他制御は不要だが、同時に複数回実行した場合はtgzファイルの上書き競合が発生する可能性がある。同時実行は避けること。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド開始時 | `Building all packages...` |
| 進捗ログ | 各パッケージpack時 | `Packing {パッケージ名}...` |
| 完了ログ | 全pack完了時 | `All packages packed!` |
| 警告ログ | tgz未検出時 | `Warning: No .tgz file found for {パッケージ名}` |
| エラーログ | 引数不足時 | 使用方法の表示 |
| エラーログ | ディレクトリ不在時 | `Error: Test project directory '{パス}' does not exist` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | 手動実行スクリプトのため監視対象外 |

## 備考

- PACKAGES配列には31個のパッケージが定義されている（decap-cms-lib-util, decap-cms-lib-auth, decap-cms-lib-widgets, decap-cms-ui-default, 各バックエンド、各ウィジェット、decap-cms-editor-component-image, decap-cms-locales, decap-cms-core, decap-cms-app）
- tgzファイルの検索パスに `../decap-cms/packages/` が使用されているが、これはスクリプトの実行ディレクトリに依存する
- `eval` を使用してnpm installコマンドを実行しているため、パスに特殊文字が含まれる場合は注意が必要
- テストプロジェクト側のpackage.jsonにDecap CMSパッケージの依存定義が必要
