Sha256: 7ab0c346efe31db4bd1e73c6a25e9cf6754b47a4c807af536508a5d2c61db213
Contents?: true
Size: 1.43 KB
Versions: 3
Compression:
Stored size: 1.43 KB
Contents
# frozen_string_literal: true require_relative 'base_error' require_relative '../documentation_link' module Reek module Errors # Gets raised when trying to configure a detector which is unknown to us. # This might happen for multiple reasons. The users might have a typo in # his comment or he might use a detector that does not exist anymore. class BadDetectorInCommentError < BaseError UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE.freeze Error: You are trying to configure an unknown smell detector '%<detector>s' in one of 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: * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')} * what smell detectors are available: #{DocumentationLink.build('Code Smells')} Update the offensive comment (or remove it if no longer applicable) and re-run Reek. MESSAGE def initialize(detector_name:, source:, line:, original_comment:) message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE, detector: detector_name, source: source, line: line, comment: original_comment) super(message) end end end end
Version data entries
3 entries across 3 versions & 1 rubygems
Version | Path |
---|---|
reek-6.4.0 | lib/reek/errors/bad_detector_in_comment_error.rb |
reek-6.3.0 | lib/reek/errors/bad_detector_in_comment_error.rb |
reek-6.2.0 | lib/reek/errors/bad_detector_in_comment_error.rb |