LuaLikeCommandRunner class

Main command runner for LuaLike following Lua CLI specification

Inheritance
  • Object
  • CommandRunner
  • LuaLikeCommandRunner

Constructors

LuaLikeCommandRunner()

Properties

argParser → ArgParser
The top-level argument parser.
no setterinherited
commands → Map<String, Command>
An unmodifiable view of all top-level commands defined for this runner.
no setterinherited
debugMode ↔ bool
getter/setter pair
description → String
A short description of this executable.
finalinherited
executableName → String
The name of the executable being run.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
helpColorScheme → HelpColorScheme
The color scheme used for help output.
finalinherited
interactive → bool
Whether interactive prompts are enabled.
no setterinherited
invocation → String
A single-line template for how to invoke this executable.
no setteroverride
io → Console
The I/O helper for console output.
no setterinherited
namespaceSeparator → String
Separator used to group commands into namespaces.
finalinherited
renderer → Renderer
The renderer for output.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
suggestionDistanceLimit → int
The maximum edit distance allowed when suggesting possible intended commands.
finalinherited
usage → String
Generates a string displaying usage information for the executable.
no setterinherited
usageExitCode → int
Exit code set when a UsageException occurs.
finalinherited
usageFooter → String?
An optional footer for usage.
no setterinherited
verbosity → Verbosity
The current verbosity level.
no setterinherited

Methods

addCommand(Command command) → void
Adds Command as a top-level command to this runner.
inherited
formatGlobalUsage({bool includeDescription = true}) → String
Formats global usage, grouping commands by namespace.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parse(Iterable<String> args) → ArgResults
Parses args and returns the result, converting an ArgParserException to a UsageException.
inherited
printUsage() → void
Prints the usage information for this runner.
inherited
run(Iterable<String> args) → Future<void>
Parses args and invokes Command.run on the chosen command.
runCommand(ArgResults topLevelResults) → Future
Runs the command specified by topLevelResults.
inherited
toString() → String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited
writeErr(String line) → void
Writes a line to stderr.
inherited
writeOut(String line) → void
Writes a line to stdout.
inherited

Operators

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

Constants

luaCompatVersion → const String
lualikeVersion → const String