refactor: Removed the AssetImage inheritance from AssetGenImage (#229)

* refactor: change to return image.asset

* fix: add to pass package arg

* chore: add sample code for external package

* chore: add svg file to example_resources

* refactor: change position ignore-coverage line

* chore: update readme

* chore: add example code

Author: wasabeef

README.md

@@ -179,7 +179,7 @@ Example results of `assets/images/chip.jpg`:
 
 ```dart
 Widget build(BuildContext context) {
-  return Image(image: Assets.images.chip);
+  return Assets.images.chip.image();
 }
 
 Widget build(BuildContext context) {

example/lib/gen/assets.gen.dart

@@ -3,6 +3,7 @@
 ///  FlutterGen
 /// *****************************************************
 
+// coverage:ignore-file
 // ignore_for_file: type=lint
 // ignore_for_file: directives_ordering,unnecessary_import
 
@@ -132,19 +133,23 @@ class Assets {
   static const $PicturesGen pictures = $PicturesGen();
 }
 
-class AssetGenImage extends AssetImage {
-  const AssetGenImage(String assetName) : super(assetName);
+class AssetGenImage {
+  const AssetGenImage(this._assetName);
+
+  final String _assetName;
 
   Image image({
     Key? key,
+    AssetBundle? bundle,
     ImageFrameBuilder? frameBuilder,
-    ImageLoadingBuilder? loadingBuilder,
     ImageErrorWidgetBuilder? errorBuilder,
     String? semanticLabel,
     bool excludeFromSemantics = false,
+    double? scale = 1.0,
     double? width,
     double? height,
     Color? color,
+    Animation<double>? opacity,
     BlendMode? colorBlendMode,
     BoxFit? fit,
     AlignmentGeometry alignment = Alignment.center,
@@ -153,19 +158,24 @@ class AssetGenImage extends AssetImage {
     bool matchTextDirection = false,
     bool gaplessPlayback = false,
     bool isAntiAlias = false,
+    String? package,
     FilterQuality filterQuality = FilterQuality.low,
+    int? cacheWidth,
+    int? cacheHeight,
   }) {
-    return Image(
+    return Image.asset(
+      _assetName,
       key: key,
-      image: this,
+      bundle: bundle,
       frameBuilder: frameBuilder,
-      loadingBuilder: loadingBuilder,
       errorBuilder: errorBuilder,
       semanticLabel: semanticLabel,
       excludeFromSemantics: excludeFromSemantics,
+      scale: scale,
       width: width,
       height: height,
       color: color,
+      opacity: opacity,
       colorBlendMode: colorBlendMode,
       fit: fit,
       alignment: alignment,
@@ -174,11 +184,14 @@ class AssetGenImage extends AssetImage {
       matchTextDirection: matchTextDirection,
       gaplessPlayback: gaplessPlayback,
       isAntiAlias: isAntiAlias,
+      package: package,
       filterQuality: filterQuality,
+      cacheWidth: cacheWidth,
+      cacheHeight: cacheHeight,
     );
   }
 
-  String get path => assetName;
+  String get path => _assetName;
 }
 
 class SvgGenImage {

example/lib/gen/colors.gen.dart

@@ -3,6 +3,7 @@
 ///  FlutterGen
 /// *****************************************************
 
+// coverage:ignore-file
 // ignore_for_file: type=lint
 // ignore_for_file: directives_ordering,unnecessary_import
 

example/lib/gen/fonts.gen.dart

@@ -3,6 +3,7 @@
 ///  FlutterGen
 /// *****************************************************
 
+// coverage:ignore-file
 // ignore_for_file: type=lint
 // ignore_for_file: directives_ordering,unnecessary_import
 

example/lib/main.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:example_resources/gen/assets.gen.dart' as res;
 
 import 'gen/assets.gen.dart';
 import 'gen/colors.gen.dart';
@@ -37,7 +38,10 @@ void main() {
                   fit: BoxFit.contain,
                 ),
               ),
-              Image(image: Assets.images.chip1),
+              Assets.images.chip1.image(),
+              // Use from example_resource package.
+              res.Assets.images.flutter3.image(),
+              res.Assets.images.dart.svg(),
               Assets.images.icons.kmm.svg(key: const Key("kmm_svg")),
               Assets.images.icons.fuchsia.svg(),
               Assets.images.icons.paint.svg(

example/pubspec.yaml

@@ -19,6 +19,10 @@ dependencies:
 
   json_annotation: ^4.5.0
   freezed_annotation: ^2.0.3
+    
+  example_resources:
+    path: ../example_resources
+
 
 dev_dependencies:
   flutter_test:

example_resources/README.md

@@ -0,0 +1,10 @@
+# example
+
+A sample project using FlutterGen.
+
+## Getting Started
+
+```
+cd ../flutter_gen
+melos run pub:get
+```