Add a more complete app template for Flutter (skeleton) #83530

filiph · 2021-05-28T00:23:02Z

This is another stab at landing #76519, which was closed in March. The code is nearly identical, except:

The template is now null safe
The change is rebased to latest Flutter
The change will depend on flutter_template_images version 4.0.0 (when [flutter_template_images] Support the new skeleton app template packages#366 lands)

The following is a direct copypaste from #76519, which was authored by @brianegan:

Summary

I've worked with @filiph to develop a new template application that includes two features: A static list / detail feature and a dynamic settings feature. When a user changes the Theme in the settings screen, the application responds in kind.

The template takes the following notable approaches. Reasons behind each feature / approach is documented in the "New Flutter Template: Final Decisions" document.

The template targets Intermediate Flutter developers. "Intermediate Flutter Developer" is defined by the "Flutter Learning Journey's" document.
Generally follows the Simple App State Management guide, using a ChangeNotifier to coordinate multiple Widgets.
Includes an analysis_options.yaml file
Generates localizations by default using arb files.
Includes an example image and establishes 1x, 2x and 3x folders for image assets.
Uses a "feature-first" folder organization
Navigator 1.0 with pushNamed for Navigation

Approach

Spent one week on research and competitive analysis. This involved recruiting and interviewing beginner to intermediate Flutter developers to determine their current learning targets and needs. Furthermore, I reviewed popular architecture and state management libraries from the Flutter community to determine the current advice and best practices offered by the Flutter ecosystem. Finally, I researched templates from "competing" frameworks, such as Android, iOS, Xamarin, React and Angular to see what similar frameworks offer in regards to templates. This research has been compiled into the "New Flutter Template: Research and Competitive Analysis" Google doc that informed our subsequent work. Please note: This document includes some notes from the user interviews. It does not contain any personally revealing information, but to ensure privacy, I've restricted access to this document.
Next, I spent 3 weeks coding up various approaches. This resulted in the creation of ~25 different potential templates. From these evaluations we learned the different types of decisions we need to make for a final template. For example: What should the template do? Should it include localization? Logging? Responsive Breakpoints? Etc.
We then asked for more community feedback on these decisions. We used this feedback + all of the information gathered in our previous steps to make our final decisions. The decisions we've reached are documented in the "New Flutter Template: Final Decisions" document.
Now, we've taken those decisions and distilled them into this template proposal!

Preview

simplescreenrecorder-2021-02-22_15.27.52.mp4

simplescreenrecorder-2021-02-26_17.11.23.mp4

Pre-launch Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I signed the [CLA].
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt.
All existing and new tests are passing.

google-cla · 2021-05-28T00:23:40Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-05-28T00:28:00Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-06-01T19:00:40Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-06-01T19:06:28Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-06-01T20:08:42Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-06-01T23:16:36Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

filiph · 2021-06-01T23:33:30Z

This is ready for re-review. Some notes:

This is an updated version of Proposal: A more complete app template for Flutter #76519, which already got LGTM from @goderbauer, @zanderso, @Hixie, @csells.
Still, I'd like someone to go over the final product, including my changes:
- The template is now null safe
- The change is rebased to latest Flutter (~3 months of development)
The change will fail CI until I also land [flutter_template_images] Support the new skeleton app template packages#366. In the original PR, @stuartmorgan asks not to land the flutter/packages change until this one is fully approved and ready to land.

Also, @brianegan, can I ask you to reply @googlebot I consent. here, please?

google-cla · 2021-06-01T23:34:04Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

csells · 2021-06-02T13:52:15Z

lgtm

packages/flutter_tools/templates/skeleton/lib/src/app.dart.tmpl

HansMuller · 2021-06-02T17:48:53Z

Maybe Dummy isn't the best prefix. Stub or proxy might be better.

Hixie · 2021-06-02T23:34:53Z

packages/flutter_tools/lib/src/commands/create.dart

This should end with a period. If the tests didn't catch it, we should update the tests.

Fixed.

Do you know which tests would catch this? I'm unable to run some of the tests locally, and due to the multi-package nature of this change, I can't see all the test results until 1) this CL is approved, 2) I land the flutter/packages change, 3) I re-run this tests on this change.

packages/flutter_tools/templates/skeleton/lib/src/dummy_feature/dummy_item.dart.tmpl

Hixie · 2021-06-02T23:38:18Z

packages/flutter_tools/templates/skeleton/pubspec.yaml.tmpl

there are a lot fewer comments in this file than in the main template's pubspec.yaml, is that intended?

This is intentional: I thought it's okay since this template is focused on intermediate users who "just want to start an app". But I don't have a strong opinion here, and can easily revert back. Let me know.

Aside: When the comments are back, 95% of the lines in this file are the same as in the main template (we're just actually using assets: here). I was looking at ways to make this DRY, but it would just make bind this new template to create_base.dart with something like withPluginHook.

google-cla · 2021-06-03T17:56:45Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-06-03T17:58:30Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-06-03T18:12:13Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-06-03T18:14:54Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-06-03T18:24:06Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

goderbauer

The template LGTM

google-cla · 2021-06-03T18:30:11Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

filiph · 2021-06-03T19:13:21Z

Renamed Dummy* to Sample*. Thanks for the naming idea, @Hixie, I really like it.

Removes the attempt to depend on filiph’s fork, it breaks CI.

frankhasen · 2021-09-10T11:01:26Z

I would be very happy if the template would implement the Navigator 2.

Add00w · 2022-07-26T13:31:24Z

I would be very happy if the template would implement the Navigator 2.

with bottom navigation too.

stuartmorgan-g · 2022-07-26T13:44:15Z

This PR has been closed since last year; the place to file new enhancement requests is the issue tracker.

flutter-dashboard bot added c: contributor-productivity Team-specific productivity, code health, technical debt. tool Affects the "flutter" command-line tool. See also t: labels. labels May 28, 2021

google-cla bot added the cla: no label May 28, 2021

filiph force-pushed the list_detail_app_template_reland branch from b58c525 to a03b20c Compare June 1, 2021 19:00

filiph force-pushed the list_detail_app_template_reland branch from 6f89825 to a2f51c6 Compare June 1, 2021 23:16

filiph changed the title ~~[WIP] Add a more complete app template for Flutter (skeleton)~~ Add a more complete app template for Flutter (skeleton) Jun 1, 2021

filiph mentioned this pull request Jun 1, 2021

Proposal: A more complete app template for Flutter #76519

Closed

8 tasks

goderbauer reviewed Jun 2, 2021

View reviewed changes

packages/flutter_tools/templates/skeleton/lib/src/app.dart.tmpl Outdated Show resolved Hide resolved

Hixie reviewed Jun 2, 2021

View reviewed changes

packages/flutter_tools/templates/skeleton/lib/src/dummy_feature/dummy_item.dart.tmpl Outdated Show resolved Hide resolved

Hixie reviewed Jun 2, 2021

View reviewed changes

filiph force-pushed the list_detail_app_template_reland branch from 1234086 to 99eb93b Compare June 3, 2021 18:14

goderbauer reviewed Jun 3, 2021

View reviewed changes

brianegan and others added 15 commits June 28, 2021 12:18

Rename list_detail_app to skeleton

ab6043e

Fix null safety

cf44f8a

Fix skeleton app

76e57b5

Move shared files to app_shared

07cb848

Simplify pubspec.yaml

93375f7

Depend on (yet non-existent) 4.0.0 of images

ffa3b4c

Removes the attempt to depend on filiph’s fork, it breaks CI.

Conform localization code to best practices

33d69f4

Add missing period

88b896a

Put const up

3bbfc57

Rename DummyFeature to SampleFeature

1f7b0ea

Update manifest.json with latest change

67f7a75

Remove the remaining references to dummy_feature

659f633

Fix re-added argument

2bab3c7

Set generateSyntheticPackage to true on create

c5c113f

Run flutter update-packages

34807d4

filiph force-pushed the list_detail_app_template_reland branch from 9a80722 to 34807d4 Compare June 28, 2021 19:19

filiph added 3 commits June 28, 2021 12:48

Remove trailing space

a76d351

Fix template_manifest.json

ad288dd

Actually upgrade the dependency on packages

aaa83a2

filiph added the waiting for tree to go green label Jun 28, 2021

fluttergithubbot merged commit 76d5e62 into flutter:master Jun 28, 2021

filiph deleted the list_detail_app_template_reland branch June 28, 2021 22:30

christopherfujino mentioned this pull request Jul 1, 2021

Add loading indicator web template #85464

Closed

8 tasks

stevemessick mentioned this pull request Sep 10, 2021

Add support for the new Flutter project template flutter/flutter-intellij#5281

Closed

joshuadeguzman mentioned this pull request Jul 16, 2022

Add games toolkit to the Flutter templates #107768

Closed

Add a more complete app template for Flutter (skeleton) #83530

Add a more complete app template for Flutter (skeleton) #83530

Uh oh!

Conversation

filiph commented May 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Approach

Preview

Pre-launch Checklist

Uh oh!

google-cla bot commented May 28, 2021

Uh oh!

google-cla bot commented May 28, 2021

Uh oh!

google-cla bot commented Jun 1, 2021

Uh oh!

google-cla bot commented Jun 1, 2021

Uh oh!

google-cla bot commented Jun 1, 2021

Uh oh!

google-cla bot commented Jun 1, 2021

Uh oh!

filiph commented Jun 1, 2021

Uh oh!

google-cla bot commented Jun 1, 2021

Uh oh!

csells commented Jun 2, 2021

Uh oh!

Uh oh!

HansMuller commented Jun 2, 2021

Uh oh!

Hixie Jun 2, 2021

Choose a reason for hiding this comment

Uh oh!

filiph Jun 3, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Hixie Jun 2, 2021

Choose a reason for hiding this comment

Uh oh!

filiph Jun 3, 2021

Choose a reason for hiding this comment

Uh oh!

google-cla bot commented Jun 3, 2021

Uh oh!

google-cla bot commented Jun 3, 2021

Uh oh!

google-cla bot commented Jun 3, 2021

Uh oh!

google-cla bot commented Jun 3, 2021

Uh oh!

google-cla bot commented Jun 3, 2021

Uh oh!

goderbauer left a comment

Choose a reason for hiding this comment

Uh oh!

google-cla bot commented Jun 3, 2021

Uh oh!

filiph commented Jun 3, 2021

Uh oh!

frankhasen commented Sep 10, 2021

Uh oh!

Add00w commented Jul 26, 2022

Uh oh!

stuartmorgan-g commented Jul 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

filiph commented May 28, 2021 •

edited

Loading