clikt-mordant/com.github.ajalt.clikt.core/NoOpCliktCommand

NoOpCliktCommand

open class NoOpCliktCommand(name: String? = null) : CliktCommand

A CliktCommand that has a default implementation of CliktCommand.run that is a no-op.

Constructors

NoOpCliktCommand

constructor(name: String? = null)

Properties

allowMultipleSubcommands

open val allowMultipleSubcommands: Boolean

autoCompleteEnvvar

open val autoCompleteEnvvar: String?

val commandName: String

val currentContext: Context

open val helpTags: Map<String, String>

open val hiddenFromHelp: Boolean

invokeWithoutSubcommand

open val invokeWithoutSubcommand: Boolean

val messages: List<String>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

val BaseCliktCommand<*>.terminal: Terminal

A shortcut for accessing the terminal from the currentContext

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

Functions

open fun aliases(): Map<String, List<String>>

open fun allHelpParams(): List<HelpFormatter.ParameterHelp>

open fun ~~commandHelp~~(context: Context): String

commandHelpEpilog

open fun ~~commandHelpEpilog~~(context: Context): String

configureContext

fun configureContext(block: Context.Builder.() -> Unit)

fun echo()

fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

open fun help(context: Context): String

open fun helpEpilog(context: Context): String

fun BaseCliktCommand<*>.installMordant(force: Boolean = false)

Set up this command's context to use Mordant for rendering.

fun issueMessage(message: String)

registerArgument

fun registerArgument(argument: Argument)

registeredArguments

fun registeredArguments(): List<Argument>

registeredOptions

fun registeredOptions(): List<Option>

registeredParameterGroups

fun registeredParameterGroups(): List<ParameterGroup>

registeredSubcommandNames

fun registeredSubcommandNames(): List<String>

registeredSubcommands

fun registeredSubcommands(): List<CoreCliktCommand>

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

fun resetContext(parent: Context?): Context

override fun run()

@JvmName(name = "varargTest")

fun CliktCommand.test(vararg argv: String, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult

fun CliktCommand.test(argv: String, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult

fun CliktCommand.test(argv: List<String>, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult

inline fun <T : BaseCliktCommand<T>> BaseCliktCommand<T>.test(argv: List<String>, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, parse: (argv: List<String>) -> Unit): CliktCommandTestResult

Test this command, returning a result that captures the output and result status code.

open override fun toString(): String