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 ```
74 lines
2.8 KiB
Ruby
74 lines
2.8 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Cask
|
|
class NoOverrides < Base
|
|
include CaskHelp
|
|
|
|
# These stanzas can be overridden by `on_*` blocks, so take them into account.
|
|
# TODO: Update this list if new stanzas are added to `Cask::DSL` that call `set_unique_stanza`.
|
|
OVERRIDEABLE_METHODS = [
|
|
:appcast, :arch, :auto_updates, :conflicts_with, :container,
|
|
:desc, :homepage, :sha256, :url, :version
|
|
].freeze
|
|
MESSAGE = "Do not use a top-level `%<stanza>s` stanza as the default. " \
|
|
"Add it to an `on_{system}` block instead. " \
|
|
"Use `:or_older` or `:or_newer` to specify a range of macOS versions."
|
|
|
|
def on_cask(cask_block)
|
|
cask_stanzas = cask_block.toplevel_stanzas
|
|
|
|
return if (on_blocks = on_system_methods(cask_stanzas)).none?
|
|
|
|
stanzas_in_blocks = on_system_stanzas(on_blocks)
|
|
|
|
cask_stanzas.each do |stanza|
|
|
# Skip if the stanza is not allowed to be overridden.
|
|
next unless OVERRIDEABLE_METHODS.include?(stanza.stanza_name)
|
|
# Skip if the stanza outside of a block is not also in an `on_*` block.
|
|
next unless stanzas_in_blocks.include?(stanza.stanza_name)
|
|
|
|
add_offense(stanza.source_range, message: format(MESSAGE, stanza: stanza.stanza_name))
|
|
end
|
|
end
|
|
|
|
def on_system_stanzas(on_system)
|
|
names = Set.new
|
|
method_nodes = on_system.map(&:method_node)
|
|
method_nodes.select(&:block_type?).each do |node|
|
|
node.child_nodes.each do |child|
|
|
child.each_node(:send) do |send_node|
|
|
# Skip (nested) livecheck blocks as its `url` is different to a download `url`.
|
|
next if send_node.method_name == :livecheck || inside_livecheck_block?(send_node)
|
|
# Skip string interpolations.
|
|
if send_node.ancestors.drop_while { |a| !a.begin_type? }.any? { |a| a.dstr_type? || a.regexp_type? }
|
|
next
|
|
end
|
|
next if RuboCop::Cask::Constants::ON_SYSTEM_METHODS.include?(send_node.method_name)
|
|
|
|
names.add(send_node.method_name)
|
|
end
|
|
end
|
|
end
|
|
names
|
|
end
|
|
|
|
def inside_livecheck_block?(node)
|
|
single_stanza_livecheck_block?(node) || multi_stanza_livecheck_block?(node)
|
|
end
|
|
|
|
def single_stanza_livecheck_block?(node)
|
|
node.parent.block_type? && node.parent.method_name == :livecheck
|
|
end
|
|
|
|
def multi_stanza_livecheck_block?(node)
|
|
grandparent_node = node.parent.parent
|
|
node.parent.begin_type? && grandparent_node.block_type? && grandparent_node.method_name == :livecheck
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|