diff --git a/CHANGELOG.md b/CHANGELOG.md index f7c3e41ee..784deaaab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,78 @@ +## 5.0.0 + +**Feature** +- [#285](https://github.com/FlutterGen/flutter_gen/pull/285) [#298](https://github.com/FlutterGen/flutter_gen/pull/298) Add Lottie files integration. + ```dart + // Assets.lottie.hamburgerArrow.lottie() + SizedBox( + width: 200, + height: 200, + child: Assets.lottie.hamburgerArrow.lottie( + fit: BoxFit.contain, + ), + ), + ``` +- [#286](https://github.com/FlutterGen/flutter_gen/pull/286) Allow users to change generated class name for assets, fonts, and colors. + ```yaml + 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](https://github.com/FlutterGen/flutter_gen/pull/291) Add values list to generated classes for each directory. + ```dart + Assets.images.provider() // >[chip1, chip2, logo, profileJpg, profilePng]; + ``` +- [#292](https://github.com/FlutterGen/flutter_gen/pull/292) Support an ImageProvider. + ```dart + // Assets.images.chip.provider() + Container( + height: 400, + decoration: BoxDecoration( + image: DecorationImage( + image: Assets.images.chip.provider(), + ), + ), + child: const Center(child: Text('Deco')), + ), + + ``` +- [#294](https://github.com/FlutterGen/flutter_gen/pull/294) [**BREAKING CHANGES**] Moved the `style` and `package_parameter_enabled` to under assets.outputs scope. + ```yaml + + flutter_gen: + # ... + assets: + package_parameter_enabled: true + style: snake-case + outputs: + class_name: MyAssets + + flutter_gen: + # ... + assets: + outputs: + class_name: MyAssets + package_parameter_enabled: true + style: snake-case + ``` + +**Bug fix** +- [#287 ](https://github.com/FlutterGen/flutter_gen/issues/287) Delete the generated files then flutter_gen won't generate files again + - [#dart-lang/build#3364](https://github.com/dart-lang/build/issues/3364) Aggregate builder not rebuild when one of multiple output files is deleted. + + ## 4.3.0 **Feature** diff --git a/README.md b/README.md index 122fd10fd..e06dd047d 100644 --- a/README.md +++ b/README.md @@ -176,7 +176,9 @@ Example results of `assets/images/chip.jpg`: - **`Assets.images.chip`** is an implementation of [`AssetImage class`](https://api.flutter.dev/flutter/painting/AssetImage-class.html). - **`Assets.images.chip.image(...)`** returns [`Image class`](https://api.flutter.dev/flutter/widgets/Image-class.html). +- **`Assets.images.chip.provider(...)`** returns [`ImageProvider class`](https://api.flutter.dev/flutter/painting/ImageProvider-class.html). - **`Assets.images.chip.path`** just returns the path string. +- **`Assets.images.chip.values`** just returns the values list. ```dart Widget build(BuildContext context) { @@ -226,7 +228,7 @@ Widget build(BuildContext context) { |[flutter_svg](https://pub.dev/packages/flutter_svg)|.svg| `flutter_svg: true` |Assets.images.icons.paint.**svg()**| |[flare_flutter](https://pub.dev/packages/flare_flutter)|.flr| `flare_flutter: true` |Assets.flare.penguin.**flare()**| |[rive](https://pub.dev/packages/rive)|.flr| `rive: true` |Assets.rive.vehicles.**rive()**| -|[lottie](https://pub.dev/packages/lottie)|_lottie.json| `lottie: true` |Assets.lottie.hamburgerArrow.**lottie()**| +|[lottie](https://pub.dev/packages/lottie)|.json| `lottie: true` |Assets.lottie.hamburgerArrow.**lottie()**|
@@ -246,14 +248,15 @@ final json = await rootBundle.loadString(Assets.json.fruits); # pubspec.yaml flutter_gen: assets: - # Assets.imagesChip - # style: camel-case + outputs: + # Assets.imagesChip + # style: camel-case - # Assets.images_chip - # style: snake-case + # Assets.images_chip + # style: snake-case - # Assets.images.chip (default style) - # style: dot-delimiter + # Assets.images.chip (default style) + # style: dot-delimiter flutter: assets: @@ -734,20 +737,27 @@ flutter_gen: # Optional enabled: true # Optional - # Set to true if you want this package to be a package dependency - # See: https://flutter.dev/docs/development/ui/assets-and-images#from-packages - package_parameter_enabled: false - # Optional - # Avaliable values: - # - camel-case - # - snake-case - # - dot-delimiter - style: dot-delimiter + outputs: + # Optional + # Set to true if you want this package to be a package dependency + # See: https://flutter.dev/docs/development/ui/assets-and-images#from-packages + package_parameter_enabled: false + # Optional + # Avaliable values: + # - camel-case + # - snake-case + # - dot-delimiter + style: dot-delimiter + # Default is Assets + class_name: MyAssets fonts: # Optional enabled: true # Optional + outputs: + # Default is FontFamily + class_name: MyFontFamily colors: # Optional @@ -755,6 +765,9 @@ flutter_gen: # Optional inputs: [] # Optional + outputs: + # Default is ColorName + class_name: MyColorName flutter: # See: https://flutter.dev/docs/development/ui/assets-and-images#specifying-assets @@ -784,9 +797,3 @@ and open a [pull request](https://github.com/FlutterGen/flutter_gen/pulls). [build_runner]: https://pub.dev/packages/build_runner [fluttergen]: https://pub.dev/packages/flutter_gen -
- -
-
-
-
diff --git a/example/pubspec.yaml b/example/pubspec.yaml index d92bab205..62c19af89 100644 --- a/example/pubspec.yaml +++ b/example/pubspec.yaml @@ -107,7 +107,7 @@ dev_dependencies: sdk: flutter build_runner: ^2.1.11 freezed: ^2.1.0+1 - flutter_gen_runner: ^4.3.0 + flutter_gen_runner: ^5.0.0 flutter_lints: ^2.0.1 diff --git a/example_resources/pubspec.yaml b/example_resources/pubspec.yaml index 677ae04f0..e17ba0861 100644 --- a/example_resources/pubspec.yaml +++ b/example_resources/pubspec.yaml @@ -17,12 +17,12 @@ dependencies: dev_dependencies: build_runner: ^2.1.11 - flutter_gen_runner: ^4.3.0 + flutter_gen_runner: ^5.0.0 flutter_gen: output: lib/gen/ line_length: 80 - + integrations: flutter_svg: true diff --git a/packages/command/pubspec.yaml b/packages/command/pubspec.yaml index 1dad82213..5ae41511b 100644 --- a/packages/command/pubspec.yaml +++ b/packages/command/pubspec.yaml @@ -1,7 +1,7 @@ name: flutter_gen description: The Flutter code generator for your assets, fonts, colors, … — Get rid of all String-based APIs. -version: 4.3.0 +version: 5.0.0 homepage: https://github.com/FlutterGen/flutter_gen repository: https://github.com/FlutterGen/flutter_gen documentation: https://github.com/FlutterGen/flutter_gen @@ -14,7 +14,7 @@ executables: fluttergen: flutter_gen_command dependencies: - flutter_gen_core: 4.3.0 + flutter_gen_core: 5.0.0 args: '>=2.0.0 <3.0.0' dev_dependencies: diff --git a/packages/core/lib/version.gen.dart b/packages/core/lib/version.gen.dart index c5b5fbb04..12dcf1d07 100644 --- a/packages/core/lib/version.gen.dart +++ b/packages/core/lib/version.gen.dart @@ -1,2 +1,2 @@ /// DO NOT MODIFY BY HAND, Generated by version_gen -String packageVersion = '4.3.0'; +String packageVersion = '5.0.0'; diff --git a/packages/core/pubspec.yaml b/packages/core/pubspec.yaml index ea760dd7c..724859608 100644 --- a/packages/core/pubspec.yaml +++ b/packages/core/pubspec.yaml @@ -1,7 +1,7 @@ name: flutter_gen_core description: The Flutter code generator for your assets, fonts, colors, … — Get rid of all String-based APIs. -version: 4.3.0 +version: 5.0.0 homepage: https://github.com/FlutterGen/flutter_gen repository: https://github.com/FlutterGen/flutter_gen documentation: https://github.com/FlutterGen/flutter_gen diff --git a/packages/runner/pubspec.yaml b/packages/runner/pubspec.yaml index d596ad232..0e6ae08f0 100644 --- a/packages/runner/pubspec.yaml +++ b/packages/runner/pubspec.yaml @@ -1,7 +1,7 @@ name: flutter_gen_runner description: The Flutter code generator for your assets, fonts, colors, … — Get rid of all String-based APIs. -version: 4.3.0 +version: 5.0.0 homepage: https://github.com/FlutterGen/flutter_gen repository: https://github.com/FlutterGen/flutter_gen documentation: https://github.com/FlutterGen/flutter_gen @@ -11,7 +11,7 @@ environment: sdk: '>=2.14.0 <3.0.0' dependencies: - flutter_gen_core: 4.3.0 + flutter_gen_core: 5.0.0 build: '>=2.0.0 <3.0.0' collection: '>=1.15.0 <2.0.0' crypto: '>=3.0.0 <4.0.0'