Class: DidYouMean::VerboseFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/did_you_mean/formatters/verbose_formatter.rb

Overview

The DidYouMean::VerboseFormatter uses extra empty lines to make the suggestion stand out more in the error message.

In order to activate the verbose formatter,

Examples:


OBject
# => NameError: uninitialized constant OBject
#    Did you mean?  Object

require 'did_you_mean/verbose'

OBject
# => NameError: uninitialized constant OBject
#
#        Did you mean? Object
#

Instance Method Summary collapse

Instance Method Details

#message_for(corrections) ⇒ Object

Returns a human readable string that contains corrections. This formatter is designed to be less verbose to not take too much screen space while being helpful enough to the user.

Examples:


formatter = DidYouMean::PlainFormatter.new

puts formatter.message_for(["methods", "method"])

    Did you mean? methods
                  method

# => nil

41
42
43
44
45
46
47
# File 'lib/did_you_mean/formatters/verbose_formatter.rb', line 41

def message_for(corrections)
  return "" if corrections.empty?

  output = "\n\n    Did you mean? ".dup
  output << corrections.join("\n                  ")
  output << "\n "
end