Commander class abstract

An abstract base class for CLI commands in the distribute CLI.

The Commander class extends the Command class from the args package and provides a logger instance for logging messages with color support. It automatically configures the logger based on the global verbose flag.

Commands are typed as Command<int> so that every command reports an exit code, which the entry point forwards to the process. Returning 0 means success, any other value marks the invocation as failed.

Inheritance

• Object
• Command<int>
• Commander

Implementers

• AiCommand
• BuilderCommand
• ChangelogCommand
• CleanCommand
• Command
• Command
• Command
• Command
• Command
• Command
• Command
• Command
• CreateCommand
• CreateJobCommand
• CreatorCommand
• DoctorCommand
• InitializerCommand
• PublisherCommand
• RunnerCommand
• ValidateCommand

Constructors

Commander()

Creates a new Commander instance.

Properties

aliases → List<String>

Alternate names for this command.

no setter, inherited

argParser → ArgParser

The argument parser for this command.

no setter, inherited

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

description → String

A description of this command, included in usage.

no setter, inherited

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

logger → ColorizeLogger

The logger used by this command.

no setter

name → String

The name of this command.

no setter, inherited

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

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() → FutureOr<int>?

Runs this command.

inherited

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