ArgParser class

A class for taking a list of raw command line arguments and parsing out options and flags from them.

Available extensions

• ArgParserExtension

Constructors

ArgParser({bool allowTrailingOptions = true, int? usageLineLength})

Creates a new ArgParser.

factory

ArgParser.allowAnything()

Creates a new ArgParser that treats all input as non-option arguments.

factory

Properties

allowsAnything → bool

Whether or not this parser treats unrecognized options as non-option arguments.

no setter

allowTrailingOptions → bool

Whether or not this parser parses options that appear after non-option arguments.

final

commands → Map<String, ArgParser>

The commands that have been defined for this parser.

final

hashCode → int

The hash code for this object.

no setter, inherited

options → Map<String, Option>

The options that have been defined for this parser.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

usage → String

Generates a string displaying usage information for the defined options.

no setter

usageLineLength → int?

An optional maximum line length for usage messages.

final

Methods

addCommand(String name, [ArgParser? parser]) → ArgParser

Defines a command.

addFlag(String name, {String? abbr, String? help, bool? defaultsTo = false, bool negatable = true, void callback(bool)?, bool hide = false, bool hideNegatedUsage = false, List<String> aliases = const []}) → void

Defines a boolean flag.

addFlagCodesign({bool defaultsTo = true}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a codesign flag for application bundle signing.

addFlagCsp({bool defaultsTo = false}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a CSP flag for content security policy.

addFlagDebug({bool defaultsTo = false}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a debug flag to build a debug version of the app.

addFlagDumpInfo({bool defaultsTo = false}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a dump info flag for JavaScript compiler information.

addFlagFrequencyBasedMinification({bool defaultsTo = true}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a frequency based minification flag.

addFlagGenerateL10n({bool defaultsTo = true}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a generate l10n flag for localization generation.

addFlagObfuscate() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds an obfuscate flag for source code obfuscation.

addFlagProfile({bool defaultsTo = false}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a profile flag for performance profiling builds.

addFlagRelease({bool defaultsTo = true}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a release flag to build a release version of the app.

addFlagSourceMaps({bool defaultsTo = false}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a source maps flag for debugging.

addFlagWebResourcesCdn({bool defaultsTo = true}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a web resources CDN flag.

addMultiOption(String name, {String? abbr, String? help, String? valueHelp, Iterable<String>? allowed, Map<String, String>? allowedHelp, Iterable<String>? defaultsTo, void callback(List<String>)?, bool splitCommas = true, bool hide = false, List<String> aliases = const []}) → void

Defines an option that takes multiple values.

addOption(String name, {String? abbr, String? help, String? valueHelp, Iterable<String>? allowed, Map<String, String>? allowedHelp, String? defaultsTo, void callback(String?)?, bool mandatory = false, bool hide = false, List<String> aliases = const []}) → void

Defines an option that takes a value.

addOptionBaseHref() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a base href option for web applications.

addOptionBuildName() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a build name option for versioning.

addOptionBuildNumber() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a build number option for versioning.

addOptionDart2JsOptimization() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a dart2js optimization option.

addOptionDeviceId() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a device ID option for targeting specific devices.

addOptionExportMethod() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds an export method option for IPA distribution.

addOptionExportOptionsPlist() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds an export options plist option.

addOptionFlavor({required String defaultsTo}) → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a flavor option for selecting application flavors.

addOptionMorphemeYaml() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds an option for specifying a custom path to morpheme.yaml.

addOptionPwaStrategy() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a PWA strategy option for web applications.

addOptionSplitDebugInfo() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a split debug info option for reducing application size.

addOptionTarget() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a target file option for specifying the main entry-point file.

addOptionUseApp() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a use app option for specifying pre-built application binaries.

addOptionWebRenderer() → void

Available on ArgParser, provided by the ArgParserExtension extension

Adds a web renderer option for web applications.

addSeparator(String text) → void

Adds a separator line to the usage.

defaultFor(String option) → dynamic

Returns the default value for option.

findByAbbreviation(String abbr) → Option?

Finds the option whose abbreviation is abbr, or null if no option has that abbreviation.

findByNameOrAlias(String name) → Option?

Finds the option whose name or alias matches name, or null if no option has that name or alias.

getDefault(String option) → dynamic

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

parse(Iterable<String> args) → ArgResults

Parses args, a list of command-line arguments, matches them against the flags and options defined by this parser, and returns the result.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited