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 ```
50 lines
1.4 KiB
Ruby
50 lines
1.4 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Homebrew
|
|
# Checks to make sure safe navigation isn't used with `blank?` in
|
|
# a conditional.
|
|
#
|
|
# NOTE: While the safe navigation operator is generally a good idea, when
|
|
# checking `foo&.blank?` in a conditional, `foo` being `nil` will actually
|
|
# do the opposite of what the author intends:
|
|
#
|
|
# ```ruby
|
|
# foo&.blank? #=> nil
|
|
# foo.blank? #=> true
|
|
# ```
|
|
#
|
|
# ### Example
|
|
#
|
|
# ```ruby
|
|
# # bad
|
|
# do_something if foo&.blank?
|
|
# do_something unless foo&.blank?
|
|
#
|
|
# # good
|
|
# do_something if foo.blank?
|
|
# do_something unless foo.blank?
|
|
# ```
|
|
class SafeNavigationWithBlank < Base
|
|
extend AutoCorrector
|
|
|
|
MSG = "Avoid calling `blank?` with the safe navigation operator in conditionals."
|
|
|
|
def_node_matcher :safe_navigation_blank_in_conditional?, <<~PATTERN
|
|
(if $(csend ... :blank?) ...)
|
|
PATTERN
|
|
|
|
def on_if(node)
|
|
return unless safe_navigation_blank_in_conditional?(node)
|
|
|
|
add_offense(node) do |corrector|
|
|
corrector.replace(safe_navigation_blank_in_conditional?(node).location.dot, ".")
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|