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, String? preBuildCommand, String? postBuildCommand, required bool cleanFlutter, required bool printstdout, required DateTime timestamp, required String version, required bool generateLog, required String buildVersion, required List<String> cmdArgs})

Properties

android ↔ PlatformConfig?

getter/setter pair

buildPlatforms → List<TargetPlatform>

The list of target platforms provided in the config for building 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

postBuildCommand ↔ String?

getter/setter pair

preBuildCommand ↔ String?

getter/setter pair

printstdout ↔ bool

getter/setter pair

publishPlatforms → List<TargetPlatform>

The list of target platforms provided in the config for publishing 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

xcodeDerivedKey ↔ String?

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

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) → (BPConfig?, List<(dynamic Function(String s), String)>)

Parsed the config from the map

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

Reads the pubspec.yaml file, parses, validates, and returns the config object. No exceptions are thrown from this functions, instead, the function will exit with a non-zero exit code if an error is encountered and a user-facing error message will be displayed.