Class: RuboCop::Cop::Style::CommentAnnotation
- Includes:
- AnnotationComment
- Defined in:
- lib/rubocop/cop/style/comment_annotation.rb
Overview
This cop checks that comment annotation keywords are written according to guidelines.
Constant Summary collapse
- MSG =
'Annotation keywords like `%s` should be all upper case, ' \ 'followed by a colon, and a space, ' \ 'then a note describing the problem.'
- MISSING_NOTE =
'Annotation comment, with keyword `%s`, ' \ 'is missing a note.'
Constants included from Util
Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods inherited from Cop
#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search
Methods included from AutocorrectLogic
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?
Methods included from IgnoredNode
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?
Methods included from PathUtil
hidden?, issue_deprecation_warning, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#investigate(processed_source) ⇒ Object
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/rubocop/cop/style/comment_annotation.rb', line 17 def investigate(processed_source) processed_source.comments.each_with_index do |comment, ix| next unless first_comment_line?(processed_source.comments, ix) margin, first_word, colon, space, note = split_comment(comment) next unless annotation?(comment) && !correct_annotation?(first_word, colon, space, note) start = comment.loc.expression.begin_pos + margin.length length = first_word.length + colon.to_s.length + space.to_s.length source_buffer = comment.loc.expression.source_buffer range = Parser::Source::Range.new(source_buffer, start, start + length) if note add_offense(comment, range, format(MSG, first_word)) else add_offense(comment, range, format(MISSING_NOTE, first_word)) end end end |