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.8 KiB
Ruby
62 lines
1.8 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "rubocops/extend/formula_cop"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module FormulaAudit
|
|
# This cop makes sure that a `keg_only` reason has the correct format.
|
|
class KegOnly < FormulaCop
|
|
extend AutoCorrector
|
|
|
|
sig { override.params(formula_nodes: FormulaNodes).void }
|
|
def audit_formula(formula_nodes)
|
|
keg_only_node = find_node_method_by_name(formula_nodes.body_node, :keg_only)
|
|
return unless keg_only_node
|
|
|
|
allowlist = %w[
|
|
Apple
|
|
macOS
|
|
OS
|
|
Homebrew
|
|
Xcode
|
|
GPG
|
|
GNOME
|
|
BSD
|
|
Firefox
|
|
].freeze
|
|
|
|
reason = parameters(keg_only_node).first
|
|
offending_node(reason)
|
|
name = Regexp.new(@formula_name, Regexp::IGNORECASE)
|
|
reason = string_content(reason).sub(name, "")
|
|
first_word = reason.split.first
|
|
|
|
if /\A[A-Z]/.match?(reason) && !reason.start_with?(*allowlist)
|
|
problem "'#{first_word}' from the `keg_only` reason should be '#{first_word.downcase}'." do |corrector|
|
|
reason[0] = reason[0].downcase
|
|
corrector.replace(@offensive_node.source_range, "\"#{reason}\"")
|
|
end
|
|
end
|
|
|
|
return unless reason.end_with?(".")
|
|
|
|
problem "`keg_only` reason should not end with a period." do |corrector|
|
|
corrector.replace(@offensive_node.source_range, "\"#{reason.chop}\"")
|
|
end
|
|
end
|
|
|
|
def autocorrect(node)
|
|
lambda do |corrector|
|
|
reason = string_content(node)
|
|
reason[0] = reason[0].downcase
|
|
reason = reason.delete_suffix(".")
|
|
corrector.replace(node.source_range, "\"#{reason}\"")
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|