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 ```
93 lines
2.9 KiB
Ruby
93 lines
2.9 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 audits `deprecate!` and `disable!` dates.
|
|
class DeprecateDisableDate < FormulaCop
|
|
extend AutoCorrector
|
|
|
|
sig { override.params(formula_nodes: FormulaNodes).void }
|
|
def audit_formula(formula_nodes)
|
|
body_node = formula_nodes.body_node
|
|
|
|
[:deprecate!, :disable!].each do |method|
|
|
node = find_node_method_by_name(body_node, method)
|
|
|
|
next if node.nil?
|
|
|
|
date(node) do |date_node|
|
|
Date.iso8601(string_content(date_node))
|
|
rescue ArgumentError
|
|
fixed_date_string = Date.parse(string_content(date_node)).iso8601
|
|
offending_node(date_node)
|
|
problem "Use `#{fixed_date_string}` to comply with ISO 8601" do |corrector|
|
|
corrector.replace(date_node.source_range, "\"#{fixed_date_string}\"")
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
def_node_search :date, <<~EOS
|
|
(pair (sym :date) $str)
|
|
EOS
|
|
end
|
|
|
|
# This cop audits `deprecate!` and `disable!` reasons.
|
|
class DeprecateDisableReason < FormulaCop
|
|
extend AutoCorrector
|
|
|
|
PUNCTUATION_MARKS = %w[. ! ?].freeze
|
|
|
|
sig { override.params(formula_nodes: FormulaNodes).void }
|
|
def audit_formula(formula_nodes)
|
|
body_node = formula_nodes.body_node
|
|
|
|
[:deprecate!, :disable!].each do |method|
|
|
node = find_node_method_by_name(body_node, method)
|
|
|
|
next if node.nil?
|
|
|
|
reason_found = T.let(false, T::Boolean)
|
|
reason(node) do |reason_node|
|
|
reason_found = true
|
|
next if reason_node.sym_type?
|
|
|
|
offending_node(reason_node)
|
|
reason_string = string_content(reason_node)
|
|
|
|
if reason_string.start_with?("it ")
|
|
problem "Do not start the reason with `it`" do |corrector|
|
|
corrector.replace(@offensive_node.source_range, "\"#{reason_string[3..]}\"")
|
|
end
|
|
end
|
|
|
|
if PUNCTUATION_MARKS.include?(reason_string[-1])
|
|
problem "Do not end the reason with a punctuation mark" do |corrector|
|
|
corrector.replace(@offensive_node.source_range, "\"#{reason_string.chop}\"")
|
|
end
|
|
end
|
|
end
|
|
|
|
next if reason_found
|
|
|
|
case method
|
|
when :deprecate!
|
|
problem 'Add a reason for deprecation: `deprecate! because: "..."`'
|
|
when :disable!
|
|
problem 'Add a reason for disabling: `disable! because: "..."`'
|
|
end
|
|
end
|
|
end
|
|
|
|
def_node_search :reason, <<~EOS
|
|
(pair (sym :because) ${str sym})
|
|
EOS
|
|
end
|
|
end
|
|
end
|
|
end
|