clikt-core/com.github.ajalt.clikt.parameters.options/OptionTransformContext

OptionTransformContext

class OptionTransformContext(val option: Option, val context: Context) : Option, TransformContext

A receiver for options transformers.

Constructors

constructor(option: Option, context: Context)

Properties

acceptsNumberValueWithoutName

open override val acceptsNumberValueWithoutName: Boolean

If true, this option can be specified without a name e.g. -2 instead of -o2

acceptsUnattachedValue

open override val acceptsUnattachedValue: Boolean

If false, invocations must be of the form --foo=1 or -f1. If true, the forms --foo 1 and -f 1 are also accepted.

completionCandidates

open override val completionCandidates: CompletionCandidates

Optional set of strings to use when the user invokes shell autocomplete on a value for this option.

context

open override val context: Context

The current command context

eager

open override val eager: Boolean

If true, the presence of this option on the command line will halt parsing immediately

helpTags

open override val helpTags: Map<String, String>

Extra information about this option to pass to the help formatter.

hidden

open override val hidden: Boolean

If true, this option should not appear in help output.

names

open override val names: Set<String>

The names that can be used to invoke this option. They must start with a punctuation character.

nvalues

open override val nvalues: IntRange

The min and max number of values that must be given to this option.

option

val option: Option

The option that was invoked

secondaryNames

open override val secondaryNames: Set<String>

Names that can be used for a secondary purpose, like disabling flag options.

valueSourceKey

open override val valueSourceKey: String?

Optional explicit key to use when looking this option up from a ValueSource

Functions

fail

open override fun fail(message: String): Nothing

Throw an exception indicating that usage was incorrect.

finalize

open override fun finalize(context: Context, invocations: List<OptionInvocation>)

Called after this command's argv is parsed to transform and store the option's value.

message

fun TransformContext.message(message: String)

Issue a message that can be shown to the user

metavar

open override fun metavar(context: Context): String?

A name representing the values for this option that can be displayed to the user.

optionHelp

open override fun optionHelp(context: Context): String

The description of this option, usually a single line.

parameterHelp

open override fun parameterHelp(context: Context): HelpFormatter.ParameterHelp.Option?

Information about this option for the help output.

postValidate

open override fun postValidate(context: Context)

Called after all of a command's parameters have been finalized to perform validation of the final value.

require

inline fun require(value: Boolean, lazyMessage: () -> String = { "" })

If value is false, call fail with the output of lazyMessage