OutputMode enum

How a run is shown, set by the output field of a workflow and overridden by the --bp-output flag

Inheritance
Available extensions

Values

auto → const OutputMode

interactive in a terminal, and plain anywhere else, including a CI

interactive → const OutputMode

A tree of the steps that updates in place, with the last lines of the output of the running step

plain → const OutputMode

One line per step, without moving the cursor, e.g. for a CI

verbose → const OutputMode

Like plain, along with the whole output of the commands as they run

json → const OutputMode

One JSON object per line, for scripts and agents

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resolve({bool? hasTerminal, Map<String, String>? environment}) → OutputMode
Turns auto into the mode that fits where the output goes. The other modes are returned as they are
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

names → String
The names of all the modes, e.g. for the error of an unknown value
no setter

Static Methods

fromArgs(List<String> args) → (OutputMode?, String?)
Reads the value of the --bp-output flag. The mode is null when the flag is not given
isFlag(String arg) → bool
Whether the arg is the --bp-output flag, which is not passed down to the build commands
parse(String value) → (OutputMode?, String?)
Parses the name of a mode, returning the error for an unknown one

Constants

flag → const String
values → const List<OutputMode>
A constant List of the values in this enum, in order of their declaration.