Skip to content

flutter assemble needs better documentation / error messages #129542

@eladm-ultrawis

Description

@eladm-ultrawis

Is there an existing issue for this?

Use case

When using flutter assemble command, there are many undocumented features / options.

for instance, this is the sequence I use to generate an app bundle for windows-x64

flutter create test_module1 --template=module --local-engine-src-path /d/workspace/engine/src --local-engine=host_debug

cd test_module1
flutter assemble --local-engine=host_debug -dTargetPlatform=windows-x64 '-dBuildMode=debug' -dTrackWidgetCreation=true --output="jit_bundle" -dTargetFile="lib/main.dart" debug_bundle_windows_assets
flutter assemble --local-engine=host_release -dTargetPlatform=windows-x64 '-dBuildMode=release' --output="aot_bundle" -dTargetFile="lib/main.dart" release_bundle_windows_assets
  • the target name (release_bundle_windows_assets / debug_bundle_windows_assets) are not documented and had to be deduced by looking at the src code for the command
  • non of the options TargetPlatform, BuildMode are documented.
  • in case of a missing option, there is no way to know which valid options are available.

Proposal

  • There should be a documentation for all options that are required to successfully run the command.
  • The user should be able to get list valid options for each argument.
  • Error messages should list valid options instead of just saying an option is missing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Important issues not at the top of the work listc: new featureNothing broken; request for a new capabilityc: proposalA detailed proposal for a change to Flutterd: api docsIssues with https://api.flutter.dev/team-toolOwned by Flutter Tool teamtool-still-validIssues that have been deemed still valid as part of the Flutter Tools issue cleanup initiative.triaged-toolTriaged by Flutter Tool team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy