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.

Inheritance

Constructors

RunnerCommand.new()

Properties

aliases → List<String>
Alternate names for this command.
no setterinherited
argParser → ArgParser
Argument parser for the run command with configuration and operation options.
no setteroverride
argResults → ArgResults?
The parsed argument results for this command.
no setterinherited
category → String
The command's category.
no setterinherited
description → String
The description of the run command shown in help text
no setteroverride
globalResults → ArgResults?
The parsed global argument results.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hidden → bool
Whether or not this command should be hidden from help listings.
no setterinherited
invocation → String
A single-line template for how to invoke this command (e.g. "pub get package").
no setterinherited
logger → ColorizeLogger
The logger instance for logging messages with color support.
no setterinherited
name → String
The name of the command used in CLI
no setteroverride
operationKey → String
The operation key used to filter which tasks or jobs to execute.
no setter
parent → Command?
The command's parent command, if this is a subcommand.
no setterinherited
runner → CommandRunner?
The command runner for this command.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subcommands → Map<String, Command>
An unmodifiable view of all sublevel commands of this command.
no setterinherited
suggestionAliases → List<String>
Alternate non-functional names for this command.
no setterinherited
summary → String
A short description of this command, included in parent's CommandRunner.usage.
no setterinherited
takesArguments → bool
Whether or not this command takes positional arguments in addition to options.
no setterinherited
usage → String
Generates a string displaying usage information for this command.
no setterinherited
usageFooter → String?
An optional footer for usage.
no setterinherited

Methods

addSubcommand(Command command) → void
Adds Command as a subcommand of this.
inherited
configParserBuilder() → Future<ConfigParser?>
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?
Executes the run command to process distribution tasks.
override
runBuilder(BuilderJob builder, ConfigParser config) → Future<int>
runPublisher(PublisherJob publisher, ConfigParser config) → Future<int>
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