From 4a8ad3a6bb24f0c0d4e5b6229efc04016fe4f891 Mon Sep 17 00:00:00 2001 From: Alex Li Date: Thu, 19 Oct 2023 11:05:04 +0800 Subject: [PATCH 1/4] =?UTF-8?q?=F0=9F=8E=A8=20Update=20outdated=20example?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- examples/example_resources/lib/gen/assets.gen.dart | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/examples/example_resources/lib/gen/assets.gen.dart b/examples/example_resources/lib/gen/assets.gen.dart index 9b8282339..6b39c5c70 100644 --- a/examples/example_resources/lib/gen/assets.gen.dart +++ b/examples/example_resources/lib/gen/assets.gen.dart @@ -148,8 +148,7 @@ class SvgGenImage { Key? key, bool matchTextDirection = false, AssetBundle? bundle, - @Deprecated('Do not use package for a package asset') - String? package = package, + @deprecated String? package = package, double? width, double? height, BoxFit fit = BoxFit.contain, @@ -300,8 +299,7 @@ class LottieGenImage { double? height, BoxFit? fit, AlignmentGeometry? alignment, - @Deprecated('Do not use package for a package asset') - String? package = package, + @deprecated String? package = package, bool? addRepaintBoundary, FilterQuality? filterQuality, void Function(String)? onWarning, From 32f993ecd449251668dbaa3f0236c832ea51fafa Mon Sep 17 00:00:00 2001 From: Alex Li Date: Thu, 19 Oct 2023 11:06:11 +0800 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=90=9B=20Fix=20the=20missing=20`@depr?= =?UTF-8?q?ecated`=20for=20the=20`ImageProvider`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/core/lib/generators/assets_generator.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/lib/generators/assets_generator.dart b/packages/core/lib/generators/assets_generator.dart index 7b3c61083..3f17e99eb 100644 --- a/packages/core/lib/generators/assets_generator.dart +++ b/packages/core/lib/generators/assets_generator.dart @@ -606,7 +606,7 @@ ${isPackage ? "\n static const String package = '$packageName';" : ''} ImageProvider provider({ AssetBundle? bundle, - String? package$packageParameter, + ${isPackage ? '@deprecated ' : ''}String? package$packageParameter, }) { return AssetImage( _assetName, From a9919adb294b268122d33f06eeca04acf9d64747 Mon Sep 17 00:00:00 2001 From: Alex Li Date: Thu, 19 Oct 2023 12:20:40 +0800 Subject: [PATCH 3/4] =?UTF-8?q?=E2=9C=85=20Fix=20test?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../actual_data/assets_package_parameter.gen.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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..d99b59385 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 @@ -126,7 +126,7 @@ class AssetGenImage { ImageProvider provider({ AssetBundle? bundle, - String? package = package, + @deprecated String? package = package, }) { return AssetImage( _assetName, From ac010e19699bfe26087167dd9cec264d7570dc57 Mon Sep 17 00:00:00 2001 From: Alex Li Date: Fri, 20 Oct 2023 09:50:22 +0800 Subject: [PATCH 4/4] =?UTF-8?q?=E2=9A=A1=EF=B8=8F=20Try=20`@Deprecated`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- examples/example_resources/lib/gen/assets.gen.dart | 9 ++++++--- packages/core/lib/generators/assets_generator.dart | 6 ++++-- .../core/lib/generators/integrations/integration.dart | 5 +++++ .../lib/generators/integrations/lottie_integration.dart | 3 ++- .../lib/generators/integrations/svg_integration.dart | 6 ++++-- packages/core/test/assets_gen_test.dart | 8 +++++++- .../actual_data/assets_package_parameter.gen.dart | 9 ++++++--- 7 files changed, 34 insertions(+), 12 deletions(-) diff --git a/examples/example_resources/lib/gen/assets.gen.dart b/examples/example_resources/lib/gen/assets.gen.dart index 6b39c5c70..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,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, @@ -299,7 +301,8 @@ class LottieGenImage { double? height, BoxFit? fit, AlignmentGeometry? alignment, - @deprecated String? package = package, + @Deprecated('Do not specify package for a generated library asset') + String? package = package, bool? addRepaintBoundary, FilterQuality? filterQuality, void Function(String)? onWarning, diff --git a/packages/core/lib/generators/assets_generator.dart b/packages/core/lib/generators/assets_generator.dart index 3f17e99eb..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,7 +607,8 @@ ${isPackage ? "\n static const String package = '$packageName';" : ''} ImageProvider provider({ AssetBundle? bundle, - ${isPackage ? '@deprecated ' : ''}String? package$packageParameter, + ${isPackage ? deprecationMessagePackage : ''} + String? package$packageParameter, }) { return AssetImage( _assetName, 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 d99b59385..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,7 +127,8 @@ class AssetGenImage { ImageProvider provider({ AssetBundle? bundle, - @deprecated String? package = package, + @Deprecated('Do not specify package for a generated library asset') + String? package = package, }) { return AssetImage( _assetName, @@ -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,