Merge pull request #9297 from reitermarkus/brew-typecheck

Refactor `brew typecheck` and upgrade `typed` sigils.

Library/Homebrew/cask/artifact/prefpane.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "cask/artifact/moved"

Library/Homebrew/cask/artifact/suite.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "cask/artifact/moved"

Library/Homebrew/cask/cmd/abstract_internal_command.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Cask

Library/Homebrew/cask/cmd/cat.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Cask

Library/Homebrew/cask/cmd/internal_help.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Cask

Library/Homebrew/cmd/--cellar.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/cmd/--prefix.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/cmd/--repository.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/cmd/--version.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/cmd/analytics.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/cmd/autoremove.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/cmd/cleanup.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cleanup"

Library/Homebrew/cmd/config.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "system_config"

Library/Homebrew/cmd/gist-logs.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/cmd/leaves.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/cmd/link.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "ostruct"

Library/Homebrew/cmd/migrate.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "migrator"

Library/Homebrew/cmd/missing.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/cmd/pin.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/cmd/postinstall.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "sandbox"

Library/Homebrew/cmd/readall.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "readall"

Library/Homebrew/cmd/switch.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/cmd/tap.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/cmd/unlink.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "ostruct"

Library/Homebrew/cmd/unpin.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/cmd/untap.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/compat/language/haskell.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Language

Library/Homebrew/dev-cmd/bump-revision.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/dev-cmd/bump.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/dev-cmd/command.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "commands"

Library/Homebrew/dev-cmd/dispatch-build-bottle.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/dev-cmd/diy.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/dev-cmd/edit.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/dev-cmd/formula.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/dev-cmd/install-bundler-gems.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "formula"

Library/Homebrew/dev-cmd/linkage.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cache_store"

Library/Homebrew/dev-cmd/livecheck.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/dev-cmd/mirror.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "bintray"

Library/Homebrew/dev-cmd/release-notes.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/dev-cmd/style.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "json"

Library/Homebrew/dev-cmd/typecheck.rb

@@ -22,6 +22,9 @@ module Homebrew
              description: "Silence all non-critical errors."
       switch "--update",
              description: "Update RBI files."
+      switch "--suggest-typed",
+             description: "Try upgrading `typed` sigils.",
+             depends_on:  "--update"
       switch "--fail-if-not-changed",
              description: "Return a failing status code if all gems are up to date " \
                           "and gem definitions do not need a tapioca update."
@@ -38,6 +41,7 @@ module Homebrew
     end
   end
 
+  sig { void }
   def typecheck
     args = typecheck_args.parse
 
@@ -50,12 +54,44 @@ module Homebrew
         system "bundle", "exec", "srb", "rbi", "hidden-definitions"
         system "bundle", "exec", "srb", "rbi", "todo"
 
+        if args.suggest_typed?
+          result = system_command(
+            "bundle",
+            args:         ["exec", "--", "srb", "tc", "--suggest-typed", "--typed=strict", "--error-white-list=7022"],
+            print_stderr: false,
+          )
+
+          allowed_changes = {
+            "false" => ["true", "strict"],
+            "true"  => ["strict"],
+          }
+
+          # Workaround for `srb tc rbi suggest-typed`, which currently fails get to a converging state.
+          result.stderr.scan(/^(.*\.rb):\d+:\s+You could add `#\s*typed:\s*(.*?)`/).each do |path, new_level|
+            path = Pathname(path)
+
+            next unless path.file?
+
+            contents = path.read
+
+            next unless (match = contents.match(/\A\s*#\s*typed:\s*([^\s]+)/))
+
+            existing_level = match[1]
+
+            next unless allowed_changes.fetch(existing_level, []).include?(new_level)
+
+            puts "#{path}: #{existing_level} -> #{new_level}"
+            path.atomic_write contents.sub(/\A(\s*#\s*typed:\s*)(?:[^\s]+)/, "\\1#{new_level}")
+          end
+        end
+
         Homebrew.failed = system("git", "diff", "--stat", "--exit-code") if args.fail_if_not_changed?
 
         return
       end
 
       srb_exec = %w[bundle exec srb tc]
+      srb_exec << "--error-black-list" << "5061"
       srb_exec << "--quiet" if args.quiet?
       srb_exec << "--autocorrect" if args.fix?
       srb_exec += ["--ignore", args.ignore] if args.ignore.present?

Library/Homebrew/dev-cmd/update-license-data.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/dev-cmd/update-python-resources.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "cli/parser"

Library/Homebrew/extend/os/linux/requirements/xcode_requirement.rb

@@ -1,9 +1,12 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 require "requirement"
 
 class XcodeRequirement < Requirement
+  extend T::Sig
+
+  sig { returns(T::Boolean) }
   def xcode_installed_version
     true
   end

Library/Homebrew/extend/os/mac/extend/ENV/shared.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module SharedEnvExtension

Library/Homebrew/extend/os/requirements/xcode_requirement.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 require "extend/os/linux/requirements/xcode_requirement" if OS.linux?

Library/Homebrew/formula_text_auditor.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Homebrew

Library/Homebrew/language/node.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Language

Library/Homebrew/requirement.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "dependable"

Library/Homebrew/requirements/linux_requirement.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 # A requirement on Linux.

Library/Homebrew/requirements/xcode_requirement.rb

@@ -20,6 +20,7 @@ class XcodeRequirement < Requirement
     super(tags)
   end
 
+  sig { returns(T::Boolean) }
   def xcode_installed_version
     return false unless MacOS::Xcode.installed?
     return true unless @version

Library/Homebrew/resource.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "download_strategy"

Library/Homebrew/resource_auditor.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Homebrew

Library/Homebrew/rubocops/cask/extend/string.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 # Utility method extensions for String.

Library/Homebrew/sorbet/config

@@ -9,6 +9,3 @@
 
 --dsl-plugins
 sorbet/triggers.yml
-
---error-black-list
-5061

Library/Homebrew/system_command.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "open3"

Library/Homebrew/test/support/helper/cmd/brew-verify-formula-undefined.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 require "cli/parser"

docs/Manpage.md

@@ -1269,6 +1269,8 @@ Check for typechecking errors using Sorbet.
   Silence all non-critical errors.
 * `--update`:
   Update RBI files.
+* `--suggest-typed`:
+  Try upgrading `typed` sigils.
 * `--fail-if-not-changed`:
   Return a failing status code if all gems are up to date and gem definitions do not need a tapioca update.
 * `--dir`:

manpages/brew.1

@@ -1753,6 +1753,10 @@ Silence all non\-critical errors\.
 Update RBI files\.
 .
 .TP
+\fB\-\-suggest\-typed\fR
+Try upgrading \fBtyped\fR sigils\.
+.
+.TP
 \fB\-\-fail\-if\-not\-changed\fR
 Return a failing status code if all gems are up to date and gem definitions do not need a tapioca update\.
 .