Skip to content

Upgrading source_gen 0.4 to 0.5

Breaking0.4.8 → 0.5.10+1Breaking3Platform1Deprecated1New7Changed15Fixed10Other5

Full comparisonBack to source_gen
BreakingUpgrade verdict

3 breaking changes and a platform requirement change.

In plain terms
  • Generators now run through a new build system, so the old top-level build and generate functions are gone.
  • This release updates the package so it works with a newer version of the analyzer library, which changed in ways that are not backward compatible.
  • Generator methods now receive an extra argument for reading and writing files.
  • You need Dart 1.22.1 or newer to use this version.
Must act 5 items need code or config changes

Dart SDK requirement changed in 0.5.9: >=1.12.0 <2.0.0 → >=1.22.1 <2.0.0.

What you must change

Breaking3
Switches to the build package for running Generators, removing the top level build and generate functions.
buildgeneratewatchserveGeneratorBuilder
0.5.0CHANGELOG.mdSummarizedView source
Upgrades source_gen to be compatible with the breaking changes in analyzer 0.28.0.
0.5.1+3CHANGELOG.mdSummarizedView source
Passes a BuildStep as a second argument to Generator#generate and GeneratorForAnnotation#generateForAnnotatedElement.
BuildStepGenerator#generateGeneratorForAnnotation#generateForAnnotatedElement
0.5.0CHANGELOG.mdSummarizedView source
Platform1
Raises the minimum Dart SDK requirement to 1.22.1.
0.5.9GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated1
Deprecates builder.dart in favor of importing source_gen.dart.
builder.dartsource_gen.dart
0.5.9GitHub ReleaseSummarizedView source