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 ```
126 lines
3.3 KiB
Ruby
126 lines
3.3 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 formulae that are keg-only because they are provided by macos.
|
|
class ProvidedByMacos < FormulaCop
|
|
PROVIDED_BY_MACOS_FORMULAE = %w[
|
|
apr
|
|
bc
|
|
berkeley-db
|
|
bison
|
|
bzip2
|
|
cups
|
|
curl
|
|
cyrus-sasl
|
|
dyld-headers
|
|
ed
|
|
expat
|
|
file-formula
|
|
flex
|
|
gnu-getopt
|
|
gperf
|
|
icu4c
|
|
krb5
|
|
libarchive
|
|
libedit
|
|
libffi
|
|
libiconv
|
|
libpcap
|
|
libressl
|
|
libxcrypt
|
|
libxml2
|
|
libxslt
|
|
llvm
|
|
lsof
|
|
m4
|
|
ncompress
|
|
ncurses
|
|
net-snmp
|
|
netcat
|
|
openldap
|
|
pax
|
|
pcsc-lite
|
|
pod2man
|
|
rpcgen
|
|
ruby
|
|
sqlite
|
|
ssh-copy-id
|
|
swift
|
|
tcl-tk
|
|
unifdef
|
|
unzip
|
|
whois
|
|
zip
|
|
zlib
|
|
].freeze
|
|
|
|
sig { override.params(formula_nodes: FormulaNodes).void }
|
|
def audit_formula(formula_nodes)
|
|
return if (body_node = formula_nodes.body_node).nil?
|
|
|
|
find_method_with_args(body_node, :keg_only, :provided_by_macos) do
|
|
return if PROVIDED_BY_MACOS_FORMULAE.include? @formula_name
|
|
|
|
problem "Formulae that are `keg_only :provided_by_macos` should be " \
|
|
"added to the `PROVIDED_BY_MACOS_FORMULAE` list (in the Homebrew/brew repo)"
|
|
end
|
|
end
|
|
end
|
|
|
|
# This cop audits `uses_from_macos` dependencies in formulae.
|
|
class UsesFromMacos < FormulaCop
|
|
# These formulae aren't `keg_only :provided_by_macos` but are provided by
|
|
# macOS (or very similarly, e.g. OpenSSL where system provides LibreSSL).
|
|
# TODO: consider making some of these keg-only.
|
|
ALLOWED_USES_FROM_MACOS_DEPS = %w[
|
|
bash
|
|
cpio
|
|
expect
|
|
git
|
|
groff
|
|
gzip
|
|
less
|
|
mandoc
|
|
openssl
|
|
perl
|
|
php
|
|
python
|
|
rsync
|
|
vim
|
|
xz
|
|
zsh
|
|
].freeze
|
|
|
|
sig { override.params(formula_nodes: FormulaNodes).void }
|
|
def audit_formula(formula_nodes)
|
|
return if (body_node = formula_nodes.body_node).nil?
|
|
|
|
depends_on_linux = depends_on?(:linux)
|
|
|
|
find_method_with_args(body_node, :uses_from_macos, /^"(.+)"/).each do |method|
|
|
@offensive_node = method
|
|
problem "`uses_from_macos` should not be used when Linux is required." if depends_on_linux
|
|
|
|
dep = if parameters(method).first.instance_of?(RuboCop::AST::StrNode)
|
|
parameters(method).first
|
|
elsif parameters(method).first.instance_of?(RuboCop::AST::HashNode)
|
|
parameters(method).first.keys.first
|
|
end
|
|
|
|
dep_name = string_content(dep)
|
|
next if ALLOWED_USES_FROM_MACOS_DEPS.include? dep_name
|
|
next if ProvidedByMacos::PROVIDED_BY_MACOS_FORMULAE.include? dep_name
|
|
|
|
problem "`uses_from_macos` should only be used for macOS dependencies, not #{dep_name}."
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|