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

val arguments: List<String>

open val ~~commandHelp~~: String

commandHelpEpilog

open val ~~commandHelpEpilog~~: String

val commandName: String

val configFile: Path

val currentContext: Context

val helpTags: Map<String, String>

invokeWithoutSubcommand

val invokeWithoutSubcommand: Boolean

val messages: List<String>

printHelpOnEmptyArgs

val printHelpOnEmptyArgs: 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

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.

fun ~~confirm~~(text: String, default: Boolean?, uppercaseDefault: Boolean, showChoices: Boolean, choiceStrings: List<String>, promptSuffix: String, invalidChoiceMessage: String): Boolean?

fun echo()

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

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

fun issueMessage(message: String)

fun main(argv: Array<out String>)

fun main(argv: List<String>)

fun parse(argv: Array<String>, parentContext: Context?)

fun parse(argv: List<String>, parentContext: Context?)

fun ~~prompt~~(text: String, default: String?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<String>, promptSuffix: String, invalidChoiceMessage: String): String?

fun <T> ~~prompt~~(text: String, default: T?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<T>, promptSuffix: String, invalidChoiceMessage: String, convert: (String) -> ConversionResult<T>): T?

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<CliktCommand>

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

open override fun run()

open override fun toString(): String