Class: RuboCop::Cop::Style::CommentAnnotation
- Includes:
- RangeHelp, 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 `%<keyword>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 `%<keyword>s`, ' \ 'is missing a note.'
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first
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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(comment) ⇒ Object
61 62 63 64 65 66 67 68 69 |
# File 'lib/rubocop/cop/style/comment_annotation.rb', line 61 def autocorrect(comment) margin, first_word, colon, space, note = split_comment(comment) return if note.nil? length = concat_length(first_word, colon, space) range = annotation_range(comment, margin, length) ->(corrector) { corrector.replace(range, "#{first_word.upcase}: ") } end |
#investigate(processed_source) ⇒ Object
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/rubocop/cop/style/comment_annotation.rb', line 43 def investigate(processed_source) processed_source.comments.each_with_index do |comment, index| next unless first_comment_line?(processed_source.comments, index) || inline_comment?(comment) margin, first_word, colon, space, note = split_comment(comment) next unless annotation?(comment) && !correct_annotation?(first_word, colon, space, note) length = concat_length(first_word, colon, space) add_offense( comment, location: annotation_range(comment, margin, length), message: format(note ? MSG : MISSING_NOTE, keyword: first_word) ) end end |