Update the `flutter create -t plugin` document to reflect changes related to `--platforms` by cyanglaz · Pull Request #4344 · flutter/website

cyanglaz · 2020-07-15T17:41:54Z

Update the document to reflect changes in flutter/flutter#59507

Fixes flutter/flutter#61405

Update the document to reflect changes in flutter/flutter#59507

src/docs/development/packages-and-plugins/developing-packages.md

sfshaza2

Just a few things.

sfshaza2 · 2020-07-16T00:32:50Z

src/docs/development/packages-and-plugins/developing-packages.md

 To create a plugin package, use the `--template=plugin`
 flag with `flutter create`.

+Starting from flutter 1.20.0:


=> As of Flutter 1.20.0, use...

src/docs/development/packages-and-plugins/developing-packages.md

sfshaza2 · 2020-07-16T00:35:41Z

src/docs/development/packages-and-plugins/developing-packages.md

+Starting from flutter 1.20.0:
+Use the `--platforms` option to specify all the platforms that the plugin
+supports. Available platforms are: android, ios, web, linux, macos and windos.
+If no platforms are specified, a plugin project supports no platforms will be created.


=> If no platforms are specified, the resulting project doesn't support any platforms.

Really? This seems like a bug. :)

Done. Haha, it is intended. We don't want the user to accidentally create a plugin project supporting platforms that they don't want to support. We wanted to make it more explicit.

src/docs/development/packages-and-plugins/developing-packages.md

sfshaza2 · 2020-07-16T00:38:17Z

src/docs/development/packages-and-plugins/developing-packages.md

 ```
 ```terminal
-$ flutter create --template=plugin -a java hello
+$ flutter create --template=plugin --platforms=android,ios -a java hello


So, ALL of these examples use Android and iOS. Could we mix it up a bit?

By reading the paragraph above, I thought these examples are to teach users to choose programming languages for android and iOS. So in that case, we should only use Android and iOS here.
However, we can add some examples to the above paragraph that explains the --platforms flag. Those examples can have different platforms just to explain the flag. WDYT?

Oops. Yeah, that's what I get for just looking at the trees, not the forest.

src/docs/development/packages-and-plugins/developing-packages.md

sfshaza2 · 2020-07-16T00:40:10Z

src/docs/development/packages-and-plugins/developing-packages.md


+### Add support to new platforms in an existing plugin project
+
+To support new platforms in an existing plugin project, run `flutter create` with


=> To add support for specific platforms to an existing ...

src/docs/development/packages-and-plugins/developing-packages.md

cyanglaz

@jmagman @sfshaza2 Thanks for the quick review, I updated the PR per your comments. PTAL.

cyanglaz · 2020-07-16T17:51:55Z

src/docs/development/packages-and-plugins/developing-packages.md

 To create a plugin package, use the `--template=plugin`
 flag with `flutter create`.

+Starting from flutter 1.20.0:


src/docs/development/packages-and-plugins/developing-packages.md

cyanglaz · 2020-07-16T17:54:56Z

src/docs/development/packages-and-plugins/developing-packages.md

+Starting from flutter 1.20.0:
+Use the `--platforms` option to specify all the platforms that the plugin
+supports. Available platforms are: android, ios, web, linux, macos and windos.
+If no platforms are specified, a plugin project supports no platforms will be created.


Done. Haha, it is intended. We don't want the user to accidentally create a plugin project supporting platforms that they don't want to support. We wanted to make it more explicit.

cyanglaz · 2020-07-16T18:04:12Z

src/docs/development/packages-and-plugins/developing-packages.md

 ```
 ```terminal
-$ flutter create --template=plugin -a java hello
+$ flutter create --template=plugin --platforms=android,ios -a java hello


By reading the paragraph above, I thought these examples are to teach users to choose programming languages for android and iOS. So in that case, we should only use Android and iOS here.
However, we can add some examples to the above paragraph that explains the --platforms flag. Those examples can have different platforms just to explain the flag. WDYT?

cyanglaz · 2020-07-16T18:05:29Z

src/docs/development/packages-and-plugins/developing-packages.md


+### Add support to new platforms in an existing plugin project
+
+To support new platforms in an existing plugin project, run `flutter create` with


src/docs/development/packages-and-plugins/developing-packages.md

Review

jmagman

LGTM with nit once @sfshaza2 is happy.

jmagman · 2020-07-16T18:33:53Z

src/docs/development/packages-and-plugins/developing-packages.md

-supports. Available platforms are: android, ios, web, linux, macos and windos.
-If no platforms are specified, a plugin project supports no platforms will be created.
+As of Flutter 1.20.0, Use the `--platforms=` option followed by a comma separated list to 
+specify the platforms that the plugin supports. Available platforms are: android, ios, web, linux, macos, and windows.


Can we put the platforms in ticks so people know they are exact strings?
android, ios, web, linux, macos, and windows.

sfshaza2

LGTM!

sfshaza2 · 2020-07-21T14:39:27Z

src/docs/development/packages-and-plugins/developing-packages.md

 ```
 ```terminal
-$ flutter create --org com.example --template=plugin -a java hello
+$ flutter create --org com.example --template=plugin --platforms=android,ios -a java hello


Just making sure. It's -a java hello but -i objc hello?

sfshaza2 · 2020-07-21T14:39:58Z

src/docs/development/packages-and-plugins/developing-packages.md

 ```
 ```terminal
-$ flutter create --template=plugin -a java hello
+$ flutter create --template=plugin --platforms=android,ios -a java hello


Oops. Yeah, that's what I get for just looking at the trees, not the forest.

…ated to `--platforms` (flutter#4344) * Update developing-packages.md Update the document to reflect changes in flutter/flutter#59507 * Update developing-packages.md Review * Update developing-packages.md

Update developing-packages.md

446e93e

Update the document to reflect changes in flutter/flutter#59507

googlebot added the cla: yes Contributor has signed the Contributor License Agreement label Jul 15, 2020

cyanglaz requested review from jmagman and sfshaza2 July 15, 2020 17:42

jmagman reviewed Jul 15, 2020

View reviewed changes

src/docs/development/packages-and-plugins/developing-packages.md Show resolved Hide resolved

sfshaza2 reviewed Jul 16, 2020

View reviewed changes

cyanglaz commented Jul 16, 2020

View reviewed changes

Update developing-packages.md

7d72f5d

Review

jmagman approved these changes Jul 16, 2020

View reviewed changes

Update developing-packages.md

63a114a

sfshaza2 approved these changes Jul 21, 2020

View reviewed changes

sfshaza2 merged commit 5f5f475 into flutter:master Jul 21, 2020

JuYeong0413 mentioned this pull request Jul 21, 2020

Update flutter.dev for the new flutter create -t plugin --platforms command` #4319

Closed


		### Add support to new platforms in an existing plugin project

		To support new platforms in an existing plugin project, run `flutter create` with

Conversation

cyanglaz commented Jul 15, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cyanglaz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jmagman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

cyanglaz commented Jul 15, 2020 •

edited

Loading