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.

View source

abstract #ask_hidden(question : String) #

Helper method for asking hidden ACON::Question questions.

View source

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

Formats and prints the provided messages within a caution block.

View source

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

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

View source

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

Formats and prints the provided messages within a comment block.

View source

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

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

View source

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

Formats and prints the provided messages within a error block.

View source

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

Formats and prints the provided messages within a info block.

View source

abstract #listing(elements : Enumerable) : Nil #

Formats and prints a bulleted list containing the provided elements.

View source

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

Prints count empty new lines.

View source

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

Formats and prints the provided messages within a note block.

View source

abstract #section(message : String) : Nil #

Creates a section header with the provided message.

View source

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

Formats and prints the provided messages within a success block.

View source

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

Formats and prints the provided messages as text.

View source

abstract #title(message : String) : Nil #

Formats and prints message as a title.

View source

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

Formats and prints the provided messages within a warning block.

View source