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 ```
46 lines
1.4 KiB
Ruby
46 lines
1.4 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module RuboCop
|
|
module AST
|
|
# Extensions for RuboCop's AST Node class.
|
|
class Node
|
|
include RuboCop::Cask::Constants
|
|
|
|
def_node_matcher :method_node, "{$(send ...) (block $(send ...) ...)}"
|
|
def_node_matcher :block_body, "(block _ _ $_)"
|
|
def_node_matcher :cask_block?, "(block (send nil? :cask ...) args ...)"
|
|
def_node_matcher :on_system_block?,
|
|
"(block (send nil? {#{ON_SYSTEM_METHODS.map(&:inspect).join(" ")}} ...) args ...)"
|
|
def_node_matcher :arch_variable?, "(lvasgn _ (send nil? :on_arch_conditional ...))"
|
|
def_node_matcher :begin_block?, "(begin ...)"
|
|
|
|
sig { returns(T::Boolean) }
|
|
def cask_on_system_block?
|
|
(on_system_block? && each_ancestor.any?(&:cask_block?)) || false
|
|
end
|
|
|
|
def stanza?
|
|
return true if arch_variable?
|
|
|
|
case self
|
|
when RuboCop::AST::BlockNode, RuboCop::AST::SendNode
|
|
ON_SYSTEM_METHODS.include?(method_name) || STANZA_ORDER.include?(method_name)
|
|
else false
|
|
end
|
|
end
|
|
|
|
def heredoc?
|
|
loc.is_a?(Parser::Source::Map::Heredoc)
|
|
end
|
|
|
|
def location_expression
|
|
base_expression = loc.expression
|
|
descendants.select(&:heredoc?).reduce(base_expression) do |expr, node|
|
|
expr.join(node.loc.heredoc_end)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|