codyze-cli/de.fraunhofer.aisec.codyze.cli/ConfigFileParser

ConfigFileParser

class ConfigFileParser : CliktCommand(source)

A CliktCommand to parse the --config option.

This class is only used as a pre-parser to parse the --config option and provide the received config[Path] as context to the [CodyzeCli] command.

Constructors

ConfigFileParser

constructor()

Properties

allowMultipleSubcommands

open val allowMultipleSubcommands: Boolean

arguments

val arguments: List<String>

autoCompleteEnvvar

open val autoCompleteEnvvar: String?

commandName

val commandName: String

configFile

val configFile: Path

currentContext

val currentContext: Context

helpTags

open val helpTags: Map<String, String>

hiddenFromHelp

open val hiddenFromHelp: Boolean

invokeWithoutSubcommand

open val invokeWithoutSubcommand: Boolean

messages

val messages: List<String>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

treatUnknownOptionsAsArgs

open override val treatUnknownOptionsAsArgs: Boolean = true

Functions

aliases

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

allHelpParams

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

commandHelp

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

commandHelpEpilog

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

configFileOption

fun CliktCommand.configFileOption(): OptionWithValues<Path, Path, Path>

The Clikt option for the config file. Defined as extension function because it is used in multiple CliktCommands.

configureContext

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

echo

fun echo()

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

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

help

open fun help(context: Context): String

helpEpilog

open fun helpEpilog(context: Context): String

issueMessage

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>

registerOption

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

resetContext

fun resetContext(parent: Context?): Context

run

open override fun run()

toString

open override fun toString(): String