Класс: RuboCop::Cop::FormulaAudit::Comments Приватный

Наследует:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::Comments

Определён в:: rubocops/lines.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/comments.rbi

Обзор

Этот класс является частью приватного API. Этот класс можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого класса, поскольку он может быть удалён или изменён без предупреждения.

Этот cop проверяет, что шаблонные комментарии удалены.

Краткое описание атрибутов экземпляра

Атрибуты, унаследованные от RuboCop::Cop::FormulaCop

#file_path

Краткое описание методов экземпляра свернуть

#audit_formula(_formula_nodes) ⇒ void приватный

Методы, унаследованные от 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?

Методы, включённые из HelperFunctions

#block_method_called_in_block?, #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, #source_buffer, #start_column, #string_content

Подробное описание методов экземпляра

#audit_formula(_formula_nodes) ⇒ `void`

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Этот метод возвращает неопределённое значение.

Параметры:

_formula_nodes (FormulaNodes)

# File 'rubocops/lines.rb', line 52

def audit_formula(_formula_nodes)
  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

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/RuboCop/Cop/FormulaAudit/Comments.html