BPConfig class

The actual class holding the fields of the config

Constructors

BPConfig({PlatformConfig? android, PlatformConfig? ios, PlatformConfig? linux, PlatformConfig? macos, PlatformConfig? web, PlatformConfig? windows, String? xcodeDerivedKey, HookCommands buildHooks = const HookCommands(), HookCommands publishHooks = const HookCommands(), required bool cleanFlutter, OutputMode output = OutputMode.auto, required DateTime timestamp, required String version, required bool generateLog, required String buildVersion, required List<String> cmdArgs, String workflowName = "default"})

Properties

android ↔ PlatformConfig?

getter/setter pair

buildHooks ↔ HookCommands

The pre_platform_run.build and post_platform_run.build of the workflow

getter/setter pair

buildPlatforms → List<TargetPlatform>

The list of target platforms provided in the config for building, in platformOrder iOS and android config may exist without a build command, in which case they will not be returned All other platforms, since they do not have a publish config yet, will return if have a config

no setter

buildVersion ↔ String

getter/setter pair

cleanFlutter ↔ bool

getter/setter pair

cmdArgs ↔ List<String>

getter/setter pair

generateLog ↔ bool

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

ios ↔ PlatformConfig?

getter/setter pair

linux ↔ PlatformConfig?

getter/setter pair

logFile → String

Gets the path of the log file, if log generation is not prevented via the config

no setter

macos ↔ PlatformConfig?

getter/setter pair

needXCodeDerivedCleaning → bool

Checks if the XCode derived data is provided AND there is a build target for Apple devices

no setter

output ↔ OutputMode

How the run is shown, from the output field of the workflow or the --bp-output flag

getter/setter pair

publishHooks ↔ HookCommands

The pre_platform_run.publish and post_platform_run.publish of the workflow

getter/setter pair

publishPlatforms → List<TargetPlatform>

The list of target platforms provided in the config for publishing, in platformOrder Only iOS and Android are supported for publishing at the moment, and they will be returned if they have a publish config

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

timestamp ↔ DateTime

getter/setter pair

version ↔ String

getter/setter pair

web ↔ PlatformConfig?

getter/setter pair

windows ↔ PlatformConfig?

getter/setter pair

workflowName ↔ String

getter/setter pair

xcodeDerivedKey ↔ String?

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

platformConfig(TargetPlatform platform) → PlatformConfig?

The config of the given platform, if the workflow has one

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromMap(YamlMap data, List<String> args, String version, String buildVersion, {String workflowName = "default"}) → (BPConfig?, List<BPConfigValidationError>)

Parsed the config from the map

readPubspec(List<String> args, [String? pubspecPath]) → Future<(BPConfig?, List<BPConfigValidationError>)>

Reads the pubspec.yaml file, parses, validates, and returns the config object. No exceptions are thrown from this functions, instead, a list of user-facing errors will be returned as the second object of the record

Constants

platformOrder → const List<TargetPlatform>

The order the platforms always run in, whatever their order in the pubspec or in --override-target-platforms