ListCommandMixin mixin

Mixin applications

• ListAllCommand
• ListMissingCommand
• ListUnusedCommand

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

arguments → List<BaseArgument<void>>

final, inherited

category → String

The command's category.

no setter, inherited

colored → bool

no setter, inherited

description → String

A description of this command, included in usage.

no setter, inherited

exportDirectory → Directory?

no setter

filter ↔ LogFilter?

late, final, inherited

globalResults → ArgResults?

The parsed global argument results.

no setter, inherited

hasErrors ↔ bool

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasRun ↔ bool

getter/setter pair, 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

logLevel → LogLevel

no setter, inherited

logsDirectory → Directory?

no setter, inherited

mode → ReportDisplayMode

no setter

name → String

The name of this command.

no setter, inherited

parent → Command<void>?

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

no setter, inherited

path → String?

no setter, inherited

runner → CommandRunner<void>?

The command runner for this command.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shouldSkipExit ↔ bool

getter/setter pair, inherited

subcommands → Map<String, Command<void>>

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<void> command) → void

Adds Command as a subcommand of this.

inherited

dispose() → Future<void>

inherited

execute() → Future<void>

inherited

exitWithCode(int code) → Future<void>

Terminates the CLI app with a code.

inherited

exitWithError(Object error) → Future<void>

Terminates the CLI app with errors.

inherited

exitWithException(Object error, [StackTrace? st]) → Future<void>

Terminates the CLI app with exception.

inherited

init() → Future<void>

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

printArguments() → void

inherited

printUsage() → void

Prints the usage information for this command.

inherited

run() → Future<void>

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

Static Properties

listArguments → List<BaseArgument<void>>

final

Constants

exportDirectoryArg → const DirectoryArgument

reportDisplayModeArg → const EnumArgument<ReportDisplayMode>