UdaraCommand class abstract

Inheritance
Implementers

Constructors

UdaraCommand()

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
clientsDir → Directory
no setter
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
name → String
The name of this command.
no setterinherited
parent → Command<void>?
The command's parent command, if this is a subcommand.
no setterinherited
projectDir → String
final
runner → CommandRunner<void>?
The command runner for this command.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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
checkProjectPrerequisites() → void
Fails early when files the pipeline depends on are absent, pointing at the command that creates them instead of failing mid-build.
initializeSlackService(String channel) → Future<SlackService?>
Builds a SlackService from the stored bot token, or returns null (with a warning) when Slack has not been configured.
listClientNames() → Future<List<String>>
Returns the sorted names of every client directory, or an empty list when the clients directory does not exist.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyBuildStep(SlackService? slack, {required String step, required String client, required String platform, required String status, String? additionalInfo, String? errorMessage}) → Future<void>
Sends a build step notification, never letting Slack failures interrupt the pipeline.
printUsage() → void
Prints the usage information for this command.
inherited
recoverInterruptedRun(CleanupService cleanup) → Future<void>
Restores the project if a previous build or whitelabel was interrupted (its .udara backups still exist). Without this, the stale backups would be restored by this run's cleanup, silently reverting part of the new client's branding.
resolveClientEnvFile(String client, {bool isTest = false}) → Future<File>
Resolves the env file for client, failing with a helpful message (including the list of known clients) when the client or file is missing.
run() → FutureOr<void>?
Runs this command.
inherited
runShell(String command, {String? workingDir}) → Future<void>
Runs a shell command in the project directory with structured logging and exception contextualization.
runStep<T>(String description, Future<T> action()) → Future<T>
Wraps a unit of work in consistent logging and exception translation.
toString() → String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited
validateEnvVariables(String client, String file, Map<String, String> vars) → void
Fails when any of requiredEnvKeys is missing or blank in vars.

Operators

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