Web Support and Refactoring #155

personalizedrefrigerator · 2020-02-16T20:40:30Z

Overview

This pull request adds support for web-based favicons and Progressive Web App launcher icons.

Summary of Changes

Added web.dart. This script crops, resizes, and copies icons specified in configuration files.
Added tests for web.dart. Additional tests were necessary for the new configuration script.
Updated example projects.
Refactoring & general bug fixes.

Notes

The page's updated favicon is not shown when running flutter run -d chrome or flutter run -d web-server. The project must first be built for web, then served from the build directory (see the README).
Several directories that are automatically generated by flutter create . have been removed from the example projects and added to the project's .gitignore file. This minimizes the number of changes committed by PRs that modify the example projects, but does mean users will have to run flutter create . in each of the example project directories (see the README in the default example project).
- Most of the 264 files GitHub lists as "changed" are deleted files! Most were in the example project's ios and android directories! Please, don't let this large number stop you from reviewing this PR!

personalizedrefrigerator · 2020-02-17T06:21:29Z

Supporting multiple icon sets

The android.dart and ios.dart both support sets of different launcher icons (those with path specified instead of a boolean when support for the platform is enabled/disabled). web.dart does not support this.

Ways support might be added

Creation of a backup folder to where current icons are copied before replacement of the default icon set. This could permit saving favicon.png in addition to the files in the icons folder.
Overwrite favicon.png without saving it, but change the launcher icon folder to the new, requested folder assuming that favicon.png can be generated from the contents of the icons folder.

Suggestions are welcome!

bean5

This introduced app icon generation for web and also updated the example app. Although I'd like to see a lot of that introduced in a separate ticket, I understand why they were bundled here.

When I run the example, it works. However, when I run it on one of my own icons, android and ios work, but web gives this error:

RangeError (index): Index out of range: index must not be negative: -8
pub finished with exit code 2

bean5 · 2020-02-18T21:54:03Z

@personalizedrefrigerator This looks good to me, but I'm not approved to approve and merge. Also, I'm wondering why iOS and Android can handle my icon, but web cannot. Maybe I've formatted my main icon incorrectly?

personalizedrefrigerator · 2020-02-19T00:35:29Z

Fixed!

@bean5 Thank you! There was an error in web.dart's cropping code -- it didn't correctly crop images with greater heights than widths. I have fixed the issue and added tests for it.

…flutter_launcher_icons

bean5 · 2020-02-22T17:41:05Z

Looks good to me! Web build fine this time!

bean5 · 2020-02-22T17:41:50Z

@MarkOSullivan94 was there something you wanted changed before merging this?

…on 0.8.0. Please change this to a more-appliccable version if one exists!

MarkOSullivan94 · 2020-02-23T22:12:05Z

I actually haven't got round to testing out Flutter Web yet and feel merging this PR would require someone from the community to step up and keep an eye on any Web related issues / suggestions

Happy to merge in after reviewing this PR if either @bean5 or @personalizedrefrigerator be happy to do this?

personalizedrefrigerator · 2020-02-23T23:55:13Z

@MarkOSullivan94 I would be happy to help!

Consider Before Merging

Before merging this pull request, it might be worthwhile to consider adding support for custom output directories for web favicons and launcher icons.
As mentioned before, design suggestions related to this issue are welcome!
I assigned version code 0.8.0 to the new release. I originally commented that this version might be inappropriate, given the lack of breaking changes; however, I misstated the version code. I believe 0.8.0 is appropriate -- new functionality was added.

bean5 · 2020-02-25T00:11:01Z

@personalizedrefrigerator

7.5.0 would make more sense now that I know that the web cropping issue wasn't indicative of a compatibility issue.

bean5 · 2020-02-25T00:13:24Z

@MarkOSullivan94 whenever I start make a new project, I'm going to be generating an icon for web, so testing will happen naturally for web.

While for most projects I believe that a web branch/fork should exist until flutter supports web in their stable channel, I don't think that is necessary for this project because it is a dev dependency. I don't see any harm in merging this once the version number is revised to reflect that it is backwards-compatible (ie 7.*).

bean5 · 2020-02-25T00:14:28Z

@MarkOSullivan94 feel free to add me as a contributor if it helps. I can't commit to an official amount of time, but adding me shouldn't hurt anything. :)

personalizedrefrigerator · 2020-02-25T02:38:26Z

Whoops! My fault! The version code was 0.8.0 and 0.7.5, not 8.0.0 and 7.5.0! I support the switch to 0.8.0 but understand any wish to change this.

bean5 · 2020-02-26T20:31:12Z

Oh, 0.8.0 is fine. It shows backwards-compatibility.

LGTM

bean5 · 2020-03-05T02:05:53Z

Until this gets merged in, I'm relegated to using the fork instead. Just sayin'.

TheJulianJES · 2020-03-14T22:36:21Z

Love it, but I did get the following error when I tried it:

Overwriting web favicon and launcher icons...
FileSystemException: Cannot open file, path = 'web/icons/Icon-192.png' (OS Error: No such file or directory, errno = 2)

Creating the icons folder in the web directory fixed it though!

cocacrave · 2020-03-24T03:53:18Z

Does the web icon come out really pixelated for anyone else?
Comparing same size for android/ios vs web generated icons, they come out pixelated.
I'm using Flutter beta v1.15.17 on MacOS 10.15.3.

dev_dependencies:
  flutter_test:
    sdk: flutter
  flutter_launcher_icons: ^0.7.4

dependency_overrides:
  flutter_launcher_icons:
    git:
      url: https://github.com/personalizedrefrigerator/flutter_launcher_icons
      ref: master

Am I doing something wrong?

personalizedrefrigerator · 2020-03-25T18:08:24Z

Thanks! I'm looking into it! Are you referring to the favicon or all generated launcher icons? What are the dimensions of the icon you are attempting to distribute?

MarkOSullivan94

Left a couple of comments for you to check out!

Got a feeling it wont be long until this is merged 🙌

example/web/lib/main.dart

example/web/pubspec.yaml

lib/constants.dart

MarkOSullivan94 · 2020-11-22T19:49:31Z

lib/main.dart

+    {bool verbose, String cwd}) {
  verbose ??= false;
-  final String configFile = argResults[fileOption];
+  cwd ??= './';
+
+  String configFile = argResults[fileOption];
  final String fileOptionResult = argResults[fileOption];

+  if (configFile != null) {
+    configFile = path.join(cwd, configFile);
+  }


Nice catch!

It'd be worthwhile putting a brief explanation above the declaration of the loadConfigFileFromArgResults so others contributing will be made aware of why cwd parameter was added

lib/main.dart

MarkOSullivan94 · 2020-11-22T19:59:09Z

pubspec.yaml

@@ -14,4 +14,4 @@ environment:
  sdk: '>=2.3.0 <3.0.0'

 dev_dependencies:
-  test: ^1.11.1
+  test: '^1.11.1'


Yep this is definitely a good idea! Will add in the future 👍

personalizedrefrigerator · 2020-11-23T01:31:30Z

The new example projects are called default_example (flutter create . didn't work when called default for this one) and flavors_renameme

Wait, why have you needed to recreate the examples which were there before this PR?

GitHub's diff was showing every deleted file — I added copies of the old example projects to limit the size of the diff GitHub displays.

MarkOSullivan94 · 2020-11-23T20:03:47Z

GitHub's diff was showing every deleted file — I added copies of the old example projects to limit the size of the diff GitHub displays.

Size of the diff is fine don't worry 😃

lib/web.dart

MarkOSullivan94 · 2020-11-30T20:53:05Z

Last change I'd recommend: Probably best to go ahead and execute the flutter create . command in the web example

This would mean one less step to run the web example 🙂

Co-authored-by: Mark O'Sullivan <mos182@hotmail.co.uk>

…launcher_icons

personalizedrefrigerator · 2020-12-01T17:35:50Z

Done!

78 commits is a lot. Would you like me to try to clean up the commit history (i.e. using git reflog -i or similar)?

personalizedrefrigerator · 2020-12-01T17:40:36Z

At present, unlike the Android and iOS launcher icon generators, web.dart cannot be given an alternate icon path (e.g. web: favicon_test.png). I think this is better left as the topic of a followup PR.

Would you like me to try to add this functionality?

MarkOSullivan94 · 2020-12-01T19:14:00Z

Done!

78 commits is a lot. Would you like me to try to clean up the commit history (i.e. using git reflog -i or similar)?

Yep that would be appreciated!

At present, unlike the Android and iOS launcher icon generators, web.dart cannot be given an alternate icon path (e.g.
web: favicon_test.png). I think this is better left as the topic of a followup PR.

Would you like me to try to add this functionality?

I agree this is better to leave for a follow up PR

example/web/pubspec.yaml

Co-authored-by: Mark O'Sullivan <mos182@hotmail.co.uk>

MarkOSullivan94 · 2020-12-11T17:32:49Z

@personalizedrefrigerator heads up your commits removes some important files for the default example - guessing you done this before adjusting the .gitignore?

personalizedrefrigerator · 2020-12-12T07:21:41Z

@personalizedrefrigerator heads up your commits removes some important files for the default example - guessing you done this before adjusting the .gitignore?

I think the default example only needs pubspec.yaml, assets/images/ and README.md -- everything else is created by flutter create ..

MarkOSullivan94 · 2020-12-12T16:24:54Z

everything else is created by flutter create ..

Less steps needed for anyone to run the examples the better 🙂

bean5 · 2021-03-04T05:07:33Z

Flutter 2.0 was announced today. It officially supports web, Linux, and other platforms. At pub.dev this project promises to be compatible for web at but I don't think it is--unless this is a duplicate branch and it was already done.

I just checked. The default is not building for web.

How can I help get this done? What is blocking this from being finished up?

leithhobson · 2021-04-07T11:12:15Z

Flutter 2.0 was announced today. It officially supports web, Linux, and other platforms. At pub.dev this project promises to be compatible for web at but I don't think it is--unless this is a duplicate branch and it was already done.

I just checked. The default is not building for web.

How can I help get this done? What is blocking this from being finished up?

The package is stated as compatible as your web project will not be broken by it (in my understanding) however, it does not generate the web favicons.
Yes, it is certainly time that the web support feature is implemented.

Jwiggiff · 2021-05-07T19:31:18Z

Is there any update/progress on this? Is there anything I could do to help? Would really love some web support :)

personalizedrefrigerator · 2021-05-07T19:36:00Z

I haven't been using Flutter recently! I'll try to resolve conflicts for this PR (but might have to close it & open another -- resolving conflicts will probably involve a rebase and users of the fork may be having Flutter fetch a specific commit).

Edit: Sorry! I've been busier than expected recently. I hope to find time to do this over the weekend!

alcemirsantos · 2021-06-01T19:51:48Z

Just got here coming from Issue #126. I think it would be interesting to link the issue to this PR since they are definitely related and there are other user asking about this there.

personalizedrefrigerator · 2021-08-30T20:11:21Z

Closing in favor of #189

Transfer files from clone of main.

e3c57e7

personalizedrefrigerator requested a review from MarkOSullivan94 February 16, 2020 20:48

personalizedrefrigerator mentioned this pull request Feb 16, 2020

Web Icons #126

Closed

personalizedrefrigerator and others added 3 commits February 16, 2020 21:22

Usability fixes (docs, fail instead of overwrite, minor code style)

e97bbed

Fixed formatting in README.md

5f63be4

Added missing space to error message.

c5f3267

bean5 suggested changes Feb 18, 2020

View reviewed changes

personalizedrefrigerator and others added 5 commits February 18, 2020 18:29

Fixed cropping errors!

4936b65

Code cleanup.

3dd6e3e

Remove line break after "void main()" for consistency

72e7648

Revert initial icons in example directory to flutter defaults.

7fcbdab

Merge branch 'master' of https://github.com/personalizedrefrigerator/…

f5c1bb3

…flutter_launcher_icons

personalizedrefrigerator and others added 2 commits February 22, 2020 11:54

Updated README.md, CHANGELOG.md, and pubspec.yaml. Assigned new versi…

58aa619

…on 0.8.0. Please change this to a more-appliccable version if one exists!

Fix test description

8b0faff

MarkOSullivan94 reviewed Nov 22, 2020

View reviewed changes

personalizedrefrigerator added 4 commits November 22, 2020 21:04

Add example/lib/* to gitignore and remove lib/*.dart from examples.

0c44e85

Add example/*/test to .gitignore -- create . generates this

f41e49b

Run dartfmt & add generateWarning util function

ea242bb

Add trailing newline to generateWarning for better formatting

aa408a5

Remove duplicate examples

4b5431c

MarkOSullivan94 reviewed Nov 30, 2020

View reviewed changes

lib/web.dart Outdated Show resolved Hide resolved

personalizedrefrigerator and others added 3 commits November 30, 2020 13:59

Update lib/web.dart with suggestions from code review

4332fe7

Co-authored-by: Mark O'Sullivan <mos182@hotmail.co.uk>

Run flutter create . in example/web directory

da3faaa

Merge branch 'master' of github.com:personalizedrefrigerator/flutter_…

bc031de

…launcher_icons

MarkOSullivan94 reviewed Dec 1, 2020

View reviewed changes

example/web/pubspec.yaml Outdated Show resolved Hide resolved

personalizedrefrigerator and others added 2 commits December 1, 2020 13:01

Update example/web/pubspec.yaml

cb324c3

Co-authored-by: Mark O'Sullivan <mos182@hotmail.co.uk>

Delete android and ios directories in web example project.

79a835f

MarkOSullivan94 force-pushed the master branch from 5a060db to caffe34 Compare July 25, 2021 16:54

personalizedrefrigerator closed this Aug 30, 2021

Web Support and Refactoring #155

Web Support and Refactoring #155

Conversation

personalizedrefrigerator commented Feb 16, 2020 • edited

Overview

Summary of Changes

Notes

personalizedrefrigerator commented Feb 17, 2020 • edited

Supporting multiple icon sets

Ways support might be added

bean5 left a comment

Choose a reason for hiding this comment

bean5 commented Feb 18, 2020

personalizedrefrigerator commented Feb 19, 2020 • edited

Fixed!

bean5 commented Feb 22, 2020

bean5 commented Feb 22, 2020

MarkOSullivan94 commented Feb 23, 2020 • edited

personalizedrefrigerator commented Feb 23, 2020 • edited

Consider Before Merging

bean5 commented Feb 25, 2020

bean5 commented Feb 25, 2020

bean5 commented Feb 25, 2020

personalizedrefrigerator commented Feb 25, 2020

bean5 commented Feb 26, 2020

bean5 commented Mar 5, 2020

TheJulianJES commented Mar 14, 2020

cocacrave commented Mar 24, 2020

personalizedrefrigerator commented Mar 25, 2020 • edited

MarkOSullivan94 left a comment

Choose a reason for hiding this comment

MarkOSullivan94 Nov 22, 2020

Choose a reason for hiding this comment

MarkOSullivan94 Nov 22, 2020

Choose a reason for hiding this comment

personalizedrefrigerator commented Nov 23, 2020 • edited

MarkOSullivan94 commented Nov 23, 2020

MarkOSullivan94 commented Nov 30, 2020

personalizedrefrigerator commented Dec 1, 2020 • edited

personalizedrefrigerator commented Dec 1, 2020

MarkOSullivan94 commented Dec 1, 2020

MarkOSullivan94 commented Dec 11, 2020

personalizedrefrigerator commented Dec 12, 2020

MarkOSullivan94 commented Dec 12, 2020

bean5 commented Mar 4, 2021

leithhobson commented Apr 7, 2021 • edited

Jwiggiff commented May 7, 2021

personalizedrefrigerator commented May 7, 2021 • edited

alcemirsantos commented Jun 1, 2021

personalizedrefrigerator commented Aug 30, 2021

personalizedrefrigerator commented Feb 16, 2020 •

edited

personalizedrefrigerator commented Feb 17, 2020 •

edited

personalizedrefrigerator commented Feb 19, 2020 •

edited

MarkOSullivan94 commented Feb 23, 2020 •

edited

personalizedrefrigerator commented Feb 23, 2020 •

edited

personalizedrefrigerator commented Mar 25, 2020 •

edited

personalizedrefrigerator commented Nov 23, 2020 •

edited

personalizedrefrigerator commented Dec 1, 2020 •

edited

leithhobson commented Apr 7, 2021 •

edited

personalizedrefrigerator commented May 7, 2021 •

edited