# 機能設計書 23-CommonJSライブラリ出力

## 概要

本ドキュメントは、webpackのAssignLibraryPlugin（commonjs/commonjs2/commonjs-module/commonjs-staticタイプ）によるCommonJS形式でのライブラリ出力機能について記述する。

### 本機能の処理概要

CommonJSライブラリ出力機能は、AssignLibraryPluginを異なるプレフィックス設定で利用し、CommonJS形式（`module.exports` / `exports`）でライブラリを出力する。独立したCommonJsLibraryPlugin.jsは存在せず、EnableLibraryPluginにおいてAssignLibraryPluginが適切なオプションで構成される。

**業務上の目的・背景**：Node.js環境やCommonJSに対応したバンドラーで利用されるライブラリを出力するため、`module.exports` や `exports` オブジェクトへの代入形式でバンドルを生成する必要がある。複数のCommonJSバリエーション（commonjs, commonjs2, commonjs-module, commonjs-static）に対応することで、様々なモジュールシステムとの互換性を確保する。

**機能の利用シーン**：Node.jsパッケージの構築時に `output.library.type: 'commonjs'` / `'commonjs2'` / `'commonjs-module'` / `'commonjs-static'` を指定して利用する。`commonjs`は`exports[name]`形式、`commonjs2`は`module.exports`形式、`commonjs-static`は`exports`への個別プロパティコピー形式で出力する。

**主要な処理内容**：
1. EnableLibraryPluginがタイプに応じたAssignLibraryPluginを構成する
2. renderメソッドで変数宣言（declare="var"の場合）を先頭に追加する
3. renderStartupメソッドでエクスポートの代入コードを生成する
4. プレフィックス（`["exports"]` / `["module", "exports"]`）に基づき代入先を決定する

**関連システム・外部連携**：AssignLibraryPluginを基盤とし、EnableLibraryPluginから適切なオプションで初期化される。

**権限による制御**：本機能に権限による制御はない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面機能マッピングに該当する画面なし |

## 機能種別

コード生成処理（CommonJS形式エクスポートコードの生成）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| library.name | string \| string[] | タイプ依存 | ライブラリ名 | commonjs: 任意、commonjs2: 任意、commonjs-static: 任意 |
| library.export | string \| string[] | No | エクスポートするプロパティ名 | - |
| type | string | Yes | commonjs / commonjs2 / commonjs-module / commonjs-static | - |

### 入力データソース

webpack設定の `output.library` オプション。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| source | ConcatSource | CommonJS形式エクスポート付きバンドルソース |

### 出力先

JavascriptModulesPluginのrenderStartupフックを通じて、バンドルファイルとして出力される。

## 処理フロー

### 処理シーケンス

```
1. EnableLibraryPluginでのタイプ別初期化
   ├─ commonjs: prefix=["exports"], declare=false, unnamed="copy"
   ├─ commonjs-static: prefix=["exports"], declare=false, unnamed="static"
   ├─ commonjs2: prefix=["module","exports"], declare=false, unnamed="assign"
   └─ commonjs-module: prefix=["module","exports"], declare=false, unnamed="assign"
2. renderStartupでのエクスポートコード生成
   ├─ unnamed="static"の場合
   │   ├─ 既知エクスポートを個別にプロパティ代入
   │   ├─ 未知エクスポートをfor-inループでコピー
   │   └─ __esModuleプロパティを定義
   ├─ unnamed="copy" / named="copy"の場合
   │   ├─ for-inループで全プロパティをコピー
   │   └─ __esModule存在時にObject.definePropertyで設定
   └─ unnamed="assign"の場合
       └─ module.exports = __webpack_exports__ の直接代入
```

### フローチャート

```mermaid
flowchart TD
    A[renderStartup呼び出し] --> B[fullNameResolvedの解決]
    B --> C{unnamedモード?}
    C -->|static| D[既知エクスポートの個別プロパティ代入]
    D --> E[未知エクスポートのfor-inコピー]
    E --> F[__esModule定義]
    C -->|copy| G[for-inループで全プロパティコピー]
    G --> H[__esModule条件付き定義]
    C -->|assign| I[module.exports直接代入]
    F --> J[ConcatSource返却]
    H --> J
    I --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | commonjsプレフィックス | exports オブジェクトへのプロパティ代入 | type='commonjs' |
| BR-02 | commonjs2プレフィックス | module.exports への代入 | type='commonjs2' / 'commonjs-module' |
| BR-03 | staticエクスポート | 既知エクスポートは個別代入、未知はfor-inでコピー | type='commonjs-static' |
| BR-04 | copyエクスポート | 全プロパティをfor-inでコピー | unnamed='copy' |
| BR-05 | assignエクスポート | __webpack_exports__を直接代入 | unnamed='assign' |

### 計算ロジック

代入先の解決：`prefix + name` を連結し、`accessWithInit` 関数で中間オブジェクトの初期化付きアクセスコードを生成する。

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

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

本機能にデータベース操作はない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Error | unnamed="error"でnameが未指定 | "Library name must be a string or string array" |
| - | Error | var宣言時にライブラリ名が無効な識別子 | "Library name base must be a valid identifier" |

### リトライ仕様

リトライ処理はない。

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

トランザクション管理はない。

## パフォーマンス要件

エクスポートコードの生成はコンパイル時の処理であり、パフォーマンスへの影響は軽微である。

## セキュリティ考慮事項

本機能にセキュリティ上の特別な考慮事項はない。

## 備考

- 独立した `CommonJsLibraryPlugin.js` は存在しない。全てAssignLibraryPluginで実装されている
- commonjsとcommonjs2の主な違い：commonjsは`exports[name]`形式、commonjs2は`module.exports`形式
- commonjs-staticはcommonjsの拡張で、ESModuleの名前付きエクスポートを個別プロパティとして公開する

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | AssignLibraryPlugin.js | `lib/library/AssignLibraryPlugin.js` | AssignLibraryPluginOptions型（102-108行目）- type, prefix, declare, unnamed, named |
| 1-2 | AssignLibraryPlugin.js | `lib/library/AssignLibraryPlugin.js` | AssignLibraryPluginParsed型（113-116行目）- name, export |

**読解のコツ**: `prefix` と `unnamed` の組み合わせが出力形式を決定する。`prefix=["exports"]` がCommonJS、`prefix=["module","exports"]` がCommonJS2を意味する。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | EnableLibraryPlugin.js | `lib/library/EnableLibraryPlugin.js` | 184-220行目: commonjs/commonjs-static/commonjs2/commonjs-moduleの構成 |

**主要処理フロー**:
1. **184-194行目**: `case 'commonjs':` - prefix=["exports"], unnamed="copy"
2. **196-206行目**: `case 'commonjs-static':` - prefix=["exports"], unnamed="static"
3. **208-219行目**: `case 'commonjs2':` / `case 'commonjs-module':` - prefix=["module","exports"], unnamed="assign"

#### Step 3: レンダリング処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | AssignLibraryPlugin.js | `lib/library/AssignLibraryPlugin.js` | 303-406行目: renderStartupメソッド |

**主要処理フロー**:
- **314行目**: staticExports判定（unnamed === "static"）
- **321-372行目**: staticエクスポートの処理（個別プロパティ代入 + for-inコピー + __esModule）
- **373-395行目**: copyエクスポートの処理（for-in + __esModule条件付き）
- **396-403行目**: assignエクスポートの処理（直接代入）

### プログラム呼び出し階層図

```
EnableLibraryPlugin.apply()
    │
    └─ AssignLibraryPlugin(commonjsオプション).apply()
           │
           ├─ AbstractLibraryPlugin.apply()
           │      ├─ hooks.finishModules.tap() ──▶ finishEntryModule()
           │      ├─ hooks.render.tap() ──▶ render()
           │      └─ hooks.renderStartup.tap() ──▶ renderStartup()
           │
           ├─ render() - var宣言の追加（declare="var"の場合のみ）
           │
           └─ renderStartup() - エクスポート代入コード生成
                  ├─ staticモード: 個別代入 + for-in + __esModule
                  ├─ copyモード: for-in + __esModule
                  └─ assignモード: 直接代入
```

### データフロー図

```
[入力]                          [処理]                           [出力]

library.type ──────────────▶ EnableLibraryPlugin ──────▶ AssignLibraryPlugin
    (commonjs/commonjs2等)      (プレフィックス決定)          (プラグイン適用)

library.name ──────────────▶ parseOptions() ────────────▶ AssignLibraryPluginParsed
library.export ────────────▶

ソースコード ──────────────▶ renderStartup() ───────────▶ exports/module.exports代入付きソース
                               (エクスポートコード生成)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| AssignLibraryPlugin.js | `lib/library/AssignLibraryPlugin.js` | ソース | CommonJS出力の実装（変数代入型ライブラリ出力の汎用実装） |
| AbstractLibraryPlugin.js | `lib/library/AbstractLibraryPlugin.js` | ソース | ライブラリプラグインの基底クラス |
| EnableLibraryPlugin.js | `lib/library/EnableLibraryPlugin.js` | ソース | タイプに応じたAssignLibraryPluginの構成・適用 |
| ExportPropertyLibraryPlugin.js | `lib/library/ExportPropertyLibraryPlugin.js` | ソース | 特定エクスポートの抽出 |
