quarkdown-cli/com.quarkdown.cli.exec/CompileCommand

CompileCommand

class CompileCommand(previewStrategyProvider: CompileCommand.() -> PreviewStrategy = { WebServerPreviewStrategy( port = serverPort, browser = browser, preferLivePreviewUrl = preview && watch, ) }) : ExecuteCommand

Command to compile a Quarkdown file into an output.

Parameters

previewStrategyProvider

factory invoked once to produce the PreviewStrategy used after each successful compile when preview mode is enabled.

Constructors

CompileCommand

constructor(previewStrategyProvider: CompileCommand.() -> PreviewStrategy = { WebServerPreviewStrategy( port = serverPort, browser = browser, preferLivePreviewUrl = preview && watch, ) })

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 val hiddenFromHelp: Boolean

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>

browserLauncherOption

fun CliktCommand.browserLauncherOption(default: BrowserLauncher = NoneBrowserLauncher(), shouldValidate: () -> Boolean = { true }, envLookup: (String) -> String? = System::getenv): OptionDelegate<out BrowserLauncher?>

Option to select a browser launcher from the CLI, with validation and support of selection by name, path, or fixed choices.

commandHelp