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 ```
69 lines
1.9 KiB
Ruby
69 lines
1.9 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "formula"
|
|
require "formula_versions"
|
|
require "search"
|
|
|
|
# Helper class for printing and searching descriptions.
|
|
class Descriptions
|
|
# Given a regex, find all formulae whose specified fields contain a match.
|
|
def self.search(string_or_regex, field, cache_store,
|
|
eval_all = Homebrew::EnvConfig.eval_all?, cache_store_hash: false)
|
|
|
|
cache_store.populate_if_empty!(eval_all:) unless cache_store_hash
|
|
|
|
results = case field
|
|
when :name
|
|
Homebrew::Search.search(cache_store, string_or_regex) { |name, _| name }
|
|
when :desc
|
|
Homebrew::Search.search(cache_store, string_or_regex) { |_, desc| desc }
|
|
when :either
|
|
Homebrew::Search.search(cache_store, string_or_regex)
|
|
end
|
|
|
|
new(results)
|
|
end
|
|
|
|
# Create an actual instance.
|
|
def initialize(descriptions)
|
|
@descriptions = descriptions
|
|
end
|
|
|
|
# Take search results -- a hash mapping formula names to descriptions -- and
|
|
# print them.
|
|
def print
|
|
blank = Formatter.warning("[no description]")
|
|
@descriptions.keys.sort.each do |full_name|
|
|
short_name = short_names[full_name]
|
|
printed_name = if short_name_counts[short_name] == 1
|
|
short_name
|
|
else
|
|
full_name
|
|
end
|
|
description = @descriptions[full_name] || blank
|
|
if description.is_a?(Array)
|
|
names = description[0]
|
|
description = description[1] || blank
|
|
puts "#{Tty.bold}#{printed_name}:#{Tty.reset} (#{names}) #{description}"
|
|
else
|
|
puts "#{Tty.bold}#{printed_name}:#{Tty.reset} #{description}"
|
|
end
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
def short_names
|
|
@short_names ||= @descriptions.keys.to_h { |k| [k, k.split("/").last] }
|
|
end
|
|
|
|
def short_name_counts
|
|
@short_name_counts ||=
|
|
short_names.values
|
|
.each_with_object(Hash.new(0)) do |name, counts|
|
|
counts[name] += 1
|
|
end
|
|
end
|
|
end
|