Skip to content

module Athena::Console::Style::Interface #

Represents a "style" that provides a way to abstract how to format console input/output data such that you can reduce the amount of code needed, and to standardize the appearance.

See ACON::Style::Athena.

Custom Styles#

Custom styles can also be created by implementing this interface, and optionally extending from ACON::Style::Output which makes the style an ACON::Output::Interface as well as defining part of this interface. Then you could simply instantiate your custom style within a command as you would ACON::Style::Athena.

Direct including types

Athena::Console::Style::Output

Methods#

abstract #ask(question : String, default : _)#

Helper method for asking ACON::Question questions.

abstract #ask_hidden(question : String)#

Helper method for asking hidden ACON::Question questions.

abstract #caution(messages : String | Enumerable(String)) : Nil#

Formats and prints the provided messages within a caution block.

abstract #choice(question : String, choices : Indexable | Hash, default = nil)#

Helper method for asking ACON::Question::Choice questions.

abstract #comment(messages : String | Enumerable(String)) : Nil#

Formats and prints the provided messages within a comment block.

abstract #confirm(question : String, default : Bool = true) : Bool#

Helper method for asking ACON::Question::Confirmation questions.

abstract #error(messages : String | Enumerable(String)) : Nil#

Formats and prints the provided messages within a error block.

abstract #info(messages : String | Enumerable(String)) : Nil#

Formats and prints the provided messages within a info block.

abstract #listing(elements : Enumerable) : Nil#

Formats and prints a bulleted list containing the provided elements.

abstract #new_line(count : Int32 = 1) : Nil#

Prints count empty new lines.

abstract #note(messages : String | Enumerable(String)) : Nil#

Formats and prints the provided messages within a note block.

abstract #progress_advance(by step : Int32 = 1) : Nil#

Advances the internal ACON::Helper::ProgressBar by the provided amount of steps.

abstract #progress_finish : Nil#

Completes the internal ACON::Helper::ProgressBar.

abstract #progress_start(max : Int32 | Nil = nil) : Nil#

Starts an internal ACON::Helper::ProgressBar, optionally with the provided max amount of steps.

abstract #section(message : String) : Nil#

Creates a section header with the provided message.

abstract #success(messages : String | Enumerable(String)) : Nil#

Formats and prints the provided messages within a success block.

abstract #table(headers : Enumerable, rows : Enumerable) : Nil#

Formats and prints a table based on the provided headers and rows, followed by a new line.

abstract #text(messages : String | Enumerable(String)) : Nil#

Formats and prints the provided messages as text.

abstract #title(message : String) : Nil#

Formats and prints message as a title.

abstract #warning(messages : String | Enumerable(String)) : Nil#

Formats and prints the provided messages within a warning block.