OvenMixin mixin

Superclass Constraints

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
category → String
The command's category.
no setterinherited
completers → Map<String, Completer<bool>>
gets the completers
no setterinherited
description → String
A description of this command, included in usage.
no setterinherited
globalResults → ArgResults?
The parsed global argument results.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
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
isVerbose → bool
Whether to print verbose logs to console
no setterinherited
isWatch → bool
whether to listen to changes to the BrickOvenYaml.file or the BrickConfig.configPath file and the BrickConfig.sourcePath directory
no setterinherited
keyListener → KeyPressListener
A class that listens for key presses from stdin and emits the key presses to the stream.
no setter
keyPressListener → KeyPressListener?
A class that listens for key presses from stdin and emits the key presses to the stream.
no setterinherited
logger → Logger
the logger for output messages
no setterinherited
name → String
The name of this command.
no setterinherited
outputDir → String?
the directory to output the brick to
no setterinherited
parent → Command<int>?
The command's parent command, if this is a subcommand.
no setterinherited
runner → CommandRunner<int>?
The command runner for this command.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldSync → bool
whether to validate if the brick.yaml file is synced
no setterinherited
subcommands → Map<String, Command<int>>
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<int> command) → void
Adds Command as a subcommand of this.
inherited
cancelConfigWatchers({required bool shouldQuit}) → Future<void>
cancels all watchers
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
putInOven(Set<Brick> bricks) → Future<ExitCode>
cooks the bricks
run() → FutureOr<int>?
Runs this command.
inherited
toString() → String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited
watcher(String path) → FileWatcher
Watches the path for changes
inherited
watchForConfigChanges(String path, {FutureOr<void> onChange()?}) → Future<bool>
the watcher for the BrickOvenYaml.file
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited