clackt/net.stephcraft.clackt

Package-level declarations

Types

data class ErrorBoundaryContext(var title: String, var errorDetails: Widget? = null)

data class ErrorBoundaryState(var state: ErrorState = ERROR, var attempts: Int = 1, var showStackTrace: Boolean = false)

ErrorState

enum ErrorState : Enum<ErrorState>

ExitRawMode

class ExitRawMode : Throwable

ExtractException

class ExtractException(label: String, url: String, message: String) : FriendlyException

FetchException

class FetchException(url: String, label: String) : FriendlyException

FriendlyException

open class FriendlyException(message: String) : KnownException

InfoAnimationState

data class InfoAnimationState(var state: InfoState = ACTIVE, var exception: Exception? = null, var print: Boolean = false)

InfoContext

class InfoContext(val update: () -> Unit)

InfoState

enum InfoState : Enum<InfoState>

KeyOption

data class KeyOption(val message: String, val color: TextStyle = gray, val label: String? = null, val disabled: String? = null, val hidden: Boolean = false, val priority: Int = 0)

Select Key Option

KnownException

open class KnownException(message: String, val details: Widget? = null) : Exception

ParseException

class ParseException(label: String, url: String) : FriendlyException

StepState

class StepState(var status: StepStatus, val title: () -> String)

Step state

StepStatus

enum StepStatus : Enum<StepStatus>

Step status

Properties

coroutine

val Terminal.coroutine: (block: suspend CoroutineScope.() -> Unit) -> Job

coroutineHandler

val Terminal.coroutineHandler: CoroutineExceptionHandler

debug

var debug: Boolean

Debug

debugColor

var debugColor: TextStyle

exceptions

val exceptions: MutableList<String>

onErrorBoundary

var onErrorBoundary: () -> Unit?

onErrorBoundaryRetry

var onErrorBoundaryRetry: () -> Unit?

Functions

asynchronous

fun Terminal.asynchronous(block: suspend CoroutineScope.() -> Unit): Job

Runs asynchronously

debug

fun Terminal.debug(message: String, content: String? = null, color: TextStyle = debugColor)

debugError

fun Terminal.debugError(message: String, content: String? = null)

debugException

fun Terminal.debugException(exception: Throwable)

error

fun Terminal.error(message: String, content: String? = null)

@clack/prompts log.error()

errorBoundary

fun <T> Terminal.errorBoundary(title: String = "Untitled", keyOptions: Map<String, KeyOption>? = null, block: ErrorBoundaryContext.() -> T, onAnimate: (widget: Widget, initial: Boolean) -> Unit?): T

info

fun Terminal.info(message: String, content: String? = null)

@clack/prompts log.info()

fun <T> Terminal.info(message: (active: InfoState) -> String, content: (active: InfoState) -> Widget? = { null }, onKeyInput: InfoContext.(event: KeyboardEvent, animation: Animation<*>) -> Unit? = null, errorHandling: Map<String, String>? = null, block: InfoContext.() -> T): T

intro

fun Terminal.intro(text: String, persist: Boolean = true)

@clack/prompts intro()

KeyOption

fun KeyOption(message: String, color: TextStyle = gray, label: String? = null, disabled: String? = null, hidden: Boolean = false, priority: Int = 0, action: KeyOptionContext.() -> Unit): KeyOption

persist

fun Terminal.persist(persist: Boolean = true, block: PrintWriter.() -> Unit)

readEventOrNull

fun readEventOrNull(rawMode: RawModeScope, timeout: Duration = Duration.INFINITE): InputEvent?

Hotfix readEventOrNull() https://github.com/ajalt/mordant/issues/276

step

context(scope: CoroutineScope)
fun Terminal.step(title: () -> String, activeIcon: () -> String, inactiveIcon: String, color: TextStyle, footer: String = "│", keyOptions: Map<String, KeyOption> = emptyMap(), onAnimate: (widget: Widget) -> Unit? = null, onDone: (animation: Animation<Unit>, throwable: Throwable?) -> Unit? = null, content: (status: StepStatus) -> Widget? = { null }): Pair<Animation<Unit>, Job>

context(scope: CoroutineScope)
fun Terminal.step(title: () -> String, activeIcon: () -> String, inactiveIcon: String, color: TextStyle, footer: String? = null, keyOptions: () -> Map<String, KeyOption> = { emptyMap() }, onAnimate: (widget: Widget) -> Unit? = null, onDone: (animation: Animation<Unit>, throwable: Throwable?) -> Unit? = null, onDisabled: (key: KeyPattern) -> Unit? = null, content: (status: StepStatus) -> Widget? = { null }): Pair<Animation<Unit>, Job>

synchronous

fun Terminal.synchronous(block: suspend CoroutineScope.() -> Unit): Job

warn

fun Terminal.warn(message: String, content: String? = null)

@clack/prompts log.warn()