Merge pull request #171 from Shopify/uk-relax-strictness

Relax strictness of annotation RBI files

gem/lib/rbi-central.rb

@@ -64,7 +64,13 @@ module RBICentral
       Include:
       - 'rbi/**/*'
 
-    Sorbet/StrictSigil:
+    Sorbet/ValidSigil:
+      Enabled: true
+      MinimumStrictness: "true"
+      SuggestedStrictness: "true"
+      RequireSigilOnAllFiles: true
+
+    Sorbet/EnforceSignatures:
       Enabled: true
   YML
 

gem/test/rbi-central/cli/check_rubocop_test.rb

@@ -69,7 +69,7 @@ def test_rubocop_all_invalid
           }
         JSON
         @repo.write_annotations_file!("gem1", <<~RBI)
-          # typed: true
+          # typed: false
 
           module Gem1; end
         RBI
@@ -85,9 +85,9 @@ module Gem2
 
           Linting `gem1`...
 
-          Error: rbi/annotations/gem1.rbi:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true.
-          # typed: true
-          ^^^^^^^^^^^^^
+          Error: rbi/annotations/gem1.rbi:1:1: C: Sorbet/ValidSigil: Sorbet sigil should be at least true got false.
+          # typed: false
+          ^^^^^^^^^^^^^^
 
           Linting `gem2`...
 
@@ -111,7 +111,7 @@ def test_rubocop_one_invalid
           module Gem1; end
         RBI
         @repo.write_annotations_file!("gem2", <<~RBI)
-          # typed: true
+          # typed: false
 
           module Gem2; end
         RBI
@@ -121,9 +121,9 @@ module Gem2; end
 
           Linting `gem2`...
 
-          Error: rbi/annotations/gem2.rbi:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true.
-          # typed: true
-          ^^^^^^^^^^^^^
+          Error: rbi/annotations/gem2.rbi:1:1: C: Sorbet/ValidSigil: Sorbet sigil should be at least true got false.
+          # typed: false
+          ^^^^^^^^^^^^^^
 
           Some checks failed. See above for details.
         ERR

gem/test/rbi-central/cli/check_test.rb

@@ -121,10 +121,7 @@ module Gem2
 
           Linting `gem1`...
 
-          Error: rbi/annotations/gem1.rbi:1:1: C: [Correctable] Sorbet/StrictSigil: No Sorbet sigil found in file. Try a typed: strict to start (you can also use rubocop -a to automatically add this).
-          class Gem1::NotFound; end
-          ^^^^^
-          rbi/annotations/gem1.rbi:1:1: C: [Correctable] Sorbet/ValidSigil: No Sorbet sigil found in file. Try a typed: true to start (you can also use rubocop -a to automatically add this).
+          Error: rbi/annotations/gem1.rbi:1:1: C: [Correctable] Sorbet/ValidSigil: No Sorbet sigil found in file. Try a typed: true to start (you can also use rubocop -a to automatically add this).
           class Gem1::NotFound; end
           ^^^^^
 

gem/test/rbi-central/repo_test.rb

@@ -143,15 +143,15 @@ module Spoom; end
 
     def test_check_rubocop_for_invalid
       @repo.write_annotations_file!("gem1", <<~RBI)
-        # typed: true
+        # typed: false
 
         module Spoom; end
       RBI
       errors = @repo.check_rubocop_for(Gem.new(name: "gem1"))
       assert_equal(<<~ERR, errors.first&.message)
-        rbi/annotations/gem1.rbi:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true.
-        # typed: true
-        ^^^^^^^^^^^^^
+        rbi/annotations/gem1.rbi:1:1: C: Sorbet/ValidSigil: Sorbet sigil should be at least true got false.
+        # typed: false
+        ^^^^^^^^^^^^^^
       ERR
     end
 

rbi/annotations/aasm.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 module AASM
   mixes_in_class_methods(AASM::ClassMethods)

rbi/annotations/actionmailer.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class ActionMailer::Base
   sig { params(headers: T.untyped, block: T.nilable(T.proc.void)).returns(Mail::Message) }

rbi/annotations/actionpack.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class ActionController::API
   MODULES = T.let(T.unsafe(nil), T::Array[T.untyped])

rbi/annotations/actionview.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 module ActionView
   TemplateError = T.type_alias { Template::Error }

rbi/annotations/active_flag.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class ActiveRecord::Base
   # @shim: this is included at runtime https://github.com/kenn/active_flag/blob/master/lib/active_flag/railtie.rb#L6

rbi/annotations/activemodel.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class ActiveModel::Errors
   Elem = type_member { { fixed: ActiveModel::Error } }

rbi/annotations/activerecord.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class ActiveRecord::Schema
   sig {params(info: T::Hash[T.untyped, T.untyped], blk: T.proc.bind(ActiveRecord::Schema).void).void}

rbi/annotations/activesupport.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 module ActiveSupport::Testing::Declarative
   sig { params(name: String, block: T.proc.bind(T.untyped).void).void }

rbi/annotations/aws-sdk-acm.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class Aws::ACM::Client
   sig { params(params: T.untyped, options: T.untyped).returns(Aws::ACM::Types::DescribeCertificateResponse) }

rbi/annotations/bencode.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class Array
   # Bencodes the Array object. Bencoded arrays are represented as +lxe+, where

rbi/annotations/colorize.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class String
   extend Colorize::ClassMethods
@@ -106,9 +106,6 @@ class String
   sig { returns(String) }
   def red; end
 
-  sig { returns(String) }
-  def swap; end
-
   sig { returns(String) }
   def underline; end
 

rbi/annotations/configs.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 module Configs
   sig { params(name: T.any(String, Symbol)).returns(ActiveSupport::HashWithIndifferentAccess) }

rbi/annotations/delayed_job.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 module Delayed::MessageSending
   sig { params(options: T.nilable(T::Hash[Symbol, T.untyped])).returns(T.self_type) }

rbi/annotations/elasticsearch-dsl.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 module Elasticsearch::DSL::Search
   sig { params(args: T.untyped, block: T.proc.bind(Elasticsearch::DSL::Search::Search).void).void }

rbi/annotations/faraday.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 module Faraday
   class << self

rbi/annotations/globalid.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class ActiveRecord::Base
   # @shim: this is included at runtime https://github.com/rails/globalid/blob/v1.0.0/lib/global_id/railtie.rb#L38

rbi/annotations/graphql.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 module GraphQL
   class << self

rbi/annotations/kredis.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 module Kredis::Types
   sig { params(key: T.untyped, default: T.untyped, config: T.untyped, after_change: T.untyped, expires_in: T.untyped).returns(Kredis::Types::Scalar) }

rbi/annotations/lhm-shopify.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 module Lhm
   extend Lhm

rbi/annotations/lhm.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 module Lhm
   extend Lhm

rbi/annotations/mocha.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 module Mocha::API
   sig { params(arguments: T.untyped).returns(Mocha::Mock) }

rbi/annotations/parse-cron.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 # Parses cron expressions and computes the next occurence of the "job"
 class CronParser

rbi/annotations/pundit.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 module Pundit::Authorization
   sig { void }

rbi/annotations/railties.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 module Rails
   class << self

rbi/annotations/rainbow.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 module Rainbow
   # @shim: https://github.com/sickill/rainbow/blob/master/lib/rainbow.rb#L10-L12

rbi/annotations/shopify-money.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 class Money
   sig { returns(BigDecimal) }

rbi/annotations/sidekiq-scheduler.rbi

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: true
 
 class SidekiqScheduler::Scheduler
   # @shim: Instance methods are made to function as class methods using `method_missing`

rbi/annotations/sidekiq.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class Sidekiq::CLI
   sig { returns(Sidekiq::CLI) }
@@ -11,7 +11,10 @@ end
 class Sidekiq::Client
   private
 
+  sig { params(item: T.untyped).returns(T.untyped) }
   def normalize_item(item); end
+
+  sig { params(item_class: T.untyped).returns(T.untyped) }
   def normalized_hash(item_class); end
 end
 

rbi/annotations/state_machines.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class StateMachines::Machine
   include StateMachines::MatcherHelpers

rbi/annotations/stripe.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class Stripe::APIResource < Stripe::StripeObject
   Elem = type_member { { fixed: T.untyped } }
@@ -498,6 +498,7 @@ class Stripe::Invoice < Stripe::APIResource
   def subtotal; end
 
   # @method_missing: from StripeObject
+  sig { returns(T::Hash[T.untyped, T.untyped]) }
   def status_transitions; end
 end
 
@@ -525,6 +526,7 @@ class Stripe::InvoiceItem < Stripe::APIResource
 
   # unsure how to represent a StripeObject with specific keys/mmethods without causing typing errors
   # @method_missing: from StripeObject
+  sig { returns(T::Hash[T.untyped, T.untyped]) }
   def period; end
 end
 
@@ -648,6 +650,7 @@ class Stripe::Plan < Stripe::APIResource
 
   # unsure how to represent a StripeObject with specific keys/mmethods without causing typing errors
   # @method_missing: from StripeObject
+  sig { returns(T::Hash[T.untyped, T.untyped]) }
   def period; end
 
   # @method_missing: from StripeObject

rbi/annotations/webmock.rbi

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 
 class Minitest::Test
   include WebMock::API