✨ Add `package` to generated assets #401

AlexV525 · 2023-06-20T03:50:01Z

What does this change?

Add package and the default value of package to the generated asset class and integrated assets.

Fixes #399 🎯

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Checklist:

Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open a GitHub issue as a bug/feature request before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- Ensure the tests (melos run unit:test)
- Ensure the analyzer and formatter pass (melos run format to automatically apply formatting)
Appropriate docs were updated (if necessary)

AlexV525 · 2023-06-21T08:21:15Z

@wasabeef Could you take a first look and let me know if you have some other thoughts? I haven't write tests or docs for this yet.

wasabeef · 2023-06-21T09:46:02Z

@AlexV525
That sounds good.

AlexV525 · 2023-06-21T09:47:41Z

@AlexV525 That sounds good.

Thanks. I'm going to have a few days break and I'll be back to update this then.

codecov · 2023-07-04T15:44:14Z

Codecov Report

Merging #401 (ca1e1e6) into main (a0ae85f) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #401      +/-   ##
==========================================
+ Coverage   98.26%   98.28%   +0.01%     
==========================================
  Files          20       20              
  Lines         691      698       +7     
==========================================
+ Hits          679      686       +7     
  Misses         12       12

Files	Coverage Δ
packages/core/lib/generators/assets_generator.dart	`98.15% <100.00%> (+0.07%)`	⬆️
...lib/generators/integrations/flare_integration.dart	`100.00% <100.00%> (ø)`
.../core/lib/generators/integrations/integration.dart	`100.00% <100.00%> (ø)`
...ib/generators/integrations/lottie_integration.dart	`92.85% <100.00%> (-0.25%)`	⬇️
.../lib/generators/integrations/rive_integration.dart	`100.00% <100.00%> (ø)`
...e/lib/generators/integrations/svg_integration.dart	`100.00% <100.00%> (ø)`

AlexV525 · 2023-07-05T06:47:03Z

examples/example_resources/lib/gen/assets.gen.dart

+    @Deprecated('Do not use package for a package asset')
+    String? package = package,


The dart_style formatter will produce a different result for this line.

AlexV525 · 2023-07-05T06:58:15Z

I ran formatting tests locally which resulted in success.

AlexV525 · 2023-07-05T07:50:56Z

It's a disaster when using @Deprecated along with dart_style...

bramp · 2023-08-22T00:51:54Z

README.md

+flutter_gen:
+  assets:
+    outputs:
+      package_parameter_enabled: false # <- Add this line.


nit: package_parameter_enabled seems quite long, surely package_parameter would also be acceptable?

and in your example, would you set this to "true" to have the package parameter included?

nit: package_parameter_enabled seems quite long, surely package_parameter would also be acceptable?

The parameter is not new, so it'd be a breaking change if we use another name.

and in your example, would you set this to "true" to have the package parameter included?

Sure. Sounds good too.

AlexV525 · 2023-08-22T08:15:56Z

@bramp Can you help with merging and publishing?

bramp · 2023-08-22T14:47:05Z

@AlexV525 I'd be happy to review, but I'm not a maintainer of this project. I just came across this PR when I realised I needed the package name.

AlexV525 · 2023-09-13T15:31:29Z

cc @lcdsmao

VB10 · 2023-10-19T01:14:02Z

how is going this feature, it so useful with using modular import.

# Conflicts: # packages/core/lib/generators/assets_generator.dart

bramp · 2023-10-19T02:47:16Z

examples/example_resources/lib/gen/assets.gen.dart

  SvgPicture svg({
    Key? key,
    bool matchTextDirection = false,
    AssetBundle? bundle,
-    String? package = 'example_resources',
+    @Deprecated('Do not use package for a package asset')


In the deprecated message, what should the developer do instead? "Do not use" doesn't tell them what to do instead.

@deprecated("Package is no longer needed as it now defaults to correct package") ?

They should not use package for a package asset, which literally means not using it.

Ah and it's @deprecated actually.

bramp · 2023-10-19T02:47:30Z

examples/example_resources/lib/gen/assets.gen.dart

@@ -84,7 +88,7 @@ class AssetGenImage {
    bool matchTextDirection = false,
    bool gaplessPlayback = false,
    bool isAntiAlias = false,
-    String? package = 'example_resources',
+    @deprecated String? package = package,


No deprecate message?

This is because of a dart_style formatting issue and I cannot get a consist behavior when generating files with @Deprecated, so go for the @deprecated.

ah sorry you did explain that back in July. Sorry for asking again!

I just tried again locally, and dart format does not change it when it's formatted it either:

@Deprecated("short") String? package,

or

@Deprecated("really really really really really really really really really really really long ") String? package,

Ok, it's such a minor thing, it's not worth debugging more. But maybe off-topic, but is the dart_style package still needed? dart format works fine without it.

but is the dart_style package still needed? dart format works fine without it.

So far it looks to be required because codes are generated when running runners and produced formatted files without calling dart format.

Oh I see, dart_style is used during the generating of the code.

I noticed the version of dart_style listed in packages/core/pubspec.yaml is a year old, and the dart format being run in the GitHub actions seems a lot newer than that.

I noticed the version of dart_style listed in packages/core/pubspec.yaml is a year old, and the dart format being run in the GitHub actions seems a lot newer than that.

That's fine unless it released v3 then we'll need to manually bump it.

bramp · 2023-10-19T02:47:48Z

examples/example_resources/lib/gen/assets.gen.dart

@@ -119,7 +123,7 @@ class AssetGenImage {

  ImageProvider provider({
    AssetBundle? bundle,
-    String? package = 'example_resources',
+    String? package = package,


Missing deprecate message?

Good catch, thanks!

## What does this change? Further updates to #401. ## Type of change - [x] Bug fix (non-breaking change which fixes an issue)

✨ Add package to generated assets

064c5ff

AlexV525 added 4 commits June 21, 2023 23:57

✅ Add tests

3c11a10

✅ Fix and add tests

cc0cece

✅ Fix generate tests

67f58e7

✅ Fix separator on Windows for command tests

dd4337c

🎨 Fix file formats

7e04eaf

AlexV525 commented Jul 5, 2023

View reviewed changes

AlexV525 added 2 commits July 5, 2023 15:05

🎨 Try dart_style matching

bb180a8

♻️ Split generatePackageNameForConfig and add tests

4352ebf

AlexV525 mentioned this pull request Jul 5, 2023

[analyzer/format] Format exception when using @Deprecated with constructor's argument dart-lang/dart_style#1027

Closed

✅ Use @deprecated instead of @Deprecated

1a59d65

📝 Add README

fbad33b

AlexV525 marked this pull request as ready for review July 5, 2023 07:59

AlexV525 requested a review from wasabeef as a code owner July 5, 2023 07:59

AlexV525 mentioned this pull request Aug 9, 2023

[FR]: Generate the package into the Assets/Fonts class #399

Closed

2 tasks

bramp reviewed Aug 22, 2023

View reviewed changes

📝 ++

e879ed1

wasabeef added this to the 5.4.0 milestone Sep 21, 2023

Merge branch 'main' into feat/add-package-to-gen

ca1e1e6

# Conflicts: # packages/core/lib/generators/assets_generator.dart

AlexV525 requested a review from lcdsmao as a code owner October 19, 2023 02:20

AlexV525 merged commit 30d50aa into FlutterGen:main Oct 19, 2023
5 checks passed

AlexV525 deleted the feat/add-package-to-gen branch October 19, 2023 02:26

bramp reviewed Oct 19, 2023

View reviewed changes

AlexV525 mentioned this pull request Oct 19, 2023

✨ Add package to generated assets, pt.2 #439

Merged

8 tasks

AlexV525 added a commit that referenced this pull request Oct 27, 2023

✨ Add package to generated assets, pt.2 (#439)

44d743d

## What does this change? Further updates to #401. ## Type of change - [x] Bug fix (non-breaking change which fixes an issue)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Add `package` to generated assets #401

✨ Add `package` to generated assets #401

AlexV525 commented Jun 20, 2023

AlexV525 commented Jun 21, 2023

wasabeef commented Jun 21, 2023

AlexV525 commented Jun 21, 2023

codecov bot commented Jul 4, 2023 •

edited

Loading

AlexV525 Jul 5, 2023

AlexV525 commented Jul 5, 2023

AlexV525 commented Jul 5, 2023

bramp Aug 22, 2023

AlexV525 Aug 22, 2023 •

edited

Loading

AlexV525 commented Aug 22, 2023

bramp commented Aug 22, 2023

AlexV525 commented Sep 13, 2023

VB10 commented Oct 19, 2023

bramp Oct 19, 2023 •

edited

Loading

AlexV525 Oct 19, 2023

AlexV525 Oct 19, 2023

bramp Oct 19, 2023

AlexV525 Oct 19, 2023

bramp Oct 20, 2023

AlexV525 Oct 20, 2023

bramp Oct 20, 2023

AlexV525 Oct 20, 2023

bramp Oct 19, 2023

AlexV525 Oct 19, 2023

		@Deprecated('Do not use package for a package asset')
		String? package = package,

✨ Add package to generated assets #401

✨ Add package to generated assets #401

Conversation

AlexV525 commented Jun 20, 2023

What does this change?

Type of change

Checklist:

AlexV525 commented Jun 21, 2023

wasabeef commented Jun 21, 2023

AlexV525 commented Jun 21, 2023

codecov bot commented Jul 4, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

AlexV525 commented Jul 5, 2023

AlexV525 commented Jul 5, 2023

Choose a reason for hiding this comment

AlexV525 Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

AlexV525 commented Aug 22, 2023

bramp commented Aug 22, 2023

AlexV525 commented Sep 13, 2023

VB10 commented Oct 19, 2023

bramp Oct 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

✨ Add `package` to generated assets #401

✨ Add `package` to generated assets #401

codecov bot commented Jul 4, 2023 •

edited

Loading

AlexV525 Aug 22, 2023 •

edited

Loading

bramp Oct 19, 2023 •

edited

Loading