TaskCommand class abstract

A task command meant to be sequenced by other commands

Inheritance

• Object
• Command<bool>
• TaskCommand

Implementers

• BuildRunnerBuildTask
• BuildRunnerCleanTask
• CheckFSTask
• CheckToolsTask
• CleanDirTask
• DartCompileTask
• DartTestTask
• DockerBuildTask
• DockerRunTask
• GitStatusTask
• InstallEnDaftFilesTask
• PubGetTask
• TemplateTask
• UpdateSchemasTask
• ValidateJsonTask
• ZipArchiveTask

Constructors

TaskCommand(EnDaftCommand parent, Logger logger, TaskRequirements requirements)

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

args → Map<String, dynamic>

Gets the arguments available to this task from the parent command.

no setter

category → String

The command's category.

no setter, inherited

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, override

invocation → String

A single-line template for how to invoke this command (e.g. "pub get package").

no setter, inherited

logger → Logger

The logger instance for this task

final

name → String

The name of this command.

no setter, inherited

parent → EnDaftCommand

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

final

requirements → TaskRequirements

This tasks execution requirements.

final

rootDir → String

Get the root directory from the root arg, or Directory.current if not present.

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

targetDir → String

Get the target directory from the target arg, or rootDir if not present.

no setter

usage → String

Generates a string displaying usage information for this command.

no setter, inherited

usageFooter → String?

An optional footer for usage.

no setter, inherited

userDir → String?

Gets the users home directory

no setter

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

run() → FutureOr<bool>?

Runs this command.

inherited

runWith([Map<String, dynamic>? args]) → FutureOr<bool>?

Runs this task with the given args, or the parent args if none are provided.

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