45978435e7
- Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' | wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ```
63 lines
2.2 KiB
Ruby
63 lines
2.2 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "rubocops/extend/formula_cop"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module FormulaAudit
|
|
# This cop audits the service block.
|
|
class Service < FormulaCop
|
|
extend AutoCorrector
|
|
|
|
CELLAR_PATH_AUDIT_CORRECTIONS = {
|
|
bin: :opt_bin,
|
|
libexec: :opt_libexec,
|
|
pkgshare: :opt_pkgshare,
|
|
prefix: :opt_prefix,
|
|
sbin: :opt_sbin,
|
|
share: :opt_share,
|
|
}.freeze
|
|
|
|
# At least one of these methods must be defined in a service block.
|
|
REQUIRED_METHOD_CALLS = [:run, :name].freeze
|
|
|
|
sig { override.params(formula_nodes: FormulaNodes).void }
|
|
def audit_formula(formula_nodes)
|
|
service_node = find_block(formula_nodes.body_node, :service)
|
|
return if service_node.blank?
|
|
|
|
method_calls = service_node.each_descendant(:send).group_by(&:method_name)
|
|
method_calls.delete(:service)
|
|
|
|
# NOTE: Solving the first problem here might solve the second one too
|
|
# so we don't show both of them at the same time.
|
|
if !method_calls.keys.intersect?(REQUIRED_METHOD_CALLS)
|
|
offending_node(service_node)
|
|
problem "Service blocks require `run` or `name` to be defined."
|
|
elsif !method_calls.key?(:run)
|
|
other_method_calls = method_calls.keys - [:name, :require_root]
|
|
if other_method_calls.any?
|
|
offending_node(service_node)
|
|
problem "`run` must be defined to use methods other than `name` like #{other_method_calls}."
|
|
end
|
|
end
|
|
|
|
# This check ensures that cellar paths like `bin` are not referenced
|
|
# because their `opt_` variants are more portable and work with the API.
|
|
CELLAR_PATH_AUDIT_CORRECTIONS.each do |path, opt_path|
|
|
next unless method_calls.key?(path)
|
|
|
|
method_calls.fetch(path).each do |node|
|
|
offending_node(node)
|
|
problem "Use `#{opt_path}` instead of `#{path}` in service blocks." do |corrector|
|
|
corrector.replace(node.source_range, opt_path)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|