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.12
  build_test: ^2.2.2

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

1回限りのビルドを実行します。

serve

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

test

テストを実行します。

watch

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

Web固有のコードを操作している場合は、webdevページを参照してください。

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

• build_runnerを使用する必要があるパッケージのドキュメント。これらのパッケージには通常、build または build_runner の依存関係があります。
• Build_runnerのドキュメント
  • build_runnerの使い始め
  • Build FAQ

特に明記されていない限り、このサイトのドキュメントは Dart 3.5.3 を反映しています。ページの最終更新日は2024-09-16です。 ソースを表示または問題を報告。