quarkdown-cli/com.quarkdown.cli.exec

Package-level declarations

Types

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

Command to compile a Quarkdown file into an output.

ExecuteCommand

abstract class ExecuteCommand(name: String) : CliktCommand

Template for Quarkdown commands that launch a complete pipeline and produce output files.

ExecutionOutcome

data class ExecutionOutcome(val resource: OutputResource?, val directory: File?, val context: Context)

Outcome of a pipeline execution.

ExecutionTimeoutException

class ExecutionTimeoutException(val timeoutSeconds: Int) : RuntimeException

Thrown when the execution exceeds the allowed timeoutSeconds.

ReplCommand

class ReplCommand : ExecuteCommand

Command to start Quarkdown in interactive REPL mode. The result of each input is printed to standard output, and no file is written.

Properties

DEFAULT_OUTPUT_DIRECTORY

const val DEFAULT_OUTPUT_DIRECTORY: String

Name of the default directory to save output files in. It can be overridden by the user.

Functions

createSession

fun createSession(cliOptions: CliOptions, pipelineOptions: PipelineOptions): QuarkdownSession

Creates the session every CLI compilation runs in. A session is created once per command and reused across live preview recompilations.

runQuarkdown

fun runQuarkdown(executionStrategy: PipelineExecutionStrategy, cliOptions: CliOptions, pipelineOptions: PipelineOptions): ExecutionOutcome

Executes a complete Quarkdown pipeline in a new session created from the given options.

fun runQuarkdown(executionStrategy: PipelineExecutionStrategy, session: QuarkdownSession, cliOptions: CliOptions): ExecutionOutcome

Executes a complete Quarkdown pipeline in session, over a fresh context that is closed once done.