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

Наследует:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::Caveats

Определён в:: rubocops/caveats.rb

Обзор

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

Этот cop проверяет, что в пояснениях (caveats) нет проблемного текста или логики.

Пример

# bad
def caveats
  if File.exist?("/etc/issue")
    "This caveat only when file exists that won't work with JSON API."
  end
end

# good
def caveats
  "This caveat always works regardless of the JSON API."
end

# bad
def caveats
  <<~EOS
    Use `setuid` to allow running the executable by non-root users.
  EOS
end

# good
def caveats
  <<~EOS
    Use `sudo` to run the executable.
  EOS
end

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

Атрибуты, унаследованные от 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/caveats.rb', line 42

def audit_formula(_formula_nodes)
  caveats_strings.each do |n|
    if regex_match_group(n, /\bsetuid\b/i)
      problem "Instead of recommending `setuid` in the caveats, suggest `sudo`."
    end

    problem "Don't use ANSI escape codes in the caveats." if regex_match_group(n, /\e/)
  end

  return if formula_tap != "homebrew-core"

  # Forbid dynamic logic in caveats (only if/else/unless)
  caveats_method = find_method_def(@body, :caveats)
  return unless caveats_method

  dynamic_nodes = caveats_method.each_descendant.select do |descendant|
    descendant.type == :if
  end
  dynamic_nodes.each do |node|
    @offensive_node = node
    problem "Don't use dynamic logic (if/else/unless) in caveats."
  end
end

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