# バッチ設計書 14-yarn:install

## 概要

本ドキュメントは、Railsフレームワークに含まれるRakeタスク `yarn:install` の設計仕様を記載したものです。このタスクは `javascript:install` タスクへのエイリアスであり、Yarn経由でJavaScript依存関係をインストールします。

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

このバッチは、`javascript:install` タスクを呼び出すエイリアスタスクです。実際の処理内容は `javascript:install` タスクと完全に同一であり、歴史的な互換性のために提供されています。

**業務上の目的・背景**：Railsアプリケーションでは、従来Yarnを標準のJavaScriptパッケージマネージャーとして使用してきました。Rails 7以降では複数のパッケージマネージャー（npm、pnpm、bun）もサポートされるようになりましたが、既存のスクリプトやドキュメントとの互換性のために `yarn:install` コマンドが維持されています。このタスクは、開発者が慣れ親しんだコマンド名で依存関係をインストールできるようにします。

**バッチの実行タイミング**：プロジェクトの初期セットアップ時、新しいJavaScript依存関係の追加後、CI/CDパイプラインでのビルド前に実行されます。`javascript:install`と同じタイミングで使用できます。

**主要な処理内容**：
1. `javascript:install` タスクを呼び出す
2. （以降は `javascript:install` の処理に委譲）

**前後の処理との関連**：このタスクは `javascript:install` タスクの単純なエイリアスです。機能的な違いはありません。

**影響範囲**：`javascript:install` と同一です。node_modulesディレクトリへのJavaScriptパッケージのインストールを行います。

## バッチ種別

環境構築 / 依存関係インストール（エイリアス）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行またはCI/CD） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（bin/rails yarn:install）またはCI/CDスクリプト |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Railsアプリケーション | 有効なRailsプロジェクト内で実行すること |
| package.json | プロジェクトルートにpackage.jsonが存在すること |
| パッケージマネージャー | npm、yarn、pnpm、bunのいずれかがインストールされていること |
| Node.js | Node.jsがインストールされPATHに含まれていること |

### 実行可否判定

`javascript:install` と同一の判定ロジックが適用されます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| NODE_ENV | String | No | Rails.envに基づく | JavaScriptビルド環境（test/development/production） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| package.json | JSON | JavaScript依存関係定義ファイル |
| ロックファイル | 各形式 | yarn.lock / package-lock.json / pnpm-lock.yaml / bun.lockb |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| node_modules/ | ディレクトリ | インストールされたJavaScriptパッケージ |
| 標準出力（STDOUT） | テキスト | インストール進捗・結果 |
| 標準エラー出力（STDERR） | テキスト | エラーメッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 出力先 | node_modules/ |
| 形式 | パッケージマネージャー固有の形式 |

## 処理フロー

### 処理シーケンス

```
1. yarn:installタスク開始
   └─ Rakeタスクの依存関係として javascript:install を指定
2. javascript:installタスクに処理を委譲
   └─ 以降の処理は javascript:install と同一
```

### フローチャート

```mermaid
flowchart TD
    A[yarn:install開始] --> B[javascript:install呼び出し]
    B --> C[javascript:installの処理を実行]
    C --> D[処理完了]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| exit 1 | Errno::ENOENT | パッケージマネージャーが見つからない | 該当するパッケージマネージャーをインストール |
| exit 1 | 実行エラー | インストールコマンドが失敗 | エラーメッセージを確認し原因を解決 |

### リトライ仕様

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

### 障害時対応

`javascript:install` と同一の対応手順に従ってください。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 依存パッケージ数に依存 |
| 目標処理時間 | 依存パッケージ数とネットワーク速度に依存 |
| メモリ使用量上限 | パッケージマネージャーの制限に依存 |

## 排他制御

`javascript:install` と同一です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理中 | インストール進捗 |
| 標準エラー出力 | エラー発生時 | パッケージマネージャー名とエラー内容 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDシステム |

## 備考

- このタスクは `javascript:install` への単純なエイリアスです
- タスク名は「yarn:install」ですが、実際にはプロジェクトで使用されているパッケージマネージャー（npm、pnpm、bun含む）が自動検出されます
- 歴史的経緯により、Railsではかつてyarnが標準パッケージマネージャーでした
- 新規プロジェクトでは `javascript:install` の使用を推奨しますが、`yarn:install` も引き続きサポートされます
- 詳細な処理内容については「13-javascript_install.md」を参照してください
