Argos/onl.ycode.argos.terminal/MarkdownTerminal

MarkdownTerminal

class MarkdownTerminal(useStdErr: Boolean = false) : StateTerminal(source)

Terminal implementation that outputs Markdown-formatted text.

This terminal converts style information to Markdown markup:

Strong text: **bold**
Parameters: ` `code` `
Errors: ~~strikethrough~~
HTML escaping: < and > characters are escaped to < and >

Useful for generating documentation or when output will be processed by Markdown renderers.

Parameters

useStdErr

Whether to output to standard error instead of standard output

Constructors

MarkdownTerminal

constructor(useStdErr: Boolean = false)

Properties

infoColumn

open val infoColumn: Int

Column position for aligning help text descriptions.

width

open val width: Int

The terminal width in characters for text wrapping. Defaults to system terminal width.

Functions

closingError

open override fun closingError()

Outputs closing Markdown markup for error text (double tildes).

closingParam

open override fun closingParam()

Outputs closing Markdown markup for parameter/code text (backtick).

closingPlain

open fun closingPlain()

Called when closing plain text formatting.

closingStrong

open override fun closingStrong()

Outputs closing Markdown markup for strong/bold text (double asterisks).

emitError

open override fun emitError(text: String)

Emits text formatted as an error message.

emitNewLine

open fun emitNewLine()

Emits a platform-appropriate newline sequence.

emitParam

open override fun emitParam(text: String)

Emits text formatted as a parameter (e.g., option names, values).

emitPlain

open override fun emitPlain(text: String)

Emits plain text without any formatting.

emitStrong

open override fun emitStrong(text: String)

Emits text with strong/bold formatting. Default implementation outputs as plain text.

endEmit

open override fun endEmit()

Called after completing a sequence of text emissions. Override for cleanup operations.

openingError

open override fun openingError(previous: ContentStyle)

Outputs Markdown markup for error text (double tildes for strikethrough).

openingParam

open override fun openingParam(previous: ContentStyle)

Outputs Markdown markup for parameter/code text (backtick).

openingPlain

open fun openingPlain(previous: ContentStyle)

Called when transitioning to plain text formatting.

openingStrong

open override fun openingStrong(previous: ContentStyle)

Outputs Markdown markup for strong/bold text (double asterisks).

sendText

open override fun sendText(text: String)

Sends text to the output stream with HTML escaping.

startEmit

open override fun startEmit()

Called before starting a sequence of text emissions. Override for setup operations.