Module: CommandKit::Printing

Includes:

Stdio

Included in:

Command, ExceptionHandler, Options::Parser

Defined in:

lib/command_kit/printing.rb,
lib/command_kit/printing/indent.rb

Overview

Provides printing methods.

Defined Under Namespace

Modules: Indent

Constant Summary

EOL =

Platform independency new-line constant

Returns:

• (String)

$/

Instance Method Summary

• #print_error(message) ⇒ Object

  Prints the error message to stderr.

• #print_exception(error) ⇒ Object

  Prints an exception to stderr.

Methods included from Stdio

#abort, #gets, #initialize, #print, #printf, #putc, #puts, #readline, #readlines, #stderr, #stdin, #stdout

Instance Method Details

#print_error(message) ⇒ Object

Prints the error message to stderr.

Examples:

print_error "Error: invalid input"

Parameters:

• message (String) —

  The error message.

# File 'lib/command_kit/printing.rb', line 30

def print_error(message)
  stderr.puts message
end

#print_exception(error) ⇒ Object

Prints an exception to stderr.

Examples:

begin
  # ...
rescue => error
  print_error "Error encountered"
  print_exception(error)
  exit(1)
end

Parameters:

• error (Exception) —

  The error to print.

# File 'lib/command_kit/printing.rb', line 51

def print_exception(error)
  print_error error.full_message(highlight: stderr.tty?)
end