diff --git a/examples/example_resources/lib/gen/assets.gen.dart b/examples/example_resources/lib/gen/assets.gen.dart index 9b8282339..ba955c8e7 100644 --- a/examples/example_resources/lib/gen/assets.gen.dart +++ b/examples/example_resources/lib/gen/assets.gen.dart @@ -88,7 +88,8 @@ class AssetGenImage { bool matchTextDirection = false, bool gaplessPlayback = false, bool isAntiAlias = false, - @deprecated String? package = package, + @Deprecated('Do not specify package for a generated library asset') + String? package = package, FilterQuality filterQuality = FilterQuality.low, int? cacheWidth, int? cacheHeight, @@ -148,7 +149,7 @@ class SvgGenImage { Key? key, bool matchTextDirection = false, AssetBundle? bundle, - @Deprecated('Do not use package for a package asset') + @Deprecated('Do not specify package for a generated library asset') String? package = package, double? width, double? height, @@ -300,7 +301,7 @@ class LottieGenImage { double? height, BoxFit? fit, AlignmentGeometry? alignment, - @Deprecated('Do not use package for a package asset') + @Deprecated('Do not specify package for a generated library asset') String? package = package, bool? addRepaintBoundary, FilterQuality? filterQuality, diff --git a/packages/core/lib/generators/assets_generator.dart b/packages/core/lib/generators/assets_generator.dart index 7b3c61083..81365ab34 100644 --- a/packages/core/lib/generators/assets_generator.dart +++ b/packages/core/lib/generators/assets_generator.dart @@ -571,7 +571,8 @@ ${isPackage ? "\n static const String package = '$packageName';" : ''} bool matchTextDirection = false, bool gaplessPlayback = false, bool isAntiAlias = false, - ${isPackage ? '@deprecated ' : ''}String? package$packageParameter, + ${isPackage ? deprecationMessagePackage : ''} + String? package$packageParameter, FilterQuality filterQuality = FilterQuality.low, int? cacheWidth, int? cacheHeight, @@ -606,6 +607,7 @@ ${isPackage ? "\n static const String package = '$packageName';" : ''} ImageProvider provider({ AssetBundle? bundle, + ${isPackage ? deprecationMessagePackage : ''} String? package$packageParameter, }) { return AssetImage( diff --git a/packages/core/lib/generators/integrations/integration.dart b/packages/core/lib/generators/integrations/integration.dart index e3d3dccfa..6ccd283f7 100644 --- a/packages/core/lib/generators/integrations/integration.dart +++ b/packages/core/lib/generators/integrations/integration.dart @@ -20,3 +20,8 @@ abstract class Integration { bool get isConstConstructor; } + +/// The deprecation message for the package argument +/// if the asset is a library asset. +const String deprecationMessagePackage = + "@Deprecated('Do not specify package for a generated library asset')"; diff --git a/packages/core/lib/generators/integrations/lottie_integration.dart b/packages/core/lib/generators/integrations/lottie_integration.dart index fdb4a1fb7..7d8fa4dba 100644 --- a/packages/core/lib/generators/integrations/lottie_integration.dart +++ b/packages/core/lib/generators/integrations/lottie_integration.dart @@ -55,7 +55,8 @@ ${isPackage ? "\n static const String package = '$packageParameterLiteral';" : double? height, BoxFit? fit, AlignmentGeometry? alignment, - ${isPackage ? '@deprecated ' : ''}String? package$packageExpression, + ${isPackage ? deprecationMessagePackage : ''} + String? package$packageExpression, bool? addRepaintBoundary, FilterQuality? filterQuality, void Function(String)? onWarning, diff --git a/packages/core/lib/generators/integrations/svg_integration.dart b/packages/core/lib/generators/integrations/svg_integration.dart index e6d1dc714..9a97bf6cb 100644 --- a/packages/core/lib/generators/integrations/svg_integration.dart +++ b/packages/core/lib/generators/integrations/svg_integration.dart @@ -20,13 +20,15 @@ class SvgIntegration extends Integration { const SvgGenImage(this._assetName); final String _assetName; -${isPackage ? "\n static const String package = '$packageParameterLiteral';" : ''} + + ${isPackage ? "static const String package = '$packageParameterLiteral';" : ''} SvgPicture svg({ Key? key, bool matchTextDirection = false, AssetBundle? bundle, - ${isPackage ? '@deprecated ' : ''}String? package$packageExpression, + ${isPackage ? deprecationMessagePackage : ''} + String? package$packageExpression, double? width, double? height, BoxFit fit = BoxFit.contain, diff --git a/packages/core/test/assets_gen_test.dart b/packages/core/test/assets_gen_test.dart index a1d0cd6ef..84cdc45ec 100644 --- a/packages/core/test/assets_gen_test.dart +++ b/packages/core/test/assets_gen_test.dart @@ -79,7 +79,13 @@ void main() { expect(content, contains("static const String package = 'test';")); expect( content, - contains('@deprecated String? package = package,'), + contains( + "@Deprecated('Do not specify package for a generated library asset')", + ), + ); + expect( + content, + contains('String? package = package,'), ); }); diff --git a/packages/core/test_resources/actual_data/assets_package_parameter.gen.dart b/packages/core/test_resources/actual_data/assets_package_parameter.gen.dart index 303c9c676..e235a7009 100644 --- a/packages/core/test_resources/actual_data/assets_package_parameter.gen.dart +++ b/packages/core/test_resources/actual_data/assets_package_parameter.gen.dart @@ -91,7 +91,8 @@ class AssetGenImage { bool matchTextDirection = false, bool gaplessPlayback = false, bool isAntiAlias = false, - @deprecated String? package = package, + @Deprecated('Do not specify package for a generated library asset') + String? package = package, FilterQuality filterQuality = FilterQuality.low, int? cacheWidth, int? cacheHeight, @@ -126,6 +127,7 @@ class AssetGenImage { ImageProvider provider({ AssetBundle? bundle, + @Deprecated('Do not specify package for a generated library asset') String? package = package, }) { return AssetImage( @@ -151,7 +153,8 @@ class SvgGenImage { Key? key, bool matchTextDirection = false, AssetBundle? bundle, - @deprecated String? package = package, + @Deprecated('Do not specify package for a generated library asset') + String? package = package, double? width, double? height, BoxFit fit = BoxFit.contain,