EnDaftCommand class abstract

Inheritance

• Object
• Command<bool>
• EnDaftCommand

Implementers

• AggregateCommand
• BuildCommand
• CheckCommand
• DepsCommand
• DockerCommand
• InstallCommand
• LambdaCommand
• SharedCommand
• TestCommand
• ValidateCommand

Constructors

EnDaftCommand({required List<String> tools, required Logger logger})

Properties

aliases → List<String>

Alternate names for this command.

no setter, inherited

allCommands → List<EnDaftCommand>

All commands known to the runner

no setter

allFsPaths → List<FileRequirement>

All TaskRequirements.files from this commands sequence

no setter

allTools → List<String>

All tools from this commands sequence

no setter

argParser → ArgParser

The argument parser for this command.

no setter, inherited

argResults → ArgResults?

The parsed argument results for this command.

no setter, inherited

args → ArgResults

no setter

category → String

The command's category.

no setter, inherited

description → String

A description of this command, included in usage.

no setter, inherited

globalFsPaths → List<FileRequirement>

A sorted, distinct list of allFsPaths from allCommands

no setter

globalResults → ArgResults?

The parsed global argument results.

no setter, inherited

globalTools → List<String>

A sorted, distinct list of allTools from allCommands

no setter

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 → Logger

A logger instance

final

name → String

The name of this command.

no setter, inherited

parent → Command<bool>?

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

no setter, inherited

rootDir → String

Gets the normalized active root directory for the command

no setter

runner → CommandRunner<bool>?

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<bool>>

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

tools → List<String>

The external tools (commands and exes) required by the command

final

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<bool> 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

revealTasks() → List<TaskCommand>

Reveals all tasks potentially used by the command.

run() → FutureOr<bool>?

Runs this command.

inherited

runSequence([Map<String, Map<String, dynamic>> args = const {}]) → Future<bool>

Executes this commands sequence with the mapped args or empty args

runSequenceSame(ArgsProvider provider) → Future<bool>

Executes this commands sequence invoking the provider for each task's args.

toString() → String

A string representation of this object.

inherited

usageException(String message) → Never

Throws a UsageException with message.

inherited

useSequence(List<TaskCommand> sequence) → void

Sets the sequence of tasks run by this command

Operators

operator ==(Object other) → bool

The equality operator.

inherited