rubocop-sorbet 0.4.1 → 0.6.2

data/manual/cops_sorbet.md

@@ -41,6 +41,37 @@ FooOrBar = T.any(Foo, Bar)
 FooOrBar = T.type_alias { T.any(Foo, Bar) }
 ```
 
+## Sorbet/CallbackConditionalsBinding
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.7.0 | -
+
+This cop ensures that callback conditionals are bound to the right type
+so that they are type checked properly.
+
+### Examples
+
+```ruby
+# bad
+class Post < ApplicationRecord
+  before_create :do_it, if: -> { should_do_it? }
+
+  def should_do_it?
+    true
+  end
+end
+
+# good
+class Post < ApplicationRecord
+  before_create :do_it, if: -> { T.bind(self, Post).should_do_it? }
+
+  def should_do_it?
+    true
+  end
+end
+```
+
 ## Sorbet/CheckedTrueInSignature
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -167,31 +198,115 @@ This cop makes the Sorbet `false` sigil mandatory in all files.
 
 Name | Default value | Configurable values
 --- | --- | ---
-SuggestedStrictness | `true` | Boolean
+SuggestedStrictness | `false` | String
 Include | `**/*.rb`, `**/*.rbi`, `**/*.rake`, `**/*.ru` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
 
+## Sorbet/ForbidExtendTSigHelpersInShims
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.6.0 | -
+
+This cop ensures RBI shims do not include a call to extend T::Sig
+or to extend T::Helpers
+
+### Examples
+
+```ruby
+# bad
+module SomeModule
+  extend T::Sig
+  extend T::Helpers
+
+  sig { returns(String) }
+  def foo; end
+end
+
+# good
+module SomeModule
+  sig { returns(String) }
+  def foo; end
+end
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+Include | `**/*.rbi` | Array
+
 ## Sorbet/ForbidIncludeConstLiteral
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Enabled | Yes | Yes  | 0.2.0 | -
+Disabled | Yes | No | 0.2.0 | 0.5.0
 
 No documentation
 
+## Sorbet/ForbidRBIOutsideOfSorbetDir
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | 0.6.1 | -
+
+This cop makes sure that RBI files are always located under sorbet/rbi/.
+
+### Examples
+
+```ruby
+# bad
+lib/some_file.rbi
+other_file.rbi
+
+# good
+sorbet/rbi/some_file.rbi
+sorbet/rbi/any/path/for/file.rbi
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+Include | `**/*.rbi` | Array
+
 ## Sorbet/ForbidSuperclassConstLiteral
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Enabled | Yes | Yes  | 0.2.0 | -
+Disabled | Yes | No | 0.2.0 | 0.6.1
 
 No documentation
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+Exclude | `db/migrate/*.rb` | Array
+
+## Sorbet/ForbidTUnsafe
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | No | 0.7.0 | 0.7.0
+
+This cop disallows using `T.unsafe` anywhere.
+
+### Examples
+
+```ruby
+# bad
+T.unsafe(foo)
+
+# good
+foo
+```
+
 ## Sorbet/ForbidUntypedStructProps
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
-Enabled | Yes | No | 0.3.8 | -
+Enabled | Yes | No | 0.4.0 | -
 
 This cop disallows use of `T.untyped` or `T.nilable(T.untyped)`
 as a prop type for `T::Struct`.
@@ -227,6 +342,13 @@ Options:
 
 If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `false` | String
+MinimumStrictness | `false` | String
+
 ## Sorbet/IgnoreSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -235,6 +357,12 @@ Disabled | Yes | Yes  | 0.3.3 | -
 
 This cop makes the Sorbet `ignore` sigil mandatory in all files.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `ignore` | String
+
 ## Sorbet/KeywordArgumentOrdering
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -258,6 +386,30 @@ sig { params(b: String, a: Integer).void }
 def foo(b:, a: 1); end
 ```
 
+## Sorbet/OneAncestorPerLine
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | Yes  | 0.6.0 | -
+
+This cop ensures one ancestor per requires_ancestor line
+rather than chaining them as a comma-separated list.
+
+### Examples
+
+```ruby
+# bad
+module SomeModule
+  requires_ancestor Kernel, Minitest::Assertions
+end
+
+# good
+module SomeModule
+  requires_ancestor Kernel
+  requires_ancestor Minitest::Assertions
+end
+```
+
 ## Sorbet/ParametersOrderingInSignature
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -298,6 +450,32 @@ Abstract cop specific to Sorbet signatures
 
 You can subclass it to use the `on_signature` trigger and the `signature?` node matcher.
 
+## Sorbet/SingleLineRbiClassModuleDefinitions
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Disabled | Yes | Yes  | 0.6.0 | -
+
+This cop ensures empty class/module definitions in RBI files are
+done on a single line rather than being split across multiple lines.
+
+### Examples
+
+```ruby
+# bad
+module SomeModule
+end
+
+# good
+module SomeModule; end
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+Include | `**/*.rbi` | Array
+
 ## Sorbet/StrictSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -306,6 +484,12 @@ Disabled | Yes | Yes  | 0.3.3 | -
 
 This cop makes the Sorbet `strict` sigil mandatory in all files.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `strict` | String
+
 ## Sorbet/StrongSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -314,6 +498,12 @@ Disabled | Yes | Yes  | 0.3.3 | -
 
 This cop makes the Sorbet `strong` sigil mandatory in all files.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `strong` | String
+
 ## Sorbet/TrueSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -322,6 +512,12 @@ Disabled | Yes | Yes  | 0.3.3 | -
 
 This cop makes the Sorbet `true` sigil mandatory in all files.
 
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+SuggestedStrictness | `true` | String
+
 ## Sorbet/ValidSigil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -338,3 +534,11 @@ Options:
 * `MinimumStrictness`: If set, make offense if the strictness level in the file is below this one
 
 If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+RequireSigilOnAllFiles | `false` | Boolean
+SuggestedStrictness | `false` | String
+MinimumStrictness | `false` | String

data/service.yml

@@ -1,6 +1,3 @@
-# https://services.shopify.io/services/rubocop-sorbet/production
-owners:
-  - Shopify/sorbet
 classification: library
 slack_channels:
-  - help-ruby-typing
+- help-ruby-typing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -65,11 +65,10 @@ files:
 - ".github/CODEOWNERS"
 - ".github/probots.yml"
 - ".github/stale.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".shopify-build/VERSION"
-- ".shopify-build/rubocop-sorbet.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -79,15 +78,22 @@ files:
 - Rakefile
 - bin/console
 - bin/rspec
+- bin/rubocop
 - bin/setup
 - config/default.yml
 - dev.yml
 - lib/rubocop-sorbet.rb
 - lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
+- lib/rubocop/cop/sorbet/callback_conditionals_binding.rb
 - lib/rubocop/cop/sorbet/constants_from_strings.rb
 - lib/rubocop/cop/sorbet/forbid_include_const_literal.rb
 - lib/rubocop/cop/sorbet/forbid_superclass_const_literal.rb
+- lib/rubocop/cop/sorbet/forbid_t_unsafe.rb
 - lib/rubocop/cop/sorbet/forbid_untyped_struct_props.rb
+- lib/rubocop/cop/sorbet/one_ancestor_per_line.rb
+- lib/rubocop/cop/sorbet/rbi/forbid_extend_t_sig_helpers_in_shims.rb
+- lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_sorbet_dir.rb
+- lib/rubocop/cop/sorbet/rbi/single_line_rbi_class_module_definitions.rb
 - lib/rubocop/cop/sorbet/sigils/enforce_sigil_order.rb
 - lib/rubocop/cop/sorbet/sigils/false_sigil.rb
 - lib/rubocop/cop/sorbet/sigils/has_sigil.rb
@@ -135,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.

data/.shopify-build/VERSION

@@ -1 +0,0 @@
-v1

data/.shopify-build/rubocop-sorbet.yml

@@ -1,16 +0,0 @@
-containers:
-  default:
-    docker: "circleci/ruby:2.5.5"
-
-steps:
-- label: ":ruby: Specs"
-  dependencies:
-  - "bundler"
-  timeout: "5m"
-  run:
-  - "bundle exec rspec"
-- label: "Rubocop"
-  dependencies:
-  - "bundler"
-  timeout: "5m"
-  run: "bundle exec rubocop"