Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the template plugin example depend on the plugin as a real dependency #50485

Merged
merged 2 commits into from Feb 11, 2020

Conversation

amirh
Copy link
Contributor

@amirh amirh commented Feb 10, 2020

Description

The template for the example plugin app was adding the path dependency to the parent plugin as a dev_dependency.
When the plugin template was introduced in #9076 this was the case depending whether the example app was created with a driver test, #11304 made this the case unconditionally.

The example app builds with the plugin as either a real dependency or dev_dependency as the semantic difference between the two only applies to transitive dependencies (Pub Dev Dependencies). Though it still violates the convention where stuff that's imported from lib/ is a real dependency.

Tests

  • Verify that the pubspec for the example app that's generated as part of the plugin template has a real dependency on the parent plugin.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

  • No, no existing tests failed, so this is not a breaking change.
  • Yes, this is a breaking change. If not, delete the remainder of this section.
    • I wrote a design doc: https://flutter.dev/go/template Replace this with a link to your design doc's short link
    • I got input from the developer relations team, specifically from: Replace with the names of who gave advice
    • I wrote a migration guide: Replace with a link to your migration guide

@fluttergithubbot fluttergithubbot added the tool Affects the "flutter" command-line tool. See also t: labels. label Feb 10, 2020
@amirh amirh changed the title Make plugin example depend on the plugin as a real dependency Make the template plugin example depend on the plugin as a real dependency Feb 10, 2020
@jmagman
Copy link
Member

jmagman commented Feb 10, 2020

Is there an issue tracking first-party plugin example projects getting this change? Would be nice to prove everything is working there as well.

@jmagman jmagman added this to Awaiting triage in Tools - flutter create review via automation Feb 10, 2020
@jmagman jmagman added this to Awaiting triage in Tools - plugin and package support review via automation Feb 10, 2020
@amirh
Copy link
Contributor Author

amirh commented Feb 10, 2020

@jmagman most first party plugins are including the plugin as a real dependency in the example app already, e.g: https://github.com/flutter/plugins/blob/9859a383c7d15966eb9165f2616afeb4ee53129a/packages/image_picker/example/pubspec.yaml#L9

Copy link
Contributor

@harryterkelsen harryterkelsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fluttergithubbot fluttergithubbot merged commit bcef4ed into flutter:master Feb 11, 2020
Tools - plugin and package support review automation moved this from Awaiting triage to Engineer reviewed Feb 11, 2020
Tools - flutter create review automation moved this from Awaiting triage to Engineer reviewed Feb 11, 2020
@amirh amirh deleted the plugin_example_dep branch February 11, 2020 00:05
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
tool Affects the "flutter" command-line tool. See also t: labels.
Projects
Tools - flutter create review
  
Engineer reviewed
Development

Successfully merging this pull request may close these issues.

None yet

5 participants