rubocop-sorbet 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 309687789d8de94ff0cc8c0d64361cd227ab332ffdd16ab0248d588639dfcd80
-  data.tar.gz: ca39d50843f2e577ed0a0328c9707e21af175daacd8c92b9b4403bc2195c4cff
+  metadata.gz: bd3fcc1ddd15ba9418aeb852d83149b3594fb315c7aa77ab4641c9046466d109
+  data.tar.gz: 2b446c026647ebb8d312e8be0034af253f61dc5ac8903c2b75bf42c11be903fe
 SHA512:
-  metadata.gz: f774385eec35af24755af1cc5e7f5de554bedf0f6a475e3235879aee61a2c68a818ea87ca4663daa17bb807c862d911264284d1f3270e852166c3e84cde32e7d
-  data.tar.gz: d6d91114e9c70bc64fa5adf6679a689c12263caa352f7f38b6d96d36609a81e90bc18f369e42b1605259262626114aac6fd5d50f7c91bced3e2f24e2f606fbc4
+  metadata.gz: dd23c876c6224baf1a3888c169291b6260286326329d9b48650d1c4113571257837e0fa96d12b4357d4aee62e78b20e1be6373295b0d1e7d065c139e8cf3e25f
+  data.tar.gz: 12c3c8aae878c4474284fd41f79da1f4671399bb8e1f01403fe556d36e25274d951f42771ecd0dfc0c3527686b0f3aa1a0d3a22db9b7287c802adf9c43cbc718

data/.github/release.yml

@@ -0,0 +1,23 @@
+# release.yml
+
+changelog:
+  exclude:
+    labels:
+      - dependencies
+      - chore
+    authors:
+      - dependabot
+  categories:
+    - title: 🚧 Breaking Changes
+      labels:
+        - breaking-change
+    - title: ✨ Enhancements
+      labels:
+        - enhancement
+        - feature
+    - title: 🐛 Bug Fixes
+      labels:
+        - bugfix
+    - title: 🛠 Other Changes
+      labels:
+        - "*"

data/Gemfile.lock

@@ -1,33 +1,21 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.6.2)
-      rubocop
+    rubocop-sorbet (0.6.3)
+      rubocop (>= 0.90.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    abstract_type (0.0.7)
-    adamantium (0.2.0)
-      ice_nine (~> 0.11.0)
-      memoizable (~> 0.4.0)
-    ast (2.4.0)
+    ast (2.4.2)
     byebug (11.1.3)
-    concord (0.1.5)
-      adamantium (~> 0.2.0)
-      equalizer (~> 0.0.9)
     diff-lcs (1.3)
-    equalizer (0.0.11)
-    ice_nine (0.11.2)
-    memoizable (0.4.2)
-      thread_safe (~> 0.3, >= 0.3.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    procto (0.0.3)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.0)
+    regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -42,30 +30,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    rubocop (0.85.0)
+    rubocop (1.16.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-shopify (1.0.3)
-      rubocop (~> 0.85.0)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    unicode-display_width (1.7.0)
-    unparser (0.4.7)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      concord (~> 0.1.5)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-shopify (2.1.0)
+      rubocop (~> 1.13)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+    unparser (0.6.0)
       diff-lcs (~> 1.3)
-      equalizer (~> 0.0.9)
-      parser (>= 2.6.5)
-      procto (~> 0.0.2)
+      parser (>= 3.0.0)
     yard (0.9.25)
 
 PLATFORMS
@@ -77,7 +59,7 @@ DEPENDENCIES
   rspec
   rubocop-shopify
   rubocop-sorbet!
-  unparser
+  unparser (~> 0.6)
   yard (~> 0.9)
 
 BUNDLED WITH

data/README.md

@@ -60,6 +60,15 @@ RuboCop::RakeTask.new do |task|
 end
 ```
 
+### Rubocop rules for RBI files
+
+Put this into your `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  rubocop-sorbet: config/rbi.yml
+```
+
 ## The Cops
 All cops are located under [`lib/rubocop/cop/sorbet`](lib/rubocop/cop/sorbet), and contain examples/documentation.
 
@@ -94,6 +103,12 @@ bundle exec rake new_cop[Sorbet/NewCopName]
 
 which will create a skeleton cop, a skeleton spec, an entry in the default config file and will require the new cop so that it is properly exported from the gem.
 
+Don't forget to update the documentation with:
+
+```sh
+bundle exec rake generate_cops_documentation
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/rubocop-sorbet/blob/master/LICENSE.txt).

data/Rakefile

@@ -1,40 +1,36 @@
 # frozen_string_literal: true
 
-require('bundler/gem_tasks')
+require("bundler/gem_tasks")
 
-Dir['tasks/**/*.rake'].each { |t| load t }
+Dir["tasks/**/*.rake"].each { |t| load t }
 
-require 'rubocop/rake_task'
-require 'rspec/core/rake_task'
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
-task(default: %i[
-  documentation_syntax_check
-  generate_cops_documentation
-  spec
-])
+task(default: [:documentation_syntax_check, :generate_cops_documentation, :spec])
 
-desc('Generate a new cop with a template')
+desc("Generate a new cop with a template")
 task :new_cop, [:cop] do |_task, args|
-  require 'rubocop'
+  require "rubocop"
 
   cop_name = args.fetch(:cop) do
-    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    warn("usage: bundle exec rake new_cop[Department/Name]")
     exit!
   end
 
   github_user = %x(git config github.user).chop
-  github_user = 'Shopify' if github_user.empty?
+  github_user = "Shopify" if github_user.empty?
 
   generator = RuboCop::Cop::Generator.new(cop_name, github_user)
 
   generator.write_source
   generator.write_spec
-  generator.inject_require(root_file_path: 'lib/rubocop/cop/sorbet_cops.rb')
-  generator.inject_config(config_file_path: 'config/default.yml')
+  generator.inject_require(root_file_path: "lib/rubocop/cop/sorbet_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
 
   puts generator.todo
 end

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'rubocop/sorbet'
+require "bundler/setup"
+require "rubocop/sorbet"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'rubocop/sorbet'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/bin/rspec

@@ -8,11 +8,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('../bundle', __FILE__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
   if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
@@ -23,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load(Gem.bin_path('rspec-core', 'rspec'))
+load(Gem.bin_path("rspec-core", "rspec"))

data/config/default.yml

@@ -16,7 +16,8 @@ Sorbet/BindingConstantWithoutTypeAlias:
 
 Sorbet/CallbackConditionalsBinding:
   Description: 'Ensures callback conditionals are bound to the right type.'
-  Enabled: true
+  Enabled: false
+  Safe: false
   VersionAdded: 0.7.0
 
 Sorbet/CheckedTrueInSignature:
@@ -38,6 +39,11 @@ Sorbet/EnforceSigilOrder:
   Enabled: true
   VersionAdded: 0.3.4
 
+Sorbet/sigils/EnforceSingleSigil:
+  Description: 'Ensures that there is only one Sorbet sigil in a file.'
+  Enabled: true
+  VersionAdded: '<<next>>'
+
 Sorbet/EnforceSignatures:
   Description: 'Ensures all methods have a valid signature.'
   Enabled: false
@@ -49,10 +55,7 @@ Sorbet/FalseSigil:
   VersionAdded: 0.3.3
   SuggestedStrictness: "false"
   Include:
-  - "**/*.rb"
-  - "**/*.rbi"
-  - "**/*.rake"
-  - "**/*.ru"
+  - "**/*.{rb,rbi,rake,ru}"
   Exclude:
   - bin/**/*
   - db/**/*.rb
@@ -65,10 +68,12 @@ Sorbet/ForbidExtendTSigHelpersInShims:
   Include:
   - "**/*.rbi"
 
-Sorbet/ForbidRBIOutsideOfSorbetDir:
-  Description: 'Forbids RBI files outside of the sorbet/ directory.'
+Sorbet/ForbidRBIOutsideOfAllowedPaths:
+  Description: 'Forbids RBI files outside of the allowed paths'
   Enabled: true
   VersionAdded: 0.6.1
+  AllowedPaths:
+  - "sorbet/rbi/**"
   Include:
   - "**/*.rbi"
 
@@ -105,12 +110,24 @@ Sorbet/HasSigil:
   SuggestedStrictness: "false"
   MinimumStrictness: "false"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/IgnoreSigil:
   Description: 'All files must be at least at strictness `ignore`.'
   Enabled: false
   SuggestedStrictness: "ignore"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/KeywordArgumentOrdering:
   Description: >-
@@ -127,11 +144,6 @@ Sorbet/OneAncestorPerLine:
   Enabled: false
   VersionAdded: '0.6.0'
 
-Sorbet/ParametersOrderingInSignature:
-  Description: 'Enforces same parameter order between a method and its signature.'
-  Enabled: true
-  VersionAdded: 0.2.0
-
 Sorbet/SignatureBuildOrder:
   Description: >-
                   Enforces the order of parts in a signature.
@@ -154,18 +166,36 @@ Sorbet/StrictSigil:
   Enabled: false
   SuggestedStrictness: "strict"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/StrongSigil:
   Description: 'All files must be at least at strictness `strong`.'
   Enabled: false
   SuggestedStrictness: "strong"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/TrueSigil:
   Description: 'All files must be at least at strictness `true`.'
   Enabled: false
   SuggestedStrictness: "true"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
 
 Sorbet/ValidSigil:
   Description: 'All files must have a valid sigil.'
@@ -174,3 +204,9 @@ Sorbet/ValidSigil:
   SuggestedStrictness: "false"
   MinimumStrictness: "false"
   VersionAdded: 0.3.3
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*

data/config/rbi.yml

@@ -0,0 +1,262 @@
+require:
+  - rubocop-sorbet
+
+AllCops:
+  TargetRubyVersion: 3.0
+  DisabledByDefault: true
+  Include:
+    - '**/*.rbi'
+
+## Layout
+
+Layout/AccessModifierIndentation:
+  Enabled: true
+
+Layout/ArgumentAlignment:
+  Enabled: true
+
+Layout/BlockAlignment:
+  Enabled: true
+
+Layout/BlockEndNewline:
+  Enabled: true
+
+Layout/ClassStructure:
+  Enabled: true
+  ExpectedOrder:
+    - module_inclusion
+    - macros
+    - public_attribute_macros
+    - protected_attribute_macros
+    - private_attribute_macros
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
+    - public_class_methods
+    - constants
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: true
+
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyComment:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+  AllowAdjacentOneLineDefs: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+Layout/EmptyLinesAroundArguments:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+Layout/ExtraSpacing:
+  Enabled: true
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Layout/FirstMethodParameterLineBreak:
+  Enabled: true
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+
+Layout/IndentationConsistency:
+  Enabled: true
+
+Layout/IndentationStyle:
+  Enabled: true
+  EnforcedStyle: spaces
+
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/LeadingEmptyLines:
+  Enabled: true
+
+# TODO: make Tapioca break long lines?
+Layout/LineLength:
+  Enabled: false
+
+Layout/MultilineBlockLayout:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+
+Layout/ParameterAlignment:
+  Enabled: true
+
+Layout/RedundantLineBreak:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterMethodName:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Layout/SpaceBeforeSemicolon:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+## Lint
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/EmptyFile:
+  Enabled: true
+  AllowComments: false
+
+Lint/SyntaxError:
+  Enabled: true
+
+## Sorbet
+
+Sorbet:
+  DisabledByDefault: true
+
+Sorbet/EnforceSigilOrder:
+  Enabled: true
+
+Sorbet/ForbidExtendTSigHelpersInShims:
+  Enabled: true
+
+Sorbet/ForbidIncludeConstLiteral:
+  Enabled: true
+
+Sorbet/ForbidSuperclassConstLiteral:
+  Enabled: true
+
+Sorbet/OneAncestorPerLine:
+  Enabled: true
+
+Sorbet/SignatureBuildOrder:
+  Enabled: true
+
+Sorbet/SingleLineRbiClassModuleDefinitions:
+  Enabled: true
+
+Sorbet/ValidSigil:
+  Enabled: true
+  RequireSigilOnAllFiles: true
+  MinimumStrictness: "false"
+  SuggestedStrictness: "true"
+
+## Style
+
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: compact
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Style/EmptyMethod:
+  Enabled: true
+  EnforcedStyle: compact
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: never
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoreMacros: true
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/MixinGrouping:
+  Enabled: true
+  EnforcedStyle: separated
+
+Style/MixinUsage:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: true
+  EnforcedStyle: forbidden

data/lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
 module RuboCop
   module Cop
@@ -94,16 +94,16 @@ module RuboCop
             add_offense(
               node.children[2],
               message: "It looks like you're using the old `T.type_alias` syntax. " \
-              '`T.type_alias` now expects a block.' \
+              "`T.type_alias` now expects a block." \
               'Run Sorbet with the options "--autocorrect --error-white-list=5043" ' \
-              'to automatically upgrade to the new syntax.'
+              "to automatically upgrade to the new syntax."
             )
             return
           end
           add_offense(
             node.children[2],
             message: "It looks like you're trying to bind a type to a constant. " \
-            'To do this, you must alias the type using `T.type_alias`.'
+            "To do this, you must alias the type using `T.type_alias`."
           )
         end