RunnerCommand class

A command to execute distribution tasks defined in the configuration file.

The RunnerCommand class is responsible for parsing the configuration file, filtering tasks and jobs based on the provided operation key, and executing the specified build and publish operations. It supports running individual jobs or entire task workflows.

The command returns the process exit code: 0 when every job succeeded (or failed with continue-on-error), 1 otherwise.

Inheritance

• Object
• Command<int>
• Commander
• RunnerCommand

Constructors

RunnerCommand()

Properties

aliases → List<String>

Alternate names for this command.

no setter, inherited

argParser → ArgParser

Argument parser for the run command with configuration and operation options.

no setter, override

argResults → ArgResults?

The parsed argument results for this command.

no setter, inherited

category → String

The command's category.

no setter, inherited

configPath → String

The configuration file this command should read.

no setter, inherited

description → String

The description of the run command shown in help text

no setter, override

failFast → bool

Whether the run stops at the first failing task.

no setter

globalResults → ArgResults?

The parsed global argument results.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hidden → bool

Whether or not this command should be hidden from help listings.

no setter, inherited

invocation → String

A single-line template for how to invoke this command (e.g. "pub get package").

no setter, inherited

isDryRun → bool

Whether the run should only print the resolved commands.

no setter

logger → ColorizeLogger

The logger used by this command.

no setter, inherited

name → String

The name of the command used in CLI

no setter, override

operationKey → String

The operation key used to filter which tasks or jobs to execute.

no setter

parent → Command<int>?

The command's parent command, if this is a subcommand.

no setter, inherited

runner → CommandRunner<int>?

The command runner for this command.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subcommands → Map<String, Command<int>>

An unmodifiable view of all sublevel commands of this command.

no setter, inherited

suggestionAliases → List<String>

Alternate non-functional names for this command.

no setter, inherited

summary → String

A short description of this command, included in parent's CommandRunner.usage.

no setter, inherited

takesArguments → bool

Whether or not this command takes positional arguments in addition to options.

no setter, inherited

usage → String

Generates a string displaying usage information for this command.

no setter, inherited

usageFooter → String?

An optional footer for usage.

no setter, inherited

Methods

addSubcommand(Command<int> command) → void

Adds Command as a subcommand of this.

inherited

configParserBuilder() → Future<ConfigParser?>

Kept for backwards compatibility with external callers.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

printUsage() → void

Prints the usage information for this command.

inherited

run() → Future<int>

Executes the run command to process distribution tasks.

override

toString() → String

A string representation of this object.

inherited

usageException(String message) → Never

Throws a UsageException with message.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited