codyze-core/de.fraunhofer.aisec.codyze.core.plugin/Plugin

Plugin

abstract class Plugin(cliName: String) : CliktCommand(source)

Plugins perform a standalone analysis independent of the Codyze Executors. They usually use already developed libraries from open-source analysis tools. When developing a new Plugin, do not forget to add it to the respective KoinModules, otherwise it will not be selectable in the configuration. Also, remember to add a page to docs/plugins.

Constructors

Plugin

constructor(cliName: String)

Properties

allowMultipleSubcommands

open val allowMultipleSubcommands: Boolean

autoCompleteEnvvar

open val autoCompleteEnvvar: String?

commandName

val commandName: String

currentContext

val currentContext: Context

helpTags

open val helpTags: Map<String, String>

hiddenFromHelp

open override val hiddenFromHelp: Boolean = true

invokeWithoutSubcommand

open val invokeWithoutSubcommand: Boolean

messages

val messages: List<String>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

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

configureContext

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

echo

fun echo()

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

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

equals

open operator override fun equals(other: Any?): Boolean

Define two plugins as equal if they are of the same type and therefore have the same CLI name. This is necessary to filter out duplicate Plugins when parsing the cli arguments

execute