Arguments class

Comprehensive iOS build arguments configuration.

Extends the base BuildArguments class with iOS-specific build options including export methods, provisioning profiles, and distribution settings. Handles IPA generation and various iOS distribution workflows.

Key iOS features:

IPA (iOS Application Archive) generation
Export options plist configuration for code signing
Multiple export methods for different distribution channels
Integration with Xcode build system and toolchain

Example usage:

final args = Arguments(
  variables,
  binaryType: 'ipa',
  buildMode: 'release',
  exportMethod: 'app-store',
);

Inheritance

Constructors

Arguments(Variables variables, {String? buildMode = 'release', required String binaryType, String? output, String? target, String? flavor, String? dartDefines, String? dartDefinesFile, List<String>? customArgs, String? buildName, String? buildNumber, bool pub = true, String? exportOptionsPlist, String? exportMethod, bool? obfuscate, String? splitDebugInfo}): Creates a new iOS build arguments instance.
Arguments.fromArgResults(ArgResults results, ArgResults? globalResults): Creates an iOS arguments instance from parsed command-line arguments.
factory
Arguments.fromJson(Map<String, dynamic> json, {required Variables variables}): Creates an iOS arguments instance from JSON configuration.
factory

Properties

argumentBuilder ↔ List<String>: Builds the command-line arguments list for the iOS build process.
getter/setter pairinherited-setteroverride-getter
arguments → Future<List<String>>: Processes variables in arguments and returns the final command-line arguments.
no setterinherited
binaryType → String: Type of binary to build (e.g., 'apk', 'aab', 'ipa').
finalinherited
buildMode → String?: Build mode for the application.
finalinherited
buildName ↔ String?: Version name for the application build.
getter/setter pairinherited
buildNumber ↔ String?: Version code/build number for the application.
getter/setter pairinherited
buildSourceDir → String: Source directory where build artifacts are initially created.
finalinherited
customArgs → List<String>?: Additional custom arguments for the Flutter build command.
finalinherited
dartDefineArguments → List<String>: Expands dartDefines into the --dart-define flags the Flutter CLI expects.
no setterinherited
dartDefines → String?: Dart compilation defines as a single string.
finalinherited
dartDefinesFile → String?: Path to a file containing Dart compilation defines.
finalinherited
effectiveSplitDebugInfo → String?: The split-debug-info directory actually passed to flutter build.
no setter
exportMethod → String?: The export method for iOS application distribution.
final
exportOptionsPlist → String?: Path to the export options plist file for iOS code signing and distribution.
final
flavor → String?: Build flavor for multi-flavor applications.
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
logger ↔ ColorizeLogger: Logger instance for outputting colored messages.
getter/setter pairinherited
obfuscate → bool?: Enables Dart code obfuscation for release builds.
final
output ↔ String?: Custom output path for the build artifacts.
getter/setter pairinherited
parent ↔ BuilderJob: Reference to the parent builder job.
getter/setter pairinherited
pub → bool: Whether to run flutter pub get before building.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
secretKeys → Set<String>: Configuration keys whose values must never be printed or logged.
no setterinherited
splitDebugInfo → String?: Directory where the Dart symbol map is stored.
final
target → String?: Target Dart file to build from.
finalinherited
variables → Variables: Variable processor for substituting placeholders in arguments.
finalinherited

Methods

build() → Future<int>: inherited
copyWith(Arguments? data) → Arguments: Creates a copy of this iOS arguments instance with updated values.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
printJob() → Future: Prints the resolved configuration of a job.
inherited
registerSecrets() → Future<void>: Resolves every secret value and registers it with the logger.
inherited
toJson() → Map<String, dynamic>: Converts the iOS arguments to JSON representation.
override
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

parser ↔ ArgParser: Command-line argument parser for iOS build configuration.
getter/setter pair

Static Methods

defaultConfigs(ArgResults? globalResults) → Arguments: Returns the default iOS build configuration.