--fatal-warnings is not listed when requesting --help for flutter run/build/test #119636
Description
When requesting help for the flutter build apk command, the --fatal-warnings flag is not listed.
The same thing applies to flutter run --help & flutter test --help, despite the flag being supported for those modes. (See the description in #92031, which added the option to the tooling)
Therefor developers won't know that it is supported, nor does the flag have any explanation of what it does.
Steps to Reproduce
- Run
flutter create bug - Run
flutter build apk --help - The option
--fatal-warningsis not listed in the help output, despiteflutter build apk --fatal-warningsbeing a valid command.
Expected results
The help section should list an entry for --fatal-warnings, which explains what the flag does. Ideally it also explains exactly what is regarded as a warning. I.e. does it only consider stderr or also other things?
Actual results
--fatal-warnings is not listed in the help section.
Logs
Logs
Example of an app that produces a fatal warning with --fatal-warnings (for reference)
navaronbracke@MacBook-Pro-van-Navaron weforza % flutter build apk --fatal-warnings
💪 Building with sound null safety 💪
Note: /Users/navaronbracke/.pub-cache/hosted/pub.dev/flutter_blue_plus-1.3.1/android/src/main/java/com/boskokg/flutter_blue_plus/FlutterBluePlusPlugin.java uses or overrides a deprecated API.
Note: Recompile with -Xlint:deprecation for details.
Running Gradle task 'assembleRelease'... 79.7s
✓ Built build/app/outputs/flutter-apk/app-release.apk (22.2MB).
Logger received error output during the run, and "--fatal-warnings" is enabled.
Output of running --help:
navaronbracke@MacBook-Pro-van-Navaron weforza % flutter build apk --help
Build an Android APK file from your app.
This command can build debug and release versions of your application. 'debug' builds support debugging and a quick development cycle. 'release' builds don't support debugging and are suitable for deploying to app stores. If you are deploying the app to the Play Store, it's recommended to use app bundles or split the APK to reduce the APK size. Learn more at:
* https://developer.android.com/guide/app-bundle
* https://developer.android.com/studio/build/configure-apk-splits#configure-abi-split
Global options:
-h, --help Print this usage information.
-v, --verbose Noisy logging, including all shell commands executed.
If used with "--help", shows hidden options. If used with "flutter doctor", shows additional diagnostic
information. (Use "-vv" to force verbose logging in those cases.)
-d, --device-id Target device id or name (prefixes allowed).
--version Reports the version of this tool.
--suppress-analytics Suppress analytics reporting when this command runs.
Usage: flutter build apk [arguments]
-h, --help Print this usage information.
--[no-]tree-shake-icons Tree shake icon fonts so that only glyphs used by the application remain.
(defaults to on)
-t, --target=<path> The main entry-point file of the application, as run on the device.
If the "--target" option is omitted, but a file name is provided on the command line,
then that is used instead.
(defaults to "lib/main.dart")
--debug Build a debug version of your app.
--profile Build a version of your app specialized for performance profiling.
--release Build a release version of your app (default mode).
--flavor Build a custom app flavor as defined by platform-specific build setup.
Supports the use of product flavors in Android Gradle scripts, and the use of custom
Xcode schemes.
--[no-]pub Whether to run "flutter pub get" before executing this command.
(defaults to on)
--build-number An identifier used as an internal version number.
Each build must have a unique identifier to differentiate it from previous builds.
It is used to determine whether one build is more recent than another, with higher
numbers indicating more recent build.
On Android it is used as "versionCode".
On Xcode builds it is used as "CFBundleVersion".
On Windows it is used as the build suffix for the product and file versions.
--build-name=<x.y.z> A "x.y.z" string used as the version number shown to users.
For each new version of your app, you will provide a version number to differentiate
it from previous versions.
On Android it is used as "versionName".
On Xcode builds it is used as "CFBundleShortVersionString".
On Windows it is used as the major, minor, and patch parts of the product and file
versions.
--split-debug-info=<v1.2.3/> In a release build, this flag reduces application size by storing Dart program
symbols in a separate file on the host rather than in the application. The value of
the flag should be a directory where program symbol files can be stored for later
use. These symbol files contain the information needed to symbolize Dart stack
traces. For an app built with this flag, the "flutter symbolize" command with the
right program symbol file is required to obtain a human readable stack trace.
This flag cannot be combined with "--analyze-size".
--[no-]obfuscate In a release build, this flag removes identifiers and replaces them with randomized
values for the purposes of source code obfuscation. This flag must always be combined
with "--split-debug-info" option, the mapping between the values and the original
identifiers is stored in the symbol map created in the specified directory. For an
app built with this flag, the "flutter symbolize" command with the right program
symbol file is required to obtain a human readable stack trace.
Because all identifiers are renamed, methods like Object.runtimeType, Type.toString,
Enum.toString, Stacktrace.toString, Symbol.toString (for constant symbols or those
generated by runtime system) will return obfuscated results. Any code or tests that
rely on exact names will break.
--dart-define=<foo=bar> Additional key-value pairs that will be available as constants from the
String.fromEnvironment, bool.fromEnvironment, int.fromEnvironment, and
double.fromEnvironment constructors.
Multiple defines can be passed by repeating "--dart-define" multiple times.
--dart-define-from-file=<use-define-config.json> The path of a json format file where flutter define a global constant pool. Json
entry will be available as constants from the String.fromEnvironment,
bool.fromEnvironment, int.fromEnvironment, and double.fromEnvironment constructors;
the key and field are json values.
--[no-]null-assertions Perform additional null assertions on the boundaries of migrated and un-migrated
code. This setting is not currently supported on desktop devices.
--[no-]analyze-size Whether to produce additional profile information for artifact output size. This flag
is only supported on "--release" builds. When building for Android, a single ABI must
be specified at a time with the "--target-platform" flag. When building for iOS, only
the symbols from the arm64 architecture are used to analyze code size.
By default, the intermediate output files will be placed in a transient directory in
the build directory. This can be overridden with the "--code-size-directory" option.
This flag cannot be combined with "--split-debug-info".
--code-size-directory The location to write code size analysis files. If this is not specified, files are
written to a temporary directory under the build directory.
-P, --android-project-arg Additional arguments specified as key=value that are passed directly to the gradle
project via the -P flag. These can be accessed in build.gradle via the
"project.property" API.
--[no-]multidex When enabled, indicates that the app should be built with multidex support. This flag
adds the dependencies for multidex when the minimum android sdk is 20 or below. For
android sdk versions 21 and above, multidex support is native.
(defaults to on)
--ignore-deprecation Indicates that the app should ignore deprecation warnings and continue to build using
deprecated APIs. Use of this flag may cause your app to fail to build when deprecated
APIs are removed.
--split-per-abi Whether to split the APKs per ABIs. To learn more, see:
https://developer.android.com/studio/build/configure-apk-splits#configure-abi-split
--target-platform The target platform for which the app is compiled.
[android-arm (default), android-arm64 (default), android-x86, android-x64 (default)]
--[no-]track-widget-creation Track widget creation locations. This enables features such as the widget inspector.
This parameter is only functional in debug mode (i.e. when compiling JIT, not AOT).
(defaults to on)
Run "flutter help" to see global options.
[✓] Flutter (Channel stable, 3.7.0, on macOS 13.2 22D49 darwin-x64, locale
en-BE)
• Flutter version 3.7.0 on channel stable at
/Users/navaronbracke/Documents/flutter
• Upstream repository https://github.com/flutter/flutter.git
• Framework revision b06b8b2710 (8 days ago), 2023-01-23 16:55:55 -0800
• Engine revision b24591ed32
• Dart version 2.19.0
• DevTools version 2.20.1
[✓] Android toolchain - develop for Android devices (Android SDK version 33.0.0)
• Android SDK at /Users/navaronbracke/Library/Android/sdk
• Platform android-33, build-tools 33.0.0
• ANDROID_HOME = /Users/navaronbracke/Library/Android/sdk
• Java binary at: /Applications/Android
Studio.app/Contents/jre/Contents/Home/bin/java
• Java version OpenJDK Runtime Environment (build
11.0.13+0-b1751.21-8125866)
• All Android licenses accepted.
[✓] Xcode - develop for iOS and macOS (Xcode 14.2)
• Xcode at /Applications/Xcode.app/Contents/Developer
• Build 14C18
• CocoaPods version 1.11.2
[✓] Chrome - develop for the web
• Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome
[✓] Android Studio (version 2021.3)
• Android Studio at /Applications/Android Studio.app/Contents
• Flutter plugin can be installed from:
🔨 https://plugins.jetbrains.com/plugin/9212-flutter
• Dart plugin can be installed from:
🔨 https://plugins.jetbrains.com/plugin/6351-dart
• Java version OpenJDK Runtime Environment (build
11.0.13+0-b1751.21-8125866)
[✓] VS Code (version 1.74.3)
• VS Code at /Applications/Visual Studio Code.app/Contents
• Flutter extension version 3.58.0
[✓] Connected device (2 available)
• macOS (desktop) • macos • darwin-x64 • macOS 13.2 22D49 darwin-x64
• Chrome (web) • chrome • web-javascript • Google Chrome 109.0.5414.119
[✓] HTTP Host Availability
• All required HTTP hosts are available
• No issues found!