# 帳票設計書 24-Stats errors-only プリセット

## 概要

本ドキュメントは、webpackのビルド統計情報のうちエラー情報のみを出力する「errors-only」プリセットの設計仕様を定義する。DefaultStatsPresetPlugin.jsにおけるNAMED_PRESETS["errors-only"]の定義に基づく。

### 本帳票の処理概要

errors-onlyプリセットは、ビルドエラーに関する情報のみを出力するプリセットである。`all: false`で全項目を無効化した上で、errors、errorsCount、moduleTraceのみを有効化する。エラースペース制限はInfinityに設定されており、全てのエラーが省略なく表示される。

**業務上の目的・背景**：ビルドの成功/失敗判定において、エラー情報のみに集中したい場合に使用される。CI/CDパイプラインでビルドエラーを検出し、エラーの詳細情報を迅速に把握するために設計されている。警告やその他の統計情報はノイズとなるため、エラーのみに焦点を絞ることで問題解決の効率を向上させる。

**帳票の利用シーン**：CI/CDパイプラインでのビルドエラー検出、自動テストでのビルドエラー確認、ビルドスクリプトでのエラーチェック、プルリクエスト検証時のエラー確認。

**主要な出力内容**：
1. エラー情報（全てのビルドエラーの完全な詳細）
2. エラー件数
3. モジュールトレース（エラーの原因となったモジュールの依存パス）
4. エラーレベルのロギング情報

**帳票の出力タイミング**：webpack設定の`stats`オプションに`"errors-only"`を指定した場合、またはStats.toString("errors-only")・Stats.toJson("errors-only")を呼び出した場合に出力される。

**帳票の利用者**：CI/CDエンジニア、フロントエンド開発者（ビルドエラー調査時）

## 帳票種別

統計レポート（プリセット設定）

## 利用画面

| 画面No | 画面名 | URL/ルーティング | 出力操作 |
|--------|--------|-----------------|---------|
| - | CLI | webpack --stats errors-only | コマンドライン引数指定 |
| - | webpack設定ファイル | webpack.config.js | stats: "errors-only" 設定 |
| - | Node.js API | - | Stats.toString("errors-only") / Stats.toJson("errors-only") |

## 出力形式

### 基本仕様

| 項目 | 内容 |
|-----|------|
| ファイル形式 | テキスト（toString）/ JSON（toJson） |
| 用紙サイズ | 該当なし（コンソール/ファイル出力） |
| 向き | 該当なし |
| ファイル名 | 標準出力またはユーザー指定 |
| 出力方法 | コンソール出力 / プログラマティック取得 |
| 文字コード | UTF-8 |

## 帳票レイアウト

### レイアウト概要

errors-onlyプリセットはエラー情報のみを出力する。ビルドが成功した場合は出力が空になる。

```
┌─────────────────────────────────────┐
│     エラー一覧（制限なし）            │
│   (moduleTrace含む)                 │
├─────────────────────────────────────┤
│     エラー件数                       │
└─────────────────────────────────────┘
```

### ヘッダー部

該当なし（エラー情報のみ出力）

### 明細部

| No | 項目名 | 説明 | データ取得元 | 表示形式 | 列幅 |
|----|-------|------|-------------|---------|-----|
| 1 | errors | エラー一覧（制限なし） | compilation.errors | 構造化データ | - |
| 2 | errorsCount | エラー件数 | compilation.errors.length | 数値 | - |
| 3 | moduleTrace | モジュールトレース | ModuleGraph | 構造化データ | - |

### フッター部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | errorsCount | エラー総数 | compilation.errors.length | 数値 |

## 出力条件

### 抽出条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| statsオプション指定 | stats: "errors-only" の指定 | Yes |

### ソート順

| 優先度 | 項目 | 昇順/降順 |
|-------|------|---------|
| - | - | エラーは発生順 |

### 改ページ条件

該当なし。errorsSpace: Infinityのため全エラーが表示される。

## データベース参照仕様

### 参照テーブル一覧

本帳票はデータベースを参照しない。

| テーブル名 | 用途 | 結合条件 |
|-----------|------|---------|
| Compilation | エラー情報 | - |
| ModuleGraph | モジュールトレース | compilation.moduleGraph |

## 計算仕様

### 計算項目一覧

| 項目名 | 計算式 | 端数処理 | 備考 |
|-------|-------|---------|------|
| errorsCount | compilation.errors.length | なし | 整数 |

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[Stats.toString/toJson呼出] --> B[createStatsOptions]
    B --> C{statsPresetフック}
    C -->|errors-only| D[NAMED_PRESETS.errors-only適用]
    D --> E[all:false で全項目無効化]
    E --> F[errors/errorsCount/moduleTraceのみ有効化]
    F --> G[StatsFactory.create]
    G --> H{エラーあり?}
    H -->|Yes| I[エラー詳細出力]
    H -->|No| J[空出力]
```

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| ビルドエラーなし | エラーが0件の場合 | （空出力） | 正常動作 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | エラー件数に依存（通常は少数） |
| 目標出力時間 | 極めて高速（エラーデータのみ処理） |
| 同時出力数上限 | 1（ビルドごとに1回） |

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

エラーメッセージにファイルパスやモジュール名が含まれる場合があるが、出力範囲がエラーに限定されているため情報漏洩リスクは低い。

## 備考

- `all: false`により全項目が無効化された上で、errors、errorsCount、moduleTraceのみが有効化される
- `errorsSpace: Infinity`によりエラーの件数制限がない
- `logging: "error"`によりerrorレベルのログのみ出力される
- moduleTrace: trueにより、エラーの原因となったモジュールの依存チェーンが表示される
- 警告情報は一切出力されない（warnings未設定、all: falseにより無効）

---

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

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

### 推奨読解順序

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

errors-onlyプリセットの設定構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | DefaultStatsPresetPlugin.js | `lib/stats/DefaultStatsPresetPlugin.js` | 行117-124: NAMED_PRESETS["errors-only"]の全プロパティ定義（5項目のみ） |

**読解のコツ**: errors-onlyプリセットは最もシンプルなプリセットの一つ。`all: false`で全無効化し、エラー関連の3項目のみを有効化する極めて限定的な設定。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Stats.js | `lib/Stats.js` | 行57-86: toJson()/toString()メソッド |

#### Step 3: all: falseの効果とerror関連項目の抽出を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | DefaultStatsPresetPlugin.js | `lib/stats/DefaultStatsPresetPlugin.js` | 行262-264: DEFAULTSのerrors/errorsCount設定（NORMAL_ON） |
| 3-2 | DefaultStatsPresetPlugin.js | `lib/stats/DefaultStatsPresetPlugin.js` | 行262: moduleTrace設定（NORMAL_ON） |

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

```
Stats.toString("errors-only") / Stats.toJson("errors-only")
    |
    +-- Compilation.createStatsOptions("errors-only", context)
    |       |
    |       +-- statsPreset.for("errors-only").call(options)
    |       |       |
    |       |       +-- applyDefaults(options, {all:false, errors:true, ...})
    |       |
    |       +-- statsNormalize.call(options, context)
    |               |
    |               +-- DEFAULTS: all=false により大部分が無効化
    |
    +-- StatsFactory.create("compilation", compilation, context)
    |       |
    |       +-- エラー情報のextractのみ実行
    |
    +-- [toStringの場合] StatsPrinter.print("compilation", data)
```

### データフロー図

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

webpack.config.js          DefaultStatsPresetPlugin            コンソール
  stats: "errors-only" ---> all: false                  ---> エラー詳細のみ
                               |                              または空出力
                          errors/errorsCount/
                          moduleTrace のみ有効化
                               |
Compilation              StatsFactory.create()
  .errors           --->   エラー情報抽出           ---> エラーメッセージ
  .moduleGraph              moduleTrace抽出              モジュールトレース
                                                         エラー件数
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| DefaultStatsPresetPlugin.js | `lib/stats/DefaultStatsPresetPlugin.js` | ソース | プリセット定義（行117-124） |
| Stats.js | `lib/Stats.js` | ソース | Stats API のエントリーポイント |
| StatsFactory.js | `lib/stats/StatsFactory.js` | ソース | 統計データの抽出エンジン |
| StatsPrinter.js | `lib/stats/StatsPrinter.js` | ソース | 統計データのテキスト整形エンジン |
| DefaultStatsFactoryPlugin.js | `lib/stats/DefaultStatsFactoryPlugin.js` | ソース | エラーextractフック実装 |
