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 ```
62 lines
1.9 KiB
Ruby
62 lines
1.9 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Homebrew
|
|
# This cop checks for the use of `FileUtils.rm_f`, `FileUtils.rm_rf`, or `{FileUtils,instance}.rmtree`
|
|
# and recommends the safer versions.
|
|
class NoFileutilsRmrf < Base
|
|
extend AutoCorrector
|
|
|
|
MSG = "Use `rm` or `rm_r` instead of `rm_rf`, `rm_f`, or `rmtree`."
|
|
|
|
def_node_matcher :any_receiver_rm_r_f?, <<~PATTERN
|
|
(send
|
|
{(const {nil? cbase} :FileUtils) (self)}
|
|
{:rm_rf :rm_f}
|
|
...)
|
|
PATTERN
|
|
|
|
def_node_matcher :no_receiver_rm_r_f?, <<~PATTERN
|
|
(send nil? {:rm_rf :rm_f} ...)
|
|
PATTERN
|
|
|
|
def_node_matcher :no_receiver_rmtree?, <<~PATTERN
|
|
(send nil? :rmtree ...)
|
|
PATTERN
|
|
|
|
def_node_matcher :any_receiver_rmtree?, <<~PATTERN
|
|
(send !nil? :rmtree ...)
|
|
PATTERN
|
|
|
|
def on_send(node)
|
|
return if neither_rm_rf_nor_rmtree?(node)
|
|
|
|
add_offense(node) do |corrector|
|
|
class_name = "FileUtils." if any_receiver_rm_r_f?(node) || any_receiver_rmtree?(node)
|
|
new_method = if node.method?(:rm_rf) || node.method?(:rmtree)
|
|
"rm_r"
|
|
else
|
|
"rm"
|
|
end
|
|
|
|
args = if any_receiver_rmtree?(node)
|
|
node.receiver&.source || node.arguments.first&.source
|
|
else
|
|
node.arguments.first.source
|
|
end
|
|
args = "(#{args})" unless args.start_with?("(")
|
|
corrector.replace(node.loc.expression, "#{class_name}#{new_method}#{args}")
|
|
end
|
|
end
|
|
|
|
def neither_rm_rf_nor_rmtree?(node)
|
|
!any_receiver_rm_r_f?(node) && !no_receiver_rm_r_f?(node) &&
|
|
!any_receiver_rmtree?(node) && !no_receiver_rmtree?(node)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|