ListCommandMixin mixin

Mixin applications

Properties

aliases List<String>
Alternate names for this command.
no setterinherited
argParser → ArgParser
The argument parser for this command.
no setterinherited
argResults → ArgResults?
The parsed argument results for this command.
no setterinherited
arguments List<BaseArgument<void>>
finalinherited
category String
The command's category.
no setterinherited
colored bool
no setterinherited
description String
A description of this command, included in usage.
no setterinherited
exportDirectory Directory?
no setter
filter ↔ LogFilter?
latefinalinherited
globalResults → ArgResults?
The parsed global argument results.
no setterinherited
hasErrors bool
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
hasRun bool
getter/setter pairinherited
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
logLevel → LogLevel
no setterinherited
logsDirectory Directory?
no setterinherited
mode → ReportDisplayMode
no setter
name String
The name of this command.
no setterinherited
parent → Command<void>?
The command's parent command, if this is a subcommand.
no setterinherited
path String?
no setterinherited
runner → CommandRunner<void>?
The command runner for this command.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shouldSkipExit bool
getter/setter pairinherited
subcommands Map<String, Command<void>>
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<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>