Include image dimensions in generated AssetGenImage class

[bramp]

What does this change?

This adds a new config parse_metadata which at build time determines the dimensions of image assets and includes them in the generated AssetGenImage class.

Before this change you'd need to do this: (taken from StackOverflow):

final Image image = Image(image: AssetImage(Assets.images.someimage.path));
Completer<ui.Image> completer = new Completer<ui.Image>();
    image.image
        .resolve(new ImageConfiguration())
        .addListener(new ImageStreamListener((ImageInfo image, bool _) {
      completer.complete(image.image);
    }));
ui.Image info = await completer.future;
print("${info.width} x ${info.height};

After this change you can now easily do

print(Assets.images.someimage.size)

So far this only works for SVGs, but it'll be easy to add the other types, and include other metadata (not just dimension if deemed useful).

Fixes #402🎯

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)
• 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) <-- I think this is just melos test
  • Ensure the analyzer and formatter pass (melos run format to automatically apply formatting)
• Appropriate docs were updated (if necessary)

[AlexV525]

If you already have a solution for images, why SVGs are supported only?

[bramp]

Sorry, which solution for images? The Completer<ui.Image> from above? That works at run time, and requires async, where embedding this means you can far more easily use this extra metadata.

Or are you asking why I haven't done this for images? I only needed it for svgs, but I'm happy to also add it to images (and Rive/Lottie), but I wanted to limit my work until you already did an initial review of the concept.

If this idea sounds good I'll add other support tomorrow

[AlexV525]

If this idea sounds good I'll add other support tomorrow

In general this looks great. Looking forward to further integrations.

[bramp]

Just rebased onto the latest main branch. Now adding changes for parsing other asset types. It would simplify the code if you review #432 first, which refactors the default asset types out into its own Integration which removes a bunch of duplication, and keeps assets_generator.dart small.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c27a411) 98.29% compared to head (862d1bc) 98.34%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #431      +/-   ##
==========================================
+ Coverage   98.29%   98.34%   +0.05%     
==========================================
  Files          21       21              
  Lines         702      724      +22     
==========================================
+ Hits          690      712      +22     
  Misses         12       12              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[bramp]

Ok AssetGenImage is now supported. Please take a look.

[bramp]

@AlexV525 any chance of moving this forward? Or what can I do to progress this? Thanks

[AlexV525]

@AlexV525 any chance of moving this forward? Or what can I do to progress this? Thanks

Sorry I need some time to coordinate my open-source working time. I'll get back to review once I'm available.

[bramp]

Ok thanks. I'll check in periodically, and if there is anything I can do to help, please ask.

[AlexV525]

Ah, our package, great. :)

[bramp]

Thanks. I'm about to be ooo for a week, but I'll fix up what's needed when I return.

[bramp]

Ok rebased onto the latest main, and addressed the reviewed comments. Please take another look @AlexV525 thanks!

[AlexV525]

@bramp The implementation looks good. Consider adding a doc entry in the README?

[bramp]

Ok updated the README, and resynced to fix conflict with main.

[AlexV525]

LGTM with 1 nit picking