Add class

An example command

Inheritance

• Object
• Command
• Add

Implementers

• MockAdd

Constructors

Add.new({required GgLog ggLog, String name = 'add', String description = 'Adds a message to the change log.', CiderProject? ciderProject})

Constructor

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

description → String

A description of this command, included in usage.

final, inherited

dirFromArgs → Directory

Returns the directory from the command line arguments

no setter, inherited

ggLog → GgLog

The log function

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

name → String

The name of the command

final, inherited

parent → Command?

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

no setter, inherited

runner → CommandRunner?

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>

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

absolute(Directory dir) → Directory

the input directory as absolute path

inherited

addSubcommand(Command command) → void

Adds Command as a subcommand of this.

inherited

check({required Directory directory}) → Future<void>

Returns true if the directory exists

inherited

dirName(Directory dir) → String

The name of the directory to be checked

inherited

exec({required Directory directory, required GgLog ggLog, String? message, LogType? logType}) → Future<bool>

Returns true if a message was added to the change log.

get({required Directory directory, required GgLog ggLog, String? message, LogType? logType}) → Future<bool>

Returns true if a message was added to the change log.

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() → Future<bool>

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