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 ```
43 lines
1.3 KiB
Ruby
43 lines
1.3 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Cask
|
|
# This cop corrects `caveats { discontinued }` to `deprecate!`.
|
|
class Discontinued < Base
|
|
include CaskHelp
|
|
extend AutoCorrector
|
|
|
|
MESSAGE = "Use `deprecate!` instead of `caveats { discontinued }`."
|
|
|
|
def on_cask_stanza_block(stanza_block)
|
|
stanza_block.stanzas.select(&:caveats?).each do |stanza|
|
|
find_discontinued_method_call(stanza.stanza_node) do |node|
|
|
if caveats_contains_only_discontinued?(node.parent)
|
|
add_offense(node.parent, message: MESSAGE) do |corrector|
|
|
corrector.replace(node.parent.source_range,
|
|
"deprecate! date: \"#{Date.today}\", because: :discontinued")
|
|
end
|
|
else
|
|
add_offense(node, message: MESSAGE)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
def_node_matcher :caveats_contains_only_discontinued?, <<~EOS
|
|
(block
|
|
(send nil? :caveats)
|
|
(args)
|
|
(send nil? :discontinued))
|
|
EOS
|
|
|
|
def_node_search :find_discontinued_method_call, <<~EOS
|
|
$(send nil? :discontinued)
|
|
EOS
|
|
end
|
|
end
|
|
end
|
|
end
|