Fix #102 (#103)

* test: revert test resources without pacakge

* feat: generate package parameter based on option

* test: add package parameter enabled test

* docs: add package parameter enabled

Co-authored-by: Daichi Furiya <[email protected]>

Author: lcdsmao

README.md

@@ -108,7 +108,8 @@ $ fluttergen -c example/pubspec.yaml
 
 ## Configuration file
 
-[FlutterGen] generates dart files based on the key **`flutter`** and **`flutter_gen`** of [`pubspec.yaml`](https://dart.dev/tools/pub/pubspec).
+[FlutterGen] generates dart files based on the key **`flutter`** and **`flutter_gen`** of [`pubspec.yaml`](https://dart.dev/tools/pub/pubspec).  
+Default configuration can be found [here](#default-settings). 
 
 ```yaml
 # pubspec.yaml
@@ -663,7 +664,7 @@ class ColorName {
 </p>
 </details>
 
-### Default Settings
+### Default Configuration
 
 The following are the default settings.
 The options you set in `pubspec.yaml` will override the corresponding default options.
@@ -679,6 +680,7 @@ flutter_gen:
 
   assets:
     enabled: true
+    package_parameter_enabled: false
     style: dot-delimiter
     
   fonts:

example/lib/gen/assets.gen.dart

@@ -91,7 +91,7 @@ class Assets {
 }
 
 class AssetGenImage extends AssetImage {
-  const AssetGenImage(String assetName) : super(assetName, package: 'example');
+  const AssetGenImage(String assetName) : super(assetName);
 
   Image image({
     Key? key,
@@ -148,7 +148,7 @@ class SvgGenImage {
     Key? key,
     bool matchTextDirection = false,
     AssetBundle? bundle,
-    String? package = 'example',
+    String? package,
     double? width,
     double? height,
     BoxFit fit = BoxFit.contain,

packages/core/lib/generators/assets_generator.dart

@@ -19,7 +19,7 @@ import 'integrations/svg_integration.dart';
 class AssetsGenConfig {
   AssetsGenConfig._(
     this.rootPath,
-    this.packageName,
+    this._packageName,
     this.flutterGen,
     this.assets,
   );
@@ -34,9 +34,12 @@ class AssetsGenConfig {
   }
 
   final String rootPath;
-  final String packageName;
+  final String _packageName;
   final FlutterGen flutterGen;
   final List<String> assets;
+
+  String get packageParameterLiteral =>
+      flutterGen.assets.packageParameterEnabled ? _packageName : '';
 }
 
 String generateAssets(
@@ -54,7 +57,7 @@ String generateAssets(
   final integrations = <Integration>[
     // TODO: Until null safety generalizes
     if (config.flutterGen.integrations.flutterSvg)
-      SvgIntegration(config.packageName,
+      SvgIntegration(config.packageParameterLiteral,
           nullSafety: config.flutterGen.nullSafety),
     if (config.flutterGen.integrations.flareFlutter)
       FlareIntegration(nullSafety: config.flutterGen.nullSafety),
@@ -72,10 +75,13 @@ String generateAssets(
 
   // TODO: Until null safety generalizes
   if (config.flutterGen.nullSafety) {
-    classesBuffer.writeln(_assetGenImageClassDefinition(config.packageName));
+    classesBuffer.writeln(_assetGenImageClassDefinition(
+      config.packageParameterLiteral,
+    ));
   } else {
-    classesBuffer.writeln(
-        _assetGenImageClassDefinitionWithNoNullSafety(config.packageName));
+    classesBuffer.writeln(_assetGenImageClassDefinitionWithNoNullSafety(
+      config.packageParameterLiteral,
+    ));
   }
 
   final imports = <String>{'package:flutter/widgets.dart'};
@@ -333,10 +339,13 @@ class $className {
 }
 
 /// Null Safety
-String _assetGenImageClassDefinition(String packageName) => '''
+String _assetGenImageClassDefinition(String packageName) {
+  final optionalParameter =
+      packageName.isNotEmpty ? ', package: \'$packageName\'' : '';
+  return '''
 
 class AssetGenImage extends AssetImage {
-  const AssetGenImage(String assetName) : super(assetName, package: '$packageName');
+  const AssetGenImage(String assetName) : super(assetName$optionalParameter);
 
   Image image({
     Key? key,
@@ -384,13 +393,16 @@ class AssetGenImage extends AssetImage {
   String get path => assetName;
 }
 ''';
+}
 
 /// No Null Safety
 /// TODO: Until null safety generalizes
-String _assetGenImageClassDefinitionWithNoNullSafety(String packageName) => '''
-
+String _assetGenImageClassDefinitionWithNoNullSafety(String packageName) {
+  final optionalParameter =
+      packageName.isNotEmpty ? ', package: \'$packageName\'' : '';
+  return '''
 class AssetGenImage extends AssetImage {
-  const AssetGenImage(String assetName) : super(assetName, package: '$packageName');
+  const AssetGenImage(String assetName) : super(assetName$optionalParameter);
 
   Image image({
     Key key,
@@ -438,6 +450,7 @@ class AssetGenImage extends AssetImage {
   String get path => assetName;
 }
 ''';
+}
 
 class _Statement {
   const _Statement({

packages/core/lib/generators/integrations/svg_integration.dart

@@ -4,10 +4,16 @@ import 'integration.dart';
 class SvgIntegration extends Integration {
   // TODO: Until null safety generalizes
   // ignore: avoid_positional_boolean_parameters
-  SvgIntegration(this._packageName, {bool nullSafety = true})
-      : super(nullSafety: nullSafety);
+  SvgIntegration(
+    this._packageParameterLiteral, {
+    bool nullSafety = true,
+  }) : super(nullSafety: nullSafety);
 
-  final String _packageName;
+  final String _packageParameterLiteral;
+
+  String get packageExpression => _packageParameterLiteral.isNotEmpty
+      ? ' = \'$_packageParameterLiteral\''
+      : '';
 
   @override
   List<String> get requiredImports => [
@@ -30,7 +36,7 @@ class SvgIntegration extends Integration {
     Key? key,
     bool matchTextDirection = false,
     AssetBundle? bundle,
-    String? package = '$_packageName',
+    String? package$packageExpression,
     double? width,
     double? height,
     BoxFit fit = BoxFit.contain,
@@ -77,7 +83,7 @@ class SvgIntegration extends Integration {
     Key key,
     bool matchTextDirection = false,
     AssetBundle bundle,
-    String package = '$_packageName',
+    String package$packageExpression,
     double width,
     double height,
     BoxFit fit = BoxFit.contain,

packages/core/lib/settings/config.dart

@@ -51,6 +51,7 @@ flutter_gen:
 
   assets:
     enabled: true
+    package_parameter_enabled: false
     style: dot-delimiter
     
   fonts:

packages/core/lib/settings/pubspec.dart

@@ -127,7 +127,11 @@ class FlutterGenAssets {
   static const String snakeCaseStyle = 'snake-case';
   static const String camelCaseStyle = 'camel-case';
 
-  FlutterGenAssets({required this.enabled, required this.style}) {
+  FlutterGenAssets({
+    required this.enabled,
+    required this.packageParameterEnabled,
+    required this.style,
+  }) {
     if (style != dotDelimiterStyle &&
         style != snakeCaseStyle &&
         style != camelCaseStyle) {
@@ -138,6 +142,9 @@ class FlutterGenAssets {
   @JsonKey(name: 'enabled', required: true)
   final bool enabled;
 
+  @JsonKey(name: 'package_parameter_enabled', required: true)
+  final bool packageParameterEnabled;
+
   @JsonKey(name: 'style', required: true)
   final String style;
 

packages/core/lib/settings/pubspec.g.dart

@@ -74,5 +74,25 @@ void main() {
             AssetsGenConfig.fromConfig(pubspec, config), formatter);
       }, throwsA(isA<InvalidSettingsException>()));
     });
+
+    test('Assets with package parameter enabled', () async {
+      final pubspec = 'test_resources/pubspec_assets_package_parameter.yaml';
+      final fact =
+          'test_resources/actual_data/assets_package_parameter.gen.dart';
+      final generated =
+          'test_resources/lib/gen/assets_package_parameter.gen.dart';
+
+      expectedAssetsGen(pubspec, generated, fact);
+    });
+
+    test('Assets with package parameter enabled', () async {
+      final pubspec = 'test_resources/pubspec_assets_package_parameter.yaml';
+      final fact =
+          'test_resources/actual_data/assets_package_parameter_disable_null_safety.gen.dart';
+      final generated =
+          'test_resources/lib/gen/assets_package_parameter_disable_null_safety.gen.dart';
+
+      expectedAssetsGen(pubspec, generated, fact);
+    });
   });
 }