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.5 KiB
Ruby
46 lines
1.5 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Cask
|
|
# Common functionality for cops checking casks.
|
|
module CaskHelp
|
|
prepend CommentsHelp # Update the rbi file if changing this: https://github.com/sorbet/sorbet/issues/259
|
|
|
|
sig { overridable.params(cask_block: RuboCop::Cask::AST::CaskBlock).void }
|
|
def on_cask(cask_block); end
|
|
|
|
sig { overridable.params(cask_stanza_block: RuboCop::Cask::AST::StanzaBlock).void }
|
|
def on_cask_stanza_block(cask_stanza_block); end
|
|
|
|
sig { params(block_node: RuboCop::AST::BlockNode).void }
|
|
def on_block(block_node)
|
|
super if defined? super
|
|
|
|
return if !block_node.cask_block? && !block_node.cask_on_system_block?
|
|
|
|
comments = comments_in_range(block_node).to_a
|
|
stanza_block = RuboCop::Cask::AST::StanzaBlock.new(block_node, comments)
|
|
on_cask_stanza_block(stanza_block)
|
|
|
|
return unless block_node.cask_block?
|
|
|
|
cask_block = RuboCop::Cask::AST::CaskBlock.new(block_node, comments)
|
|
on_cask(cask_block)
|
|
end
|
|
|
|
def on_system_methods(cask_stanzas)
|
|
cask_stanzas.select(&:on_system_block?)
|
|
end
|
|
|
|
def inner_stanzas(block_node, comments)
|
|
block_contents = block_node.child_nodes.select(&:begin_type?)
|
|
inner_nodes = block_contents.map(&:child_nodes).flatten.select(&:send_type?)
|
|
inner_nodes.map { |n| RuboCop::Cask::AST::Stanza.new(n, comments) }
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|