CC 4.0 ライセンス

このセクションの内容は、以下のリンクの内容を基にしており、CC BY 4.0 ライセンスの対象となります。

特に明記されていない限り、以下の内容は、元の内容に基づいて修正および削除が行われた結果であるとみなすことができます。

統計情報

モジュールの依存関係を分析し、コンパイル速度を最適化するために使用できるパッケージ情報を生成します。

統計情報のJSONファイルの出力
  • @rspack/cli を使用して、rspack build --json stats.json を実行します。
  • RspackのJavaScript API を使用して、stats.toJson(options)stats.toString(options) を実行します。
  • 型: boolean | string | Object
  • デフォルト:{"preset":"errors-warnings","timings":true}

統計情報のプリセット

プリセット 説明
'normal' (true) stats オプションのデフォルト値による出力
'none' (false) 何も出力しない
'verbose' すべてを出力する
'errors-only' エラー関連の情報のみを出力する
'errors-warnings' エラーと警告関連の情報のみを出力する
'minimal' エラーまたは新しいコンパイルが発生した場合のみ出力する
'detailed' chunkModuleschunkRootModules を除くすべてを出力する
'summary' サマリー情報のみを出力する

出力するパッケージ情報を正確に指定できます。以下のすべてのフィールドはオプションです。

プリセットオプション

stats.all

  • 型: boolean
  • デフォルト:undefined

オプションが定義されていない場合のstatsオプションのフォールバック値です。ローカルのRspackデフォルトよりも優先されます。

警告

stats.all を有効にすると、RustとJavaScript間の大量のデータ転送が発生し、統計情報の生成にかかる時間が大幅に増加します。ご注意ください。

stats.preset

  • 型: boolean | string
  • デフォルト:undefined

表示される情報のタイプに関するプリセットを設定します。統計情報の動作を拡張するのに役立ちます。

アセットオプション

stats.assets

  • 型: boolean
  • デフォルト:true

アセット情報を表示するかどうか。詳細については、アセットオブジェクトを参照してください。

stats.assetsSort

  • 型: string
  • デフォルト:"id"

指定されたフィールドでアセットをソートします。すべてのソートフィールド を使用できます。値の前に `!` を付けることで、指定されたフィールドのソート順を逆順にすることができます。

stats.assetsSpace

  • 型: number
  • デフォルト:15

表示するアセットのアイテム数(このスペースに収まるようにグループは折りたたまれます)。

stats.relatedAssets

  • 型: boolean
  • デフォルト:false

他のアセットに関連するアセット(アセットのSourceMapなど)に関する情報を表示するかどうか。

stats.excludeAssets

  • 型: Array<string | RegExp | (name: string) => boolean> | string | RegExp | (name: string) => boolean | false
  • デフォルト:false

一致するアセット情報を除外します。これは、文字列、RegExp、アセット名を引数として受け取りブール値を返す関数を使用して行うことができます。stats.excludeAssets は上記のいずれかの配列にすることができます。

stats.cachedAssets

  • 型: boolean
  • デフォルト:true

キャッシュされたアセットに関する情報を表示するかどうか。stats.cachedAssetsfalse に設定すると、ビルドされたファイルではなく、出力されたファイルのみが表示されます。

アセットグループ化オプション

stats.groupAssetsByChunk

  • 型: boolean

チャンクとの関連性に基づいてアセットをグループ化するかどうか。

stats.groupAssetsByEmitStatus

  • 型: boolean

ステータス(出力済み、出力比較済み、またはキャッシュ済み)別にアセットをグループ化するかどうか。

stats.groupAssetsByExtension

  • 型: boolean

拡張子別にアセットをグループ化するかどうか。

stats.groupAssetsByInfo

  • 型: boolean

アセット情報(不変、開発、hotModuleReplacementなど)別にアセットをグループ化するかどうか。

stats.groupAssetsByPath

  • 型: boolean

アセットパス別にアセットをグループ化するかどうか。

チャンクオプション

stats.chunks

  • 型: boolean
  • デフォルト:true

チャンクに関する情報を表示するかどうか。詳細はチャンクオブジェクトを参照してください。

stats.chunkModules

  • 型: boolean
  • デフォルト:true

ビルドされたモジュールに関する情報をチャンクの情報に表示するかどうか。

stats.chunkModulesSpace

  • 型: number
  • デフォルト:10

表示するチャンクモジュールのアイテム数(このスペースに収まるようにグループは折りたたまれます)。

stats.dependentModules

  • 型: boolean
  • デフォルト:false

チャンクの他のモジュールの依存関係であるチャンクモジュールを表示するかどうか。

stats.chunkOrigins

  • 型: boolean
  • デフォルト:true

チャンクの起源とチャンクのマージに関する情報を表示するかどうか。

stats.chunkRelations

  • 型: boolean
  • デフォルト:false

チャンクの親、子、兄弟を表示するかどうか。

stats.chunksSort

  • 型: string
  • デフォルト:"id"

指定されたフィールドでチャンクをソートします。すべてのソートフィールド を使用できます。値の前に `!` を付けることで、指定されたフィールドのソート順を逆順にすることができます。

stats.ids

  • 型: boolean
  • デフォルト:false

モジュールとチャンクのIDを表示するかどうか。

チャンクグループオプション

stats.chunkGroups

  • 型: boolean
  • デフォルト:true

namedChunkGroupsに関する情報を表示するかどうか。詳細はチャンクグループオブジェクトを参照してください。

stats.chunkGroupAuxiliary

  • 型: boolean
  • デフォルト:true

チャンクグループ内の補助アセットを表示するかどうか。

stats.chunkGroupChildren

  • 型: boolean
  • デフォルト:true

チャンクグループの子(例:プリフェッチされたチャンクとアセット、プリロードされたチャンクとアセット)を表示するかどうか。

stats.chunkGroupMaxAssets

  • 型: number
  • デフォルト:5

チャンクグループに表示するアセットの数。

stats.entrypoints

  • 型: boolean | 'auto'
  • デフォルト:false

対応するバンドルを含むエントリポイントを表示するかどうか。詳細はエントリポイントオブジェクトを参照してください。

stats.entrypoints'auto'に設定されている場合、Rspackはstats出力にエントリポイントを表示するかどうかを自動的に決定します。

モジュールオプション

stats.modules

  • 型: boolean
  • デフォルト:true

ビルドされたモジュールに関する情報を表示するかどうか。詳細はモジュールオブジェクトを参照してください。

stats.moduleTrace

  • 型: boolean
  • デフォルト:true

依存関係と警告/エラーの発生源を表示するかどうか。

stats.moduleAssets

  • 型: boolean
  • デフォルト:true

モジュール内のアセットに関する情報を追加するかどうか。

stats.modulesSpace

  • 型: number
  • デフォルト:15

表示するモジュールのアイテム数(このスペースに収まるようにグループは折りたたまれます)。

stats.modulesSort

  • 型: string
  • デフォルト:"id"

指定されたフィールドでモジュールをソートします。すべてのソートフィールド を使用できます。値の前に `!` を付けることで、指定されたフィールドのソート順を逆順にすることができます。

stats.reasons

  • 型: boolean
  • デフォルト:true

モジュールが含まれる理由に関する情報を表示するかどうか。

stats.reasonsSpace

  • 型: number
  • デフォルト:1000

表示する理由の文字数(このスペースに収まるようにグループは折りたたまれます)。

stats.source

  • 型: boolean
  • デフォルト:false

モジュールのソースコードを表示するかどうか。

stats.depth

  • 型: boolean
  • デフォルト:false

各モジュールのエントリポイントからの距離を表示するかどうか。

stats.orphanModules

  • 型: boolean
  • デフォルト:false

孤立したモジュールを表示するかどうか。

モジュールは、どのチャンクにも含まれていない場合、孤立しています。

stats.runtimeModules

  • 型: boolean
  • デフォルト:true

ランタイムモジュールに関する情報を表示するかどうか。

ランタイムモジュールはRspackの組み込みモジュールであり、様々なランタイム機能を提供するために使用されます。

stats.cachedModules

  • 型: boolean
  • デフォルト:true

キャッシュされた(ビルドされていない)モジュールに関する情報を表示するかどうか。

stats.excludeModules

  • 型: Array<string | RegExp | (name: string) => boolean> | string | RegExp | (name: string) => boolean | false
  • デフォルト:false

一致するモジュール情報を除外します。これは、文字列、RegExp、モジュール名を引数として受け取りブール値を返す関数を使用して行うことができます。stats.excludeAssets は上記のいずれかの配列にすることができます。

stats.nestedModules

  • 型: boolean
  • デフォルト:true

他のモジュールにネストされたモジュール(モジュール連結など)に関する情報を表示するかどうか。

stats.nestedModulesSpace

  • 型: number
  • デフォルト:10

表示するネストされたモジュールのアイテム数(このスペースに収まるようにグループは折りたたまれます)。

モジュールグループ化オプション

stats.groupModulesByAttributes

  • 型: boolean

属性(エラー、警告、アセット、オプション、孤立、または依存)別にモジュールをグループ化するかどうか。

stats.groupModulesByCacheStatus

  • 型: boolean

キャッシュステータス(キャッシュ済み、またはビルド済みでキャッシュ可能)別にモジュールをグループ化するかどうか。

stats.groupModulesByExtension

  • 型: boolean

拡張子別にモジュールをグループ化するかどうか。

stats.groupModulesByPath

  • 型: boolean

パス別にモジュールをグループ化するかどうか。

stats.groupModulesByType

  • 型: boolean

型別にモジュールをグループ化するかどうか。

stats.groupReasonsByOrigin

  • 型: boolean

大量の理由を避けるために、理由を元のモジュール別にグループ化します。

最適化オプション

stats.providedExports

  • 型: boolean
  • デフォルト:false

モジュールのエクスポートを表示するかどうか。

stats.usedExports

  • 型: boolean
  • デフォルト:false

モジュールのどのエクスポートが使用されているかを表示するかどうか。

stats.optimizationBailout

  • 型: boolean
  • デフォルト:false

モジュールの最適化が失敗した理由を表示するかどうか。

エラー/警告オプション

stats.errors

  • 型: boolean
  • デフォルト:true

エラーを表示するかどうか。

stats.errorsCount

  • 型: boolean
  • デフォルト:true

エラー数を表示するかどうか。

stats.errorDetails

  • 型: boolean
  • デフォルト:false

エラーの詳細を表示するかどうか。デフォルトは'auto'で、エラーが2つ以下の場合にのみエラーの詳細が表示されます。

stats.errorsSpace

  • 型: number
  • デフォルト:5

エラーを表示する行数。

stats.errorStack

  • 型: boolean
  • デフォルト:true

エラーのスタックトレースを表示するかどうか。

stats.warnings

  • 型: boolean
  • デフォルト:true

警告を表示するかどうか。

stats.warningsCount

  • 型: boolean
  • デフォルト:true

警告の数を表示するかどうか。

stats.warningsSpace

  • 型: number
  • デフォルト:5

警告を何行表示するか。

ログ出力オプション

stats.logging

  • タイプ: 'info' | 'none' | 'error' | 'warn' | 'log' | 'verbose' | boolean

ログ出力を追加するかどうか。

  • 'none'false: ログ出力を無効化します。
  • 'error': エラーのみ。
  • 'warn': エラーと警告のみ。
  • 'info': エラー、警告、情報メッセージ。
  • 'log'true: エラー、警告、情報メッセージ、ログメッセージ、グループ、クリア。折りたたまれたグループは折りたたまれた状態で表示されます。
  • 'verbose': デバッグとトレースを除くすべてのログ。折りたたまれたグループは展開された状態で表示されます。

stats.loggingDebug

  • タイプ: Array<string | RegExp | function (name) => boolean>

プラグインやローダーなどの指定されたロガーのデバッグ情報を表示するかどうか。stats.loggingfalseに設定されている場合、stats.loggingDebugオプションは無視されます。

rspack.config.js
module.exports = {
  //...
  stats: {
    loggingDebug: [
      'MyPlugin',
      /rspack/, // To get core logging
    ],
  },
};

stats.loggingTrace

  • 型: boolean
  • デフォルト:true

エラー、警告、トレースのログ出力にスタックトレースを表示するかどうか。

stats.colors

  • 型: boolean
  • デフォルト:false

異なる色で出力するかどうか。

カラー出力をサポートする環境でrspack buildを実行する場合、デフォルトでtrueになります。

コンパイルオプション

stats.hash

  • 型: boolean
  • デフォルト:true

コンパイルのハッシュに関する情報を表示するかどうか。

stats.env

  • 型: boolean
  • デフォルト:false

--env情報を表示するかどうか。

stats.builtAt

  • 型: boolean
  • デフォルト:true

ビルド日時情報を表示するかどうか。

stats.version

  • 型: boolean
  • デフォルト:true

使用されたRspackのバージョンに関する情報を追加するかどうか。

stats.context

  • 型: string

ベースディレクトリ(リクエスト情報の短縮化のための絶対パス)を表示するかどうか。

stats.publicPath

  • 型: boolean
  • デフォルト:true

publicPathを表示するかどうか。

stats.outputPath

  • 型: boolean
  • デフォルト:true

output.pathを表示するかどうか。

stats.children

  • 型: boolean
  • デフォルト:true

output.pathを表示するかどうか。

stats.performance

  • 型: boolean
  • デフォルト:true

ファイルサイズがperformance.maxAssetSizeを超えた場合に、パフォーマンスに関するヒントを表示するかどうか。

stats.timings

  • 型: boolean
  • デフォルト:true

タイミング情報を表示するかどうか。

ソートフィールド

assetsSortchunksSortmodulesSortでは、アイテムをソートできる複数のフィールドがあります。

  • 'id': アイテムのID。(アイテムはアセット、モジュール、またはチャンクです。)
  • 'name': インポート時に割り当てられたアイテムの名前。
  • 'size': アイテムのサイズ(バイト単位)。
  • 'chunks': アイテムの由来となるチャンク。(例:1つのチャンクに複数のサブチャンクがある場合、サブチャンクはメインチャンクに従ってグループ化されます。)
  • 'errors': アイテム内のエラーの数。
  • 'warnings': アイテム内の警告の数。
  • 'failed': アイテムのコンパイルが失敗したかどうか。
  • 'cacheable': アイテムがキャッシュ可能かどうか。
  • 'built': アイテムがビルド済みかどうか。
  • 'prefetched': アイテムがプリフェッチされるかどうか。
  • 'optional': アイテムがオプションかどうか。
  • 'identifier': アイテムの識別子。
  • 'index': アイテムの処理インデックス。
  • 'profile': アイテムの処理コスト。
  • 'issuer': 発行元の識別子。
  • 'issuerId': 発行元のID。
  • 'issuerName': 発行元の名前。
  • 'issuerPath': 発行元のフルパス。

stats動作の拡張

プリセットの出力動作を使用したいが、個々のフィールドの出力を増減したい場合は、プリセットまたはallを指定した後に、フィールドの出力動作をカスタマイズできます。

例えば、エラーとそのモジュールが導入された理由のみを出力します。

module.exports = {
  // ...
  stats: {
    preset: 'errors-only',
    reasons: true,
  },
};
このページについて