Skip to content

Always escape when writing pubspec.yaml's 'description' field.#130096

Merged
auto-submit[bot] merged 1 commit intoflutter:masterfrom
matanlurey:escape-pubspec-description
Jul 13, 2023
Merged

Always escape when writing pubspec.yaml's 'description' field.#130096
auto-submit[bot] merged 1 commit intoflutter:masterfrom
matanlurey:escape-pubspec-description

Conversation

@matanlurey
Copy link
Contributor

@matanlurey matanlurey commented Jul 6, 2023

Closes #80013.

Before:

$ flutter create test1 --description "a: b"
Creating project test1...
Error detected in pubspec.yaml:
Error on line 2, column 15: Mapping values are not allowed here. Did you miss a colon earlier?
  ╷
2 │ description: a: b
  │               ^
  ╵
Please correct the pubspec.yaml file at /Users/matan/Developer/scratch/test1/pubspec.yaml

After:

$ flutter create test1 --description "a: b"
Creating project test1...
Resolving dependencies in test1... 
Got dependencies in test1.
Wrote 129 files.

All done!
You can find general documentation for Flutter at: https://docs.flutter.dev/
Detailed API documentation is available at: https://api.flutter.dev/
If you prefer video documentation, consider: https://www.youtube.com/c/flutterdev

In order to run your application, type:

  $ cd test1
  $ flutter run

Your application code is in test1/lib/main.dart.

It's worth noting that this always escapes a non-empty project description, which means that descriptions that were not previously wrapped in "s' will be. I'm not sure how worth it is to do a conditional escape (i.e. only escape if not escaping would cause a problem), but willing to change.

Side-note: I had no idea where to list this test in the (very large) create_test.dart, so I did my best :)

@github-actions github-actions bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Jul 6, 2023
christopherfujino
christopherfujino approved these changes Jul 13, 2023
View reviewed changes
Copy link
Contributor

@christopherfujino christopherfujino left a comment

Choose a reason for hiding this comment

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

LGTM

andrewkolos
andrewkolos approved these changes Jul 13, 2023
View reviewed changes
Copy link
Contributor

@andrewkolos andrewkolos left a comment

Choose a reason for hiding this comment

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

LGTM

@andrewkolos andrewkolos added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 13, 2023
@matanlurey
Copy link
Contributor Author

matanlurey commented Jul 13, 2023

Thanks!

@christopherfujino
Copy link
Contributor

christopherfujino commented Jul 13, 2023

@matanlurey btw, you needed two org member approvals and for one of them to add the autosubmit label because you are not a flutter GitHub org member. Would you like me to nominate you for membership? The process is: https://github.com/flutter/flutter/wiki/Contributor-access

@auto-submit auto-submit bot merged commit 0374905 into flutter:master Jul 13, 2023
@matanlurey matanlurey deleted the escape-pubspec-description branch July 13, 2023 23:02
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
468c8c7 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
c4a99af 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
7327066 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
fc2a54e 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
9307742 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
4397817 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
ce27dab 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
d294481 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 14, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 14, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
38c29ac 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 15, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 15, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
b092e75 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 15, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 15, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
a3fdf57 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 15, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 15, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
cc8e0aa 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 16, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 16, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
f5bf100 
flutter/flutter#130096)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 16, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 16, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
6ab91da 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 17, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
a8af0a0 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 17, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
254d7cf 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 17, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
4a9f5e2 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 17, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
0b42604 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 17, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
d358ea2 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 17, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
493efe5 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 17, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
014e85c 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 17, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
0b44ad9 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
650232d 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
7df1d25 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
b973708 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
ed5a80e 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
c0509d1 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
6ae83fc 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
08add41 
flutter/flutter#130096)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2023
@engine-flutter-autoroll
0374905 Always escape when writing pubspec.yaml's 'description' field. (
1ce11f3 
flutter/flutter#130096)
LouiseHsu pushed a commit to LouiseHsu/flutter that referenced this pull request Jul 31, 2023
@matanlurey @LouiseHsu
Always escape when writing pubspec.yaml's 'description' field. (flutt…
92413fa 
…er#130096)

Closes flutter#80013.

**Before**:

```
$ flutter create test1 --description "a: b"
Creating project test1...
Error detected in pubspec.yaml:
Error on line 2, column 15: Mapping values are not allowed here. Did you miss a colon earlier?
  �
2 � description: a: b
  �               ^
  �
Please correct the pubspec.yaml file at /Users/matan/Developer/scratch/test1/pubspec.yaml
```

**After**:

```
$ flutter create test1 --description "a: b"
Creating project test1...
Resolving dependencies in test1... 
Got dependencies in test1.
Wrote 129 files.

All done!
You can find general documentation for Flutter at: https://docs.flutter.dev/
Detailed API documentation is available at: https://api.flutter.dev/
If you prefer video documentation, consider: https://www.youtube.com/c/flutterdev

In order to run your application, type:

  $ cd test1
  $ flutter run

Your application code is in test1/lib/main.dart.
```

---

It's worth noting that this _always_ escapes a non-empty project description, which means that descriptions that were not previously wrapped in `"`s' will be. I'm not sure how worth it is to do a _conditional_ escape (i.e. only escape if not escaping would cause a problem), but willing to change.

Side-note: I had no idea where to list this test in the (very large) `create_test.dart`, so I did my best :)
@TahaTesser TahaTesser mentioned this pull request Aug 3, 2023
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@andrewkolos andrewkolos andrewkolos approved these changes

+1 more reviewer

@christopherfujino christopherfujino christopherfujino approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App tool Affects the "flutter" command-line tool. See also t: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Colons in flutter create --description don't get escaped in pubspec.yaml

3 participants

@matanlurey @christopherfujino @andrewkolos