Class: RuboCop::Cop::Naming::UncommunicativeBlockParamName
- Includes:
- UncommunicativeName
- Defined in:
- lib/rubocop/cop/naming/uncommunicative_block_param_name.rb
Overview
This cop checks block parameter names for how descriptive they are. It is highly configurable.
The ‘MinNameLength` config option takes an integer. It represents the minimum amount of characters the name must be. Its default is 1. The `AllowNamesEndingInNumbers` config option takes a boolean. When set to false, this cop will register offenses for names ending with numbers. Its default is false. The `AllowedNames` config option takes an array of whitelisted names that will never register an offense. The `ForbiddenNames` config option takes an array of blacklisted names that will always register an offense.
Constant Summary
Constants included from UncommunicativeName
UncommunicativeName::CASE_MSG, UncommunicativeName::FORBIDDEN_MSG, UncommunicativeName::LENGTH_MSG, UncommunicativeName::NUM_MSG
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods included from UncommunicativeName
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
#on_block(node) ⇒ Object
41 42 43 44 45 |
# File 'lib/rubocop/cop/naming/uncommunicative_block_param_name.rb', line 41 def on_block(node) return unless node.arguments? check(node, node.arguments) end |