flutter_gen_runner

Development

• Fix package root resolution after build_runner 2.14.0 AOT changes. by @Carapacik

Feature

• Add build_runner --workspace support for flutter_gen_runner using a manifest + post-process materialization pipeline.
• Add fluttergen --workspace support to the command package, including package-local build.yaml overrides for each workspace member.

Development

• Document and align the minimum supported versions for the new build pipeline: Dart >=3.7.0 and build_runner >=2.12.0.
• Document the current build_runner --workspace rebuild limitation for manually deleted generated files and recommend build_runner clean before rebuilding.

Development

• #727 Allow rive 0.14.0. by @AlexV525

Development

• Fixes version conflict between packages.

Development

• #707 Allow build 4.0.0. by @BetterB0y

Feature

• #576 Add support for deferred components. by @ianmaciel
• #676 Add new option parse_animation to parse metadata for animated images. by @HuanDu
• #680 Add svg ColorMapper to svg loader. by @sysint64
• #685 Use .vec SVG class for vector_graphics_compiler transformed assets. by @Albert221
• #697 Refactor how generated files are being formatted. by @AlexV525

Development

• #681 Bump dart_style v3 which also requires Dart 3.4. by @AlexV525
• #682 Add Facts generate utils. by @AlexV525
• #694 Use fine-grained logger instead of stdout.writeln. by @AlexV525
• #698 Improve workflow with automatic formatting. by @AlexV525
• #699 Allow build 3.0.0. by @davidmorgan

Feature

• #659 Add support Telegram Sticker .tgs in Lottie Integration. by @dungngminh

Bug fix

• #653 Constraints dart_style to >=2.3.7. by @AlexV525
• #656 Add missing parameters in Lottie integration from lottie 3.0.0. by @dungngminh
• #658 Update required dart version. by @koji-1009

Feature

• #587 Support Lottie ZIP archive files. by @AlexV525
• #599 Use FilterQuality.medium for the image integration. by @AlexV525
• #615 Support dart_style v3. by @AlexV525
• #618 Remove Flare integration. by @AlexV525
• #619 Generate package path for directory. by @AlexV525
• #620 Format Dart files with the current Dart version instead of the latest supported. by @AlexV525
• #621 Adds .lottie support. by @AlexV525
• #635 Support archive v4. by @AlexV525
• #645 Allows not enable the image integration. by @AlexV525

Development

• #593 Better stdouts. by @AlexV525
• #622 Fix invalid codecov config. by @AlexV525
• #630 Update proper EOF. by @AlexV525
• #643 Improvements with code lints. by @AlexV525
• #644 Format code. by @AlexV525

Bug fix

• #592 Accept both flutter_gen and flutter_gen_runner as the entry of build.yaml. by @b2nkuu

Feature

• #555 Support build.yaml to configure. by @b2nkuu
• #567 Generate the package constant for generated font classes. by @TesteurManiak
• #569 Enables gaplessPlayback by default for image assets. by @AlexV525
• #580 Allows mime: '>=1.0.0 <3.0.0'. by @AlexV525

Development

• #563 Fix concurrency execution with melos. by @wasabeef

Feature

• #548 Add Import abstraction for package imports alias. by @AlexV525

Development

• New releases asdf-fluttergen and setup-fluttergen. by @ronnnnn

Bug fix

• #530 Fix the Flavored assets. by @AlexV525
• #532 Provide the theme to SvgAssetLoader instead of SvgPicture. by @Kirpal

Feature

• #471 Handles root directory assets. by @AlexV525
• #472 Add directory_path_enabled to output the path of assets directory classes. by @AlexV525
• #487 Add support for 'useArtboardSize' argument in rive integration. by @devilbuddy
• #493 Add support for vector graphics (vec files) in SvgGenImage. by @raldhafiri

Bug fix

• #485 Remove default SvgTheme argument preventing DefaultSvgTheme works correctly. by @mym0404

Development

• Update to Dart 3.3.4.
• Update to Flutter 3.19.6.

Feature

• #435 Allowed the generated values statement to optionally be static. @bramp

Bug fix

• #432 Refactored the AssetGenImage code to be another Integration. @bramp

Development

• #438 Fix module configurations.
• Update to Dart 3.2.0.
• Update to Flutter 3.16.0.

Bug fix

• #409 Update dependencies.
  • Update Dart SDK to >=2.17.0 <4.0.0.

Development

• Update to Dart 3.1.2.
• Update to Flutter 3.13.5.

Team

• Welcome @AlexV525 🎉

Bug fix

• #383 Fix the wrong path for unknown mime types when packageParameterEnabled is enabled. @blaugold

Feature

• #361 Add package parameter to generated asset provider method. @orevial

Bug fix

• #396 Fix flutter_svg >=2.0.4 requires a non-null clipBehavior field. @jetpeter @hasanmhallak

Development

• #380 Migrate to melos v3. @blaugold @jfacoustic
• Update Dart SDK to >=2.17.0 <3.0.0.

Feature

• #350 [BREAKING CHANGES] Upgrade for support of flutter_svg 2.0.0.

Feature

• #322 #327 [BREAKING CHANGES] Add keyName to integrations and exchange the path value.

Bug fix

• #322 Fix wrong package asset path with svg, lottie, flare and rive integrations.
• #323 Fix generate failed when only list in a JSON files.

Bug fix

• #308 #309 Fix missing add to the lottie#controller.

Bug fix

• #300 Fix package_parameter_enabled being ignored for Flare, Rive and Lottie.
• #303 Add ignore_for_file: implicit_dynamic_list_literal to generated files.

Development

• #306 Update required analyzer: '>=4.7.0 <6.0.0'

Feature

• #285 #298 Add Lottie files integration.

  // Assets.lottie.hamburgerArrow.lottie()
  SizedBox(
    width: 200,
    height: 200,
    child: Assets.lottie.hamburgerArrow.lottie(
      fit: BoxFit.contain,
    ),
  ),
  

• #286 Allow users to change generated class name for assets, fonts, and colors.

  flutter_gen:
    assets:
      # Optional
      outputs:
        class_name: MyAssets # Default is `Assets`
  
    fonts:
      # Optional
      outputs:
        class_name: MyFontFamily # Default is `FontFamily`
  
    colors:
      # Optional
      outputs:
        class_name: MyColorName # Default is `ColorName`
  

• #291 Add values list to generated classes for each directory.

  Assets.images.values // <List<AssetGenImage>>[chip1, chip2, logo, profileJpg, profilePng];
  

• #292 Support an ImageProvider.

  // Assets.images.chip.provider()
  Container(
    height: 400,
    decoration: BoxDecoration(
      image: DecorationImage(
        image: Assets.images.chip.provider(),
      ),
    ),
    child: const Center(child: Text('Deco')),
  ),
  
  

• #294 [BREAKING CHANGES] Moved the style and package_parameter_enabled to under assets.outputs scope.

  
  # ❌ Before
  flutter_gen:
    # ...
    assets:
      package_parameter_enabled: true
      style: snake-case
      outputs:
        class_name: MyAssets
  
  # ⭕️ After
  flutter_gen:
    # ...
    assets:
      outputs:
        class_name: MyAssets
        package_parameter_enabled: true
        style: snake-case
  

Bug fix

• #287 Delete the generated files then flutter_gen won't generate files again
  • #dart-lang/build#3364 Aggregate builder not rebuild when one of multiple output files is deleted.

Feature

• #264 Add keyName to asset generate file.
  • #248
  • #251

Bug fix

• #247 Make the default scale value null, so Flutter decides the one to use.

Bug fix

• #236 The crypto package 3.0.2 conflict in flutter_gen_runner 4.2.0 with integration_test.

Feature

• #208 Add scale and opacity parameters to Image().

• #221 Support for build_runner watch.

• #227 Maintenance for Flutter3 (flutter_lints to 2.0.1).

• #229 Removed the AssetImage inheritance from AssetGenImage.

  • Extending package information to asset types other than AssetGenImage.
  • Added 'gen_for_package:true/false' param to support asset generation for a package.

  // Before
  Widget build(BuildContext context) {
    return Image(image: Assets.images.chip);  // Can't use this.
  }
  // After
  Widget build(BuildContext context) {
    return Assets.images.chip.image();
  }
  

  • Added example_resource package for how to use another package resources from an app.

  # file: example_resources/pubspec.yaml
  # ...
  flutter_gen:
    # ...
    assets:
      enabled: true
      package_parameter_enabled: true
  
  #...
  

• #230 Add coverage ignore comment on generated file headers.

• Update collection to 1.16.0.

• Update min dart sdk to >=2.14.0 <3.0.0.

Development

• Update to Dart 2.17.1
• Update to Flutter 3.0.1

Feature

• #199 #201 Expose some parameters of SvgPicture (flutter_svg).
  • theme
  • cacheColorFilter

Bug fix

• #187 Update dependencies.
  • analyzer

Feature

• #180 #182 Update to dartx 1.0.0 and json_serializable to 6.0.0

Development

• Update to Dart 2.15.0
• Update to Flutter 2.8.1

Bug fix

• #172 #173 Add unnecessary_import in ignore_for_title because cause warning from Dart 2.15.

Development

• Added sample code.

Bug fix

• #156 The Dartdocs generate different strings on Windows and Ubuntu.

Feature

• #138 Generate dartdoc as follows.

  /// File path: pictures/chip5.jpg
  AssetGenImage get chip5 => const AssetGenImage('pictures/chip5.jpg');
  /// Color: #979797
  static const Color gray410 = Color(0xFF979797);
  

• #143 Support Rive files type.

  flutter_gen:
    integrations:
      rive: true
  

• #150 Added the --version option for command-line.

  % fluttergen --version
  FlutterGen v4.1.0
  

  Bug fix
• #134 Added the ability to support the at symbol (@) in file names.

  AssetGenImage get logo2x => const AssetGenImage('assets/images/logo@2x.png');
  

  Development
• Update to Dart 2.14.4.
• Update to Flutter 2.5.3.
• Replace to renovate.

Bug fix

• #134 Support the at symbol (@) in file names.
• #139 Error: Method not found: '$checkedCreate

Development

• Replace to flutter_lints.

Features

• [BREAKING] Ended support for Non null safety codes.
• Use for line_length instead of lineLength.

Development

• Replace to Melos.
• Add VSCode setting.

• #117 Update to analyzer 2.0.0. flutter_gen_runner (flutter_gen_core) 3.1.2 -> analyzer 2.0.0 workaround

  dependency_overrides:
    meta: ^1.7.0
  

• #110 Replace null safety dart style package.

Features & Bug fix

• #103 Add option packageParameterEnabled to control whether to generate package parameter for assets or not.

Features

• #98 Support for adding assets from a package

• Support Null Safety

flutter_gen:
  output: lib/gen/
  line_length: 80
  null_safety: true # Optional (default: true)

• Update dependencies

New Feature

• [BREAKING CHANGE] #49 #53 Name collision with flutter localization when using build_runner

  # Before
  # dev_dependencies:
  #  flutter_gen: 1.3.1
  
  # After
  dev_dependencies:
    flutter_gen_runner: ^2.0.0
  

• #74 Doesn't generate assets.gen.dart when there are no assets

  flutter_gen:
    fonts:
      enabled: false
  

• #59 Handling duplicate file names

  // generated codes
  static const AssetGenImage imagesProfileJpg = AssetGenImage('assets/images/profile.jpg');
  static const AssetGenImage imagesProfilePng = AssetGenImage('assets/images/profile.png');
  

Bug fix

• #75 Null safety support for generated files