エラーと生成ファイル

ソースのエラーが、すでに存在する *.spring.dart ファイルを削除したり変更したりすることはありません。ジェネレーターは既存の内容を変更せずに再び書き出し、エラーを報告します。

使う理由

build_runner は、ビルドステップが書き出さなかった出力を削除します。何の配慮もなければ、build_runner watch の下で入力中の構文エラーのたびに生成ファイルが削除され、それをインポートするすべてのファイルが赤くなり、次のキー入力で再生成されることになります。エディターは何百ものエラーとゼロの間をちらつくでしょう。

そこでジェネレーターは、ソースが再び正しくなるまで最後の正常なファイルを残します。エディターには、編集中のファイルにある本当のエラーが一つだけ表示されます。

ケースごとの動き

状況 生成ファイル ビルド 表示されるもの
スキャンされるライブラリに構文エラーがあり、生成ファイルが存在する 変更せずに再び書き出される 成功する 次の生成が成功するまで、出力ごとに一つの警告
ジェネレーターがエラーを報告し (チェックの失敗。ビルド時のチェック を参照)、生成ファイルが存在する 変更せずに再び書き出される 失敗する ... is kept unchanged until this error is fixed: で始まるエラー
どちらかのエラーがあり、生成ファイルがまだ存在しない (コールドビルド) なし 失敗する エラー
ソースが再び正しくなった 生成される 成功する 警告が止まる。後で構文エラーがあれば再び警告する

構文エラー

ライブラリに構文エラーがある間 (入力の途中)、ビルダーは生成をスキップし、出力ごとに一つの警告をログに出します。

lib/spring_gen/src/beans.spring.dart is kept unchanged until the sources parse
again; lib/src/service.dart has syntax errors:
...

警告は一度だけログに出ます。ファイルが壊れたままのその後のビルドでは何も出ません。次の生成が成功した後、新しい構文エラーがあれば再び警告します。

ジェネレーターのエラー

チェックの失敗や、エラーのあるライブラリの要素モデルでのクラッシュでも、ファイルは残ります。エラーはビルドエラーとして報告されるので build_runner build は失敗しますが、ファイルは残り、それをインポートするコードはコンパイルできたままです。

lib/spring_gen/src/beans.spring.dart is kept unchanged until this error is
fixed:
Bean class _Greeter must be public: the generated module cannot reference a
private class of package:app/src/greeter.dart. Make it public, or move it out
of the scanned directory.

コールドビルド

既存の出力がなければ残すものはありません。構文エラーやジェネレーターのエラーはビルドを失敗させ、ファイルは書き出されません。

残される内容の出どころ

  1. watch の下では、ビルダーはこのプロセスで出力ごとに最後に生成した内容を覚えていて、それを使います。
  2. 新たに起動した後は、ディスクからファイルを読みます。出力はソースにビルドされるので、ファイルは出力のパッケージのディレクトリのそのパスにあります。

ワークスペースのビルド

build_runner build --workspace は、一つの作業ディレクトリから pub ワークスペースのすべてのパッケージをビルドします。残すファイルは常に ビルド中のパッケージ のディレクトリから読まれます。そのディレクトリはワークスペースの .dart_tool/package_config.json を通して見つけられ、作業ディレクトリから読まれることはありません。そうしないと、別のパッケージの同じパスのファイルが、このパッケージの出力として書き出されてしまう可能性があります。

ビルドされるパッケージにそのようなファイルがなければ、残すものはなく、ビルドはコールドビルドと同じく失敗します。ビルドがチェックする Flutter のアセット (@Value('asset:...')) にも同じ検索が使われます。アセットは別のパッケージのディレクトリではなく、ビルドされるパッケージのディレクトリで探されます。

テスト: spring_test ビルダー

テストのビルダーも出力を残します。@SpringBootTest や @DataTest クラスを持つテストファイルが解析できない間、その test/spring_gen/<name>.test.spring.dart は、テストパッケージのディレクトリから読まれて (ワークスペースのビルドでも) そのまま再び書き出され、警告がそれを伝えます。

test/checkout_test.dart has syntax errors; test/spring_gen/checkout.test.spring.dart
is kept as it is until it parses again:
...

そのため、編集中もテストの生成ファイルのインポートは動き続けます。生成ファイルがまだなければ、警告がログに出て何も書き出されません。テスト: @SpringBootTest と @DataTest を参照してください。

関連項目