# バッチ設計書 10-utils.js

## 概要

本ドキュメントは、Vue.jsプロジェクトのビルドスクリプト共用ユーティリティモジュール `scripts/utils.js` の設計仕様を定義するバッチ設計書である。

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

本バッチは、ビルドスクリプト群（build.js, release.js, verify-treeshaking.js等）で共有するユーティリティ関数を提供するモジュールである。ビルド対象パッケージ一覧の動的生成、パッケージ名のファジーマッチ、外部コマンド実行の3つの機能を提供する。

**業務上の目的・背景**：Vue.jsモノレポの複数のビルドスクリプトが共通して必要とする機能（対象パッケージの列挙、パッケージ名の部分一致検索、外部プロセスの実行）を一元化し、コードの重複を排除する。これにより、パッケージ構成の変更時に単一のモジュールを更新するだけで全スクリプトに反映される。

**バッチの実行タイミング**：モジュールとしてimport時に実行される。`targets` の生成（パッケージ一覧の走査）はモジュール読み込み時に即座に実行される。`fuzzyMatchTarget` と `exec` はエクスポートされた関数として呼び出し時に実行される。

**主要な処理内容**：
1. `packages/` ディレクトリを走査してビルド対象パッケージ一覧（`targets`）を動的に生成
2. パッケージ名の部分一致検索（`fuzzyMatchTarget`）を提供
3. 子プロセスの実行ラッパー（`exec`）を提供（Promise対応、stdout/stderrキャプチャ）

**前後の処理との関連**：本モジュールは以下のスクリプトからimportされる：
- `scripts/build.js`（targets, exec, fuzzyMatchTarget）
- `scripts/release.js`（exec）
- `scripts/verify-treeshaking.js`（exec）

**影響範囲**：ビルド・リリース関連スクリプトのモジュール解決とプロセス実行に影響する。ファイルシステムへの書き込みは行わない。

## バッチ種別

ユーティリティ（共有モジュール）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | import時（ビルド・リリーススクリプト実行時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | モジュールimport |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js実行環境 | Node.jsがインストールされていること |
| packagesディレクトリ | `packages/` ディレクトリが存在すること |
| package.json | 各パッケージに `package.json` が存在すること |

### 実行可否判定

`packages/` ディレクトリが存在し読み取り可能であれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | コマンドライン引数なし（モジュールとして使用） |

#### fuzzyMatchTarget 関数パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| partialTargets | ReadonlyArray<string> | Yes | - | 検索対象のパッケージ名パターン |
| includeAllMatching | boolean \| undefined | No | undefined | trueの場合、全一致パッケージを返す（falseの場合は最初の一致のみ） |

#### exec 関数パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| command | string | Yes | - | 実行するコマンド |
| args | ReadonlyArray<string> | Yes | - | コマンド引数 |
| options | object | No | {} | spawn オプション（stdio等） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/ ディレクトリ | ファイルシステム | ビルド対象パッケージ一覧の走査元 |
| packages/{pkg}/package.json | JSON | パッケージのprivate/buildOptions設定の参照 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| targets（エクスポート） | string[] | ビルド対象パッケージ名の配列 |
| fuzzyMatchTarget（エクスポート） | 関数 | パッケージ名のファジーマッチ関数 |
| exec（エクスポート） | 関数 | 外部コマンド実行のPromiseラッパー |

### 出力ファイル仕様

本バッチはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. targets配列の生成（モジュール読み込み時）
   1.1 packages/ディレクトリをreaddirSyncで走査
   1.2 各エントリに対するフィルタリング
       └─ ディレクトリであること（statSync確認）
       └─ package.jsonが存在すること（existsSync確認）
       └─ package.jsonのprivateがtrueかつbuildOptionsが未設定のパッケージは除外
   1.3 'template-explorer' を手動で追加（.concat）
2. fuzzyMatchTarget関数の定義
   2.1 partialTargets配列の各要素について、targets配列をmatchで検索
   2.2 includeAllMatchingがfalseの場合、最初の一致で検索を停止
   2.3 一致なしの場合、エラーメッセージを表示してexit(1)
3. exec関数の定義
   3.1 spawnで子プロセスを生成
       └─ stdin: 'ignore', stdout: 'pipe', stderr: 'pipe'（デフォルト）
       └─ shell: process.platform === 'win32' の場合のみtrue
   3.2 stdout/stderrをBuffer配列で蓄積
   3.3 exitイベントで終了コードを判定
       └─ code === 0: resolve({ ok, code, stderr, stdout })
       └─ code !== 0: reject(Error)
```

### フローチャート

```mermaid
flowchart TD
    A[モジュール読み込み] --> B[packages/ディレクトリ走査]
    B --> C[各パッケージのフィルタリング]
    C --> D{ディレクトリ?}
    D -->|No| E[スキップ]
    D -->|Yes| F{package.json存在?}
    F -->|No| E
    F -->|Yes| G{private && !buildOptions?}
    G -->|Yes| E
    G -->|No| H[targetsに追加]
    H --> I[template-explorerを追加]
    I --> J[targets, fuzzyMatchTarget, exec をエクスポート]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| exit(1) | ファジーマッチ不一致 | 指定パッケージ名がいずれのtargetにも一致しない | 正しいパッケージ名を指定 |
| - | コマンド実行エラー | execで実行したコマンドが非0で終了 | エラーメッセージ（stderr）を確認して原因を修正 |
| - | プロセスエラー | spawnでプロセス生成に失敗 | コマンドパスやパーミッションを確認 |

### リトライ仕様

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

### 障害時対応

fuzzyMatchTarget の不一致はプロセスを即座に終了する（exit(1)）。exec のエラーはPromiseのrejectとして伝搬するため、呼び出し元でcatch処理が可能。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | - |
| コミットタイミング | - |
| ロールバック条件 | 読み取り専用のため不要 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | packages/ディレクトリ内のパッケージ数 |
| 目標処理時間 | ミリ秒単位（ディレクトリ走査とJSON読み込み） |
| メモリ使用量上限 | 明示的な制限なし |

## 排他制御

モジュール読み込み（targets生成）は同期的に実行される。exec関数は非同期で子プロセスを実行するが、同一リソースへの排他制御は呼び出し元の責務である。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | fuzzyMatchTarget不一致時 | 「ERROR Target {target} not found!」（赤色・下線付き） |

## 監視・アラート

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

## 備考

- `targets` 配列には `private: true` かつ `buildOptions` が未設定のパッケージは含まれない。`private: true` でも `buildOptions` が設定されていればビルド対象となる
- `template-explorer` は `packages/` 内に存在するが特殊な扱いとして手動で追加される
- `exec` 関数のデフォルトstdioは `['ignore', 'pipe', 'pipe']` だが、呼び出し元のoptionsで `stdio: 'inherit'` に上書き可能
- Windows環境では `shell: true` が自動設定される（`process.platform === 'win32'`）
- `exec` 関数はstdout/stderrをBuffer配列で蓄積し、完了時にtrimして文字列化する
- `fuzzyMatchTarget` はString.prototype.matchを使用するため、正規表現パターンも使用可能
- picocolorsライブラリを使用してエラーメッセージをカラー表示する
- createRequireを使用してpackage.jsonをrequireで読み込む（ESモジュール環境でのCommonJS互換）
