Class: RuboCop::Cop::FormulaAudit::Comments Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
rubocops/lines.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/comments.rbi

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.

DO NOT EDIT MANUALLY This is an autogenerated file for dynamic methods in RuboCop::Cop::FormulaAudit::Comments. Please instead update this file by running bin/tapioca dsl RuboCop::Cop::FormulaAudit::Comments.

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

Methods inherited from RuboCop::Cop::FormulaCop

#audit_comments, #audit_urls, #caveats_strings, #dependency_name_hash_match?, #dependency_type_hash_match?, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #required_dependency?, #required_dependency_name?, #style_exceptions_dir, #tap_style_exception?, #versioned_formula?

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 Kernel

#disk_usage_readable, #ensure_executable!, #ensure_formula_installed!, #exec_browser, #exec_editor, #ignore_interrupts, #interactive_shell, #number_readable, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #paths, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #quiet_system, #redact_secrets, #redirect_stdout, #require?, #safe_system, #tap_and_name_comparison, #truncate_text_to_approximate_size, #which, #which_all, #which_editor, #with_custom_locale, #with_env, #with_homebrew_path

Instance Method Details

#audit_formula(_node, _class_node, _parent_class_node, _body_node) ⇒ Object

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. 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'rubocops/lines.rb', line 46

def audit_formula(_node, _class_node, _parent_class_node, _body_node)
  audit_comments do |comment|
    [
      "# PLEASE REMOVE",
      "# Documentation:",
      "# if this fails, try separate make/make install steps",
      "# The URL of the archive",
      "## Naming --",
      "# if your formula fails when building in parallel",
      "# Remove unrecognized options if warned by configure",
      '# system "cmake',
    ].each do |template_comment|
      next unless comment.include?(template_comment)

      problem "Please remove default template comments"
      break
    end
  end

  audit_comments do |comment|
    # Commented-out depends_on
    next unless comment =~ /#\s*depends_on\s+(.+)\s*$/

    problem "Commented-out dependency #{Regexp.last_match(1)}"
  end

  return if formula_tap != "homebrew-core"

  # Citation and tag comments from third-party taps
  audit_comments do |comment|
    next if comment !~ /#\s*(cite(?=\s*\w+:)|doi(?=\s*['"])|tag(?=\s*['"]))/

    problem "Formulae in homebrew/core should not use `#{Regexp.last_match(1)}` comments"
  end
end