build_runner

build_runner パッケージは、生成されたファイルのテストや、ソースファイルと生成されたファイルの双方をサーブするなど、ファイルの生成を汎用的に行うコマンドを提供します。このページでは build_runner の使用方法を説明します。特定のパッケージで build_runner を使用する方法については、そのパッケージのドキュメントを参照してください。

build_runner コマンドは、*ビルダー* — 入力ファイルから出力ファイルを生成するために Dart ビルドシステム を使用するパッケージ — で動作します。たとえば、json_serializable および built_value_generator パッケージは、Dart コードを生成するビルダーを定義しています。

Dart ビルドシステムは、リフレクション（パフォーマンスの問題があります）やマクロ（Dart のコンパイラはサポートしていません）の良い代替手段ですが、Dart コードの読み書き以上のことができます。たとえば、sass_builder パッケージは、.scss および .sass ファイルから .css ファイルを生成するビルダーを実装しています。

build_runner を使用するには、アプリの pubspec に build_runner の 開発依存関係 を追加します。

dev_dependencies:
  # ···
  build_runner: ^2.4.15
  build_test: ^2.2.3

build_test への依存はオプションです。コードをテストする場合は追加してください。

通常通り、pubspec.yaml の変更後は、dart pub get または dart pub upgrade を実行してください。

dart pub get

以下は、build_runner の **build** コマンドを使用した例です。

# From a directory that contains a pubspec.yaml file:
dart run build_runner build

build_runner パッケージには、以下のコマンドが含まれています。

build

一度だけビルドを実行します。

serve

開発サーバーを起動します。このコマンドを直接使用する代わりに、便利なデフォルト動作を備えた webdev serve を使用できます。

test

テスト を実行します。

watch

入力ファイルの編集を監視するビルドサーバーを起動します。変更に応答して、増分リビルドを実行します。

Web 固有のコードに取り組んでいる場合は、webdev ページ を参照してください。

build_runner の使用方法の詳細については、以下を参照してください。

• build_runner の使用を必要とするパッケージのドキュメント。これらのパッケージは、一般的に build または build_runner への依存関係を持っています。
• build_runner のドキュメント
  • build_runner のはじめに
  • Build FAQ