mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
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 ```
78 lines
1.7 KiB
Ruby
78 lines
1.7 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
# Used to track formulae that cannot be installed at the same time.
|
|
FormulaConflict = Struct.new(:name, :reason)
|
|
|
|
# Used to annotate formulae that duplicate macOS-provided software
|
|
# or cause conflicts when linked in.
|
|
class KegOnlyReason
|
|
attr_reader :reason
|
|
|
|
def initialize(reason, explanation)
|
|
@reason = reason
|
|
@explanation = explanation
|
|
end
|
|
|
|
def versioned_formula?
|
|
@reason == :versioned_formula
|
|
end
|
|
|
|
def provided_by_macos?
|
|
@reason == :provided_by_macos
|
|
end
|
|
|
|
def shadowed_by_macos?
|
|
@reason == :shadowed_by_macos
|
|
end
|
|
|
|
def by_macos?
|
|
provided_by_macos? || shadowed_by_macos?
|
|
end
|
|
|
|
sig { returns(T::Boolean) }
|
|
def applicable?
|
|
# macOS reasons aren't applicable on other OSs
|
|
# (see extend/os/mac/formula_support for override on macOS)
|
|
!by_macos?
|
|
end
|
|
|
|
sig { returns(String) }
|
|
def to_s
|
|
return @explanation unless @explanation.empty?
|
|
|
|
if versioned_formula?
|
|
<<~EOS
|
|
this is an alternate version of another formula
|
|
EOS
|
|
elsif provided_by_macos?
|
|
<<~EOS
|
|
macOS already provides this software and installing another version in
|
|
parallel can cause all kinds of trouble
|
|
EOS
|
|
elsif shadowed_by_macos?
|
|
<<~EOS
|
|
macOS provides similar software and installing this software in
|
|
parallel can cause all kinds of trouble
|
|
EOS
|
|
else
|
|
@reason
|
|
end.strip
|
|
end
|
|
|
|
def to_hash
|
|
reason_string = if @reason.is_a?(Symbol)
|
|
@reason.inspect
|
|
else
|
|
@reason.to_s
|
|
end
|
|
|
|
{
|
|
"reason" => reason_string,
|
|
"explanation" => @explanation,
|
|
}
|
|
end
|
|
end
|
|
|
|
require "extend/os/formula_support"
|