Class: PreCommit::Message::Formatter

Inherits:

Object

• Object
• PreCommit::Message::Formatter

Defined in:

lib/plugins/pre_commit/message/formatter.rb

Overview

Responsible for format a given output

Instance Method Summary

• #format(checkstyle) ⇒ String

  Format output for a given errors details.

Instance Method Details

#format(checkstyle) ⇒ String

Format output for a given errors details

Parameters:

• checkstyle (Domain::Checkstyle) —

  Checkstyle details

Returns:

• (String) —

  formatted output or nil when has no errors

Raises:

• ArgumentError when input is empty

# File 'lib/plugins/pre_commit/message/formatter.rb', line 15

def format(checkstyle)
  throw ArgumentError.new if checkstyle.nil?
  return nil if checkstyle.good?

  format_multiple(checkstyle.bad_files)
end