Check for bad characters in path on Windows build #107949

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.

Sign up for GitHub

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

Jump to bottom

Merged

yaakovschectman merged 7 commits into flutter:master from yaakovschectman:bad_path_chars

Jul 20, 2022

Contributor

yaakovschectman commented Jul 19, 2022 •

edited

Loading

When running a flutter application for windows in a directory that includes certain problematic characters, e.g. apostrophe('), visual studio would fail and give the fairly unhelpful error message:
error MSB4100: Expected "$([System.String]::new('%(Link.AdditionalDependencies)').Contains('atls.lib'))" to evaluate to a boolean instead of "$([System.String]
The build function for Windows now performs a check of the directory for a list of issue-raising characters which, if found, displays a more intuitive error message after exiting early:
Path ... contains invalid characters in "\'#!\$^&*=|,;<>?". Please rename your directory so as to not include any of these characters and retry.

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 this PR is [test-exempt].
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on [Discord].

yaakovschectman added 2 commits

July 19, 2022 11:21


          Check for bad characters in path on Windows build

f39d40e


          Doc comments

e48ded5

yaakovschectman added the platform-windows label

yaakovschectman requested review from cbracken, gspencergoog, loic-sharma and stuartmorgan-g

July 19, 2022 18:35

yaakovschectman self-assigned this

flutter-dashboard bot added the tool label

christopherfujino reviewed

View reviewed changes

packages/flutter_tools/lib/src/windows/build_windows.dart Outdated Show resolved Hide resolved

christopherfujino reviewed

View reviewed changes

packages/flutter_tools/test/commands.shard/hermetic/build_windows_test.dart Show resolved Hide resolved


          Fix formatting

00c8310

yaakovschectman marked this pull request as ready for review

July 19, 2022 18:49

christopherfujino reviewed

View reviewed changes

packages/flutter_tools/lib/src/windows/build_windows.dart Show resolved Hide resolved

christopherfujino reviewed

View reviewed changes

packages/flutter_tools/lib/src/windows/build_windows.dart Outdated Show resolved Hide resolved

christopherfujino reviewed

View reviewed changes

packages/flutter_tools/lib/src/windows/build_windows.dart Outdated Show resolved Hide resolved

christopherfujino reviewed

View reviewed changes

packages/flutter_tools/test/commands.shard/hermetic/build_windows_test.dart Outdated Show resolved Hide resolved

christopherfujino reviewed

View reviewed changes

packages/flutter_tools/test/commands.shard/hermetic/build_windows_test.dart Show resolved Hide resolved


          Commenting/formatting

93d2eb7

loic-sharma reviewed

View reviewed changes

packages/flutter_tools/test/commands.shard/hermetic/build_windows_test.dart Outdated Show resolved Hide resolved

loic-sharma reviewed

View reviewed changes

packages/flutter_tools/test/commands.shard/hermetic/build_windows_test.dart Outdated Show resolved Hide resolved


          Link to issue in comment

5a29270

loic-sharma reviewed

View reviewed changes

packages/flutter_tools/lib/src/windows/build_windows.dart Show resolved Hide resolved


          Comments, formatting

0825f2f

loic-sharma reviewed

View reviewed changes

packages/flutter_tools/lib/src/windows/build_windows.dart Outdated Show resolved Hide resolved


          Global var rename

9a9a294

loic-sharma approved these changes

View reviewed changes

Member

loic-sharma left a comment

Looks good, nice work!

yaakovschectman merged commit 1e2be6e into flutter:master

yaakovschectman deleted the bad_path_chars branch

July 20, 2022 18:05

engine-flutter-autoroll mentioned this pull request

Roll Flutter from bbec650b64bc to 1e2be6ed5492 (89 revisions) flutter/packages#2345

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

5cec76a

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

e706a45

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

c976e10

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

695e802

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

6e64f84

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

751c303

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

3ee1163

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

382d663

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

3b7b635

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

1b52655

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

fb20224

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

1f7e0bc

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

64cefab

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

34ff0fa

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

492f09f

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

2068caa

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

4978df9

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

4c47d14

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

4163ea4

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

54c688e

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

fa8f27a

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

7394e29

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

956f562

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

dabb8e3

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

1dad88b

…utter#107949)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          1e2be6e Check for bad characters in path on Windows build (flutter/fl…

f032c3d

…utter#107949)

camsim99 pushed a commit to camsim99/flutter that referenced this pull request


          Check for bad characters in path on Windows build (flutter#107949)

049eabf

* Check for bad characters in path on Windows build

* Doc comments

* Fix formatting

* Commenting/formatting

* Link to issue in comment

* Comments, formatting

* Global var rename

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

loic-sharma loic-sharma approved these changes

stuartmorgan-g Awaiting requested review from stuartmorgan-g

cbracken Awaiting requested review from cbracken

gspencergoog Awaiting requested review from gspencergoog

+1 more reviewer

christopherfujino christopherfujino left review comments

Labels

platform-windows tool