ScriptRunCommand class

The command to run a script

Inheritance
Mixed-in types

Constructors

ScriptRunCommand({required ScriptsYaml scriptsYaml, required Variables variables, required Bindings bindings, required Logger logger, required CWD cwd})

Properties

aliases List<String>
Alternate names for this command.
no setteroverride
argParser → ArgParser
The argument parser for this command.
final
argResults → ArgResults?
The parsed argument results for this command.
no setterinherited
bindings Bindings
final
category String
The command's category.
no setterinherited
cwd CWD
final
description String
A description of this command, included in usage.
no setteroverride
directory String
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
logger → Logger
final
name String
The name of this command.
no setteroverride
parent → Command<ExitCode>?
The command's parent command, if this is a subcommand.
no setterinherited
runner → CommandRunner<ExitCode>?
The command runner for this command.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scriptsYaml ScriptsYaml
final
subcommands Map<String, Command<ExitCode>>
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
variables Variables
final

Methods

addFlags() → void
inherited
addSubcommand(Command<ExitCode> command) → void
Adds Command as a subcommand of this.
inherited
commandsToRun(List<String> keys, ArgResults argResults) → (ExitCode?, Iterable<CommandToRun>?, bool)
inherited
getCommands(List<String> keys, ArgResults argResults) → (ExitCode?, List<String>?, Script?)
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
optionalFlags(List<String> keys) OptionalFlags
inherited
printUsage() → void
Prints the usage information for this command.
inherited
run([List<String>? args]) Future<ExitCode>
Runs this command.
override
toString() String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited
validate(List<String>? keys) FutureOr<ExitCode?>
inherited

Operators

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