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

• Object
• JobArguments
• BuildArguments
• Arguments

Constructors

Arguments.new(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})

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 pair, inherited-setter, override-getter

arguments → Future<List<String>>

Processes variables in arguments and returns the final command-line arguments.

no setter, inherited

binaryType → String

Type of binary to build (e.g., 'apk', 'aab', 'ipa').

final, inherited

buildMode → String?

Build mode for the application.

final, inherited

buildName → String?

Version name for the application build.

final, inherited

buildNumber → String?

Version code/build number for the application.

final, inherited

buildSourceDir → String

Source directory where build artifacts are initially created.

final, inherited

customArgs → List<String>?

Additional custom arguments for the Flutter build command.

final, inherited

dartDefines → String?

Dart compilation defines as a single string.

final, inherited

dartDefinesFile → String?

Path to a file containing Dart compilation defines.

final, inherited

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.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

logger ↔ ColorizeLogger

Logger instance for outputting colored messages.

getter/setter pair, inherited

output ↔ String?

Custom output path for the build artifacts.

getter/setter pair, inherited

parent ↔ BuilderJob

Reference to the parent builder job.

getter/setter pair, inherited

pub → bool

Whether to run flutter pub get before building.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

target → String?

Target Dart file to build from.

final, inherited

variables → Variables

Variable processor for substituting placeholders in arguments.

final, inherited

Methods

build() → Future<int>

Executes the complete build process.

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 job configuration information to the console.

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.