Class: RuboCop::Cop::Cask::Desc Private

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
OnDescStanza, DescHelper
Defined in:
rubocops/cask/desc.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

This cop audits desc in casks. See the DescHelper module for details of the checks.

Constant Summary

Constants included from DescHelper

DescHelper::MAX_DESC_LENGTH, DescHelper::VALID_LOWERCASE_WORDS

Instance Method Summary collapse

Methods included from DescHelper

#audit_desc, #desc_problem

Methods included from HelperFunctions

#block_method_called_in_block?, #block_size, #check_precedence, #class_name, #component_precedes?, #end_column, #expression_negated?, #find_all_blocks, #find_block, #find_blocks, #find_const, #find_every_func_call_by_name, #find_every_method_call_by_name, #find_instance_call, #find_instance_method_call, #find_method_calls_by_name, #find_method_def, #find_method_with_args, #find_node_method_by_name, #find_strings, #format_component, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_name, #node_equals?, #offending_node, #parameters, #parameters_passed?, #problem, #regex_match_group, #size, #source_buffer, #start_column, #string_content

Methods included from OnDescStanza

#on_cask, #toplevel_stanzas

Methods included from CaskHelp

#cask_tap, #inner_stanzas, #on_block, #on_cask, #on_cask_stanza_block, #on_system_methods

Instance Method Details

#on_desc_stanza(stanza) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:



18
19
20
21
22
 
# File 'rubocops/cask/desc.rb', line 18

def on_desc_stanza(stanza)
  @name = T.let(cask_block&.header&.cask_token, T.nilable(String))
  desc_call = stanza.stanza_node
  audit_desc(:cask, @name, desc_call)
end