Exception: Reek::Errors::LegacyCommentSeparatorError

Inherits:
BaseError
  • Object
show all
Defined in:
lib/reek/errors/legacy_comment_separator_error.rb

Overview

Gets raised for old-style comment configuration format.

Constant Summary collapse

MESSAGE = 
<<-MESSAGE.freeze
  Error: You are using the legacy configuration format (including three
  colons) to configure Reek in one your source code comments.

  The source is '%<source>s' and the comment belongs to the expression
  starting in line %<line>d.

  Here's the original comment:

  %<comment>s

  Please see the Reek docs for information on how to configure Reek via
  source code comments: #{DocumentationLink.build('Smell Suppression')}

  Update the offensive comment and re-run Reek.

MESSAGE

Instance Method Summary collapse

Methods inherited from BaseError

#long_message

Constructor Details

#initialize(source:, line:, original_comment:) ⇒ LegacyCommentSeparatorError

Returns a new instance of LegacyCommentSeparatorError.



27
28
29
30
31
32
33
 
# File 'lib/reek/errors/legacy_comment_separator_error.rb', line 27

def initialize(source:, line:, original_comment:)
  message = format(MESSAGE,
                   source: source,
                   line: line,
                   comment: original_comment)
  super(message)
end