mordant/com.github.ajalt.mordant.terminal

Package-level declarations

Types

class ConfirmationPrompt<T : Any>(firstPrompt: Prompt<T>, secondPrompt: Prompt<T>, valueMismatchMessage: String = "Values do not match, try again")

A prompt that requires the user to enter the same value twice.

ConversionResult

sealed class ConversionResult<out T>

CursorMovements

interface CursorMovements

PrintRequest

data class PrintRequest(val text: String, val trailingLinebreak: Boolean, val stderr: Boolean)

Prompt

abstract class Prompt<T>(prompt: String, val terminal: Terminal, default: T? = null, showDefault: Boolean = true, showChoices: Boolean = true, hideInput: Boolean = false, choices: Collection<T> = emptyList(), promptSuffix: String = ": ", invalidChoiceMessage: String = "Invalid value, choose from ")

The base class for prompts.

StandardTerminalInterface

abstract class StandardTerminalInterface : TerminalInterface

A base class for terminal interfaces that prints using standard kotlin.io functions.

StringPrompt

class StringPrompt(prompt: String, terminal: Terminal, default: String? = null, showDefault: Boolean = false, showChoices: Boolean = true, hideInput: Boolean = false, choices: List<String> = emptyList(), promptSuffix: String = ": ", invalidChoiceMessage: String = "Invalid value, choose from ", allowBlank: Boolean = true) : Prompt<String>

A Prompt that returns the user input unchanged.

Terminal

class Terminal

Functions for printing styled text to the terminal.

TerminalCursor

interface TerminalCursor

TerminalDetection

object TerminalDetection

Detect information about the current terminal.

TerminalInfo

data class TerminalInfo(var ansiLevel: AnsiLevel, var ansiHyperLinks: Boolean, val outputInteractive: Boolean, val inputInteractive: Boolean, val supportsAnsiCursor: Boolean)

Information about the current terminal

TerminalInterface

interface TerminalInterface

TerminalInterfaceProvider

interface TerminalInterfaceProvider

A provider for a TerminalInterface.

TerminalRecorder

class TerminalRecorder : TerminalInterface

A TerminalInterface that records all output and allows you to provide input.

TimeoutException

class TimeoutException : RuntimeException

YesNoPrompt

class YesNoPrompt(prompt: String, terminal: Terminal, default: Boolean? = null, uppercaseDefault: Boolean = true, showChoices: Boolean = true, choiceStrings: List<String> = listOf("y", "n"), promptSuffix: String = ": ", invalidChoiceMessage: String = "Invalid value, choose from ") : Prompt<Boolean>

A boolean prompt that asks for a yes or no response.

Functions

danger

fun Terminal.danger(message: Any?, whitespace: Whitespace = Whitespace.PRE, align: TextAlign = TextAlign.NONE, overflowWrap: OverflowWrap = OverflowWrap.NORMAL, width: Int? = null, stderr: Boolean = false)

Print a line styled with the theme's Theme.danger style.

info

fun Terminal.info(message: Any?, whitespace: Whitespace = Whitespace.PRE, align: TextAlign = TextAlign.NONE, overflowWrap: OverflowWrap = OverflowWrap.NORMAL, width: Int? = null, stderr: Boolean = false)

Print a line styled with the theme's Theme.info style.

muted

fun Terminal.muted(message: Any?, whitespace: Whitespace = Whitespace.PRE, align: TextAlign = TextAlign.NONE, overflowWrap: OverflowWrap = OverflowWrap.NORMAL, width: Int? = null, stderr: Boolean = false)

Print a line styled with the theme's Theme.muted style.

outputAsHtml

fun TerminalRecorder.outputAsHtml(includeBodyTag: Boolean = true, includeCodeTag: Boolean = true, backgroundColor: Color? = SRGB("#0c0c0c")): String

Render the contents of this TerminalRecorder as an HTML document.

prompt

fun Terminal.prompt(prompt: String, default: String? = null, showDefault: Boolean = true, showChoices: Boolean = true, hideInput: Boolean = false, choices: Collection<String> = emptyList(), promptSuffix: String = ": ", invalidChoiceMessage: String = "Invalid value, choose from "): String?

Print a prompt to the user and return the value they enter.

inline fun <T> Terminal.prompt(prompt: String, default: T? = null, showDefault: Boolean = true, showChoices: Boolean = true, hideInput: Boolean = false, choices: Collection<T> = emptyList(), promptSuffix: String = ": ", invalidChoiceMessage: String = "Invalid value, choose from ", crossinline convert: (String) -> ConversionResult<T>): T?

success

fun Terminal.success(message: Any?, whitespace: Whitespace = Whitespace.PRE, align: TextAlign = TextAlign.NONE, overflowWrap: OverflowWrap = OverflowWrap.NORMAL, width: Int? = null, stderr: Boolean = false)

Print a line styled with the theme's Theme.success style.

warning

fun Terminal.warning(message: Any?, whitespace: Whitespace = Whitespace.PRE, align: TextAlign = TextAlign.NONE, overflowWrap: OverflowWrap = OverflowWrap.NORMAL, width: Int? = null, stderr: Boolean = false)

Print a line styled with the theme's Theme.warning style.