rubocop-sorbet 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0a2efbcc17a1016f1b490abf983d6a68a20a8d0bc5652befbf1c0ba7c339f92
-  data.tar.gz: d913baa821bc1146aeb2fa831689a25556447f86a60c6e5ee63c2c4ed1f5d387
+  metadata.gz: 9ad80ed7bb1d6485194f669d289efba935cecb7adff45f542ba8ada36171a57f
+  data.tar.gz: f2129cc057c628df84b40e4ba24d376624fa6ad3e3b7a27025a53e0f5862c422
 SHA512:
-  metadata.gz: 9f928e323972868757bdc9e85ae4ccbd7ef63e763b02841375a2add43706d30b009d4370da43041ac8e4af8840dc825a2838bbe4a44438f5195cf936d370d542
-  data.tar.gz: cdccd79f16c0a668c8b4aa91f015324b5c3599490daa7ab94089f1499b5fb0d300284a15fdf2bd220cb0b2bf6224c4479e4d94ac8ac037d87fe521dd342fec6a
+  metadata.gz: 4c493e9d0aa2718629cfba7c84a8c7ec530bb5b942c273d10b8893594ef7f2cb219227e7499a0981f400d7b10f0cef986adba8c0ad480c90d84ff8c14e5ceda1
+  data.tar.gz: 5b8d8d04a8b6a77feeb11929d6a4a55804dac5f7eeccf2ed47f0b7ed0dac1b30f08cefa030d59ea623e9fe907a01f0e48ab933f6476d86bf729b0597dcc7130c

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+.rubocop-https--*

data/.rubocop.yml

@@ -0,0 +1,27 @@
+# This file strictly follows the rules defined in the Ruby style guide:
+#   http://shopify.github.io/ruby-style-guide/
+inherit_from:
+  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - lib/waffle_cone/rbi_compilers/yard_type_parser.rb
+    - vendor/**/*
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+require:
+  - rubocop-sorbet
+
+Naming/FileName:
+  Exclude:
+  - lib/rubocop-sorbet.rb
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Lint/HandleExceptions:
+  Exclude:
+  - Rakefile

data/.shopify-build/VERSION

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

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

@@ -0,0 +1,16 @@
+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"

data/.travis.yml

@@ -5,3 +5,6 @@ cache: bundler
 rvm:
   - 2.6.2
 before_install: gem install bundler -v 1.17.3
+script:
+  - bundle exec rubocop --config .rubocop.yml
+  - bundle exec rspec

data/Gemfile

@@ -1,6 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source('https://rubygems.org')
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+group(:deployment) do
+  gem('package_cloud', '~> 0.3.05')
+end
 
 # Specify your gem's dependencies in rubocop-sorbet.gemspec
 gemspec

data/Gemfile.lock

@@ -1,22 +1,97 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.1.0)
+    rubocop-sorbet (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.11.3)
-    rake (10.5.0)
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    ast (2.4.0)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    equalizer (0.0.11)
+    highline (1.6.20)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.3)
+    json_pure (1.8.1)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    netrc (0.11.0)
+    package_cloud (0.3.05)
+      highline (= 1.6.20)
+      json_pure (= 1.8.1)
+      rainbow (= 2.2.2)
+      rest-client (~> 2.0)
+      thor (~> 0.18)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    procto (0.0.3)
+    rainbow (2.2.2)
+      rake
+    rake (12.3.2)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    unicode-display_width (1.6.0)
+    unparser (0.4.5)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.3)
+      equalizer (~> 0.0.9)
+      parser (~> 2.6.3)
+      procto (~> 0.0.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  minitest (~> 5.0)
-  rake (~> 10.0)
+  package_cloud (~> 0.3.05)
+  rspec (~> 3.7)
+  rubocop (~> 0.57)
   rubocop-sorbet!
+  unparser (~> 0.4.2)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -1,8 +1,6 @@
-# Rubocop::Sorbet
+# Rubocop-Sorbet
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/sorbet`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A collection of Rubocop rules for Sorbet.
 
 ## Installation
 
@@ -16,23 +14,18 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install rubocop-sorbet
-
 ## Usage
 
-TODO: Write usage instructions here
+And add this to your `.rubocop.yml` file:
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```yaml
+require:
+  - rubocop-sorbet
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/paracycle/rubocop-sorbet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/rubocop-sorbet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +33,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rubocop::Sorbet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/paracycle/rubocop-sorbet/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rubocop::Sorbet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/rubocop-sorbet/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,10 +1,11 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+require('bundler/gem_tasks')
+
+begin
+  require('rspec/core/rake_task')
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
 end
 
-task :default => :test
+task(default: :spec)

data/bin/console

@@ -1,7 +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.
@@ -10,5 +11,5 @@ require "rubocop/sorbet"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('../bundle', __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load(Gem.bin_path('rspec-core', 'rspec'))

data/dev.yml

@@ -0,0 +1,10 @@
+name: "rubocop-sorbet"
+
+type: "ruby"
+
+up:
+  - ruby: "2.5.5"
+  - "bundler"
+
+test:
+  run: "bin/rspec"

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop disallows using `.override(allow_incompatible: true)`.
+      # Using `allow_incompatible` suggests a violation of the Liskov
+      # Substitution Principle, meaning that a subclass is not a valid
+      # subtype of it's superclass. This Cop prevents these design smells
+      # from occurring.
+      #
+      # @example
+      #
+      #   # bad
+      #   sig.override(allow_incompatible: true)
+      #
+      #   # good
+      #   sig.override
+      class AllowIncompatibleOverride < RuboCop::Cop::Cop
+        def_node_search(:sig?, <<-PATTERN)
+          (
+            send
+            nil?
+            :sig
+             ...
+          )
+        PATTERN
+
+        def not_nil?(node)
+          !node.nil?
+        end
+
+        def_node_search(:allow_incompatible?, <<-PATTERN)
+          (pair (sym :allow_incompatible) (true))
+        PATTERN
+
+        def_node_matcher(:allow_incompatible_override?, <<-PATTERN)
+          (
+            send
+            [#not_nil? #sig?]
+            :override
+            [#not_nil? #allow_incompatible?]
+          )
+        PATTERN
+
+        def on_send(node)
+          return unless allow_incompatible_override?(node)
+          add_offense(
+            node.children[2],
+            message: 'Usage of `allow_incompatible` suggests a violation of the Liskov Substitution Principle. '\
+            'Instead, strive to write interfaces which respect subtyping principles and remove `allow_incompatible`',
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop disallows binding the return value of `T.any`, `T.all`, `T.enum`
+      # to a constant directly. To bind the value, one must use `T.type_alias`.
+      #
+      # @example
+      #
+      #   # bad
+      #   FooOrBar = T.any(Foo, Bar)
+      #
+      #   # good
+      #   FooOrBar = T.type_alias(T.any(Foo, Bar))
+      class BindingConstantWithoutTypeAlias < RuboCop::Cop::Cop
+        def_node_matcher(:binding_unaliased_type?, <<-PATTERN)
+          (casgn _ _ [#not_nil? #not_t_let? #method_needing_aliasing_on_t?])
+        PATTERN
+
+        def_node_matcher(:using_type_alias?, <<-PATTERN)
+          (
+            send
+            (const nil? :T)
+            :type_alias
+            _
+          )
+        PATTERN
+
+        def_node_matcher(:t_let?, <<-PATTERN)
+          (
+            send
+            (const nil? :T)
+            :let
+            _
+            _
+          )
+        PATTERN
+
+        def_node_search(:method_needing_aliasing_on_t?, <<-PATTERN)
+          (
+            send
+            (const nil? :T)
+            {:any :all :noreturn :class_of :untyped :nilable :self_type :enum :proc}
+             ...
+          )
+        PATTERN
+
+        def not_t_let?(node)
+          !t_let?(node)
+        end
+
+        def not_nil?(node)
+          !node.nil?
+        end
+
+        def on_casgn(node)
+          return unless binding_unaliased_type?(node) && !using_type_alias?(node.children[2])
+          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`.'
+          )
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(
+              node.source_range,
+              "T.type_alias(#{node.source})"
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop disallows the usage of `checked(true)`. This usage could cause
+      # confusion; it could lead some people to believe that a method would be checked
+      # even if runtime checks have not been enabled on the class or globally.
+      # Additionally, in the event where checks are enabled, `checked(true)` would
+      # be redundant; only `checked(false)` or `soft` would change the behaviour.
+      #
+      # @example
+      #
+      #   # bad
+      #   sig { void.checked(true) }
+      #
+      #   # good
+      #   sig { void }
+      class CheckedTrueInSignature < RuboCop::Cop::Cop
+        include(RuboCop::Cop::RangeHelp)
+
+        def_node_matcher(:signature?, <<~PATTERN)
+          (block (send nil? :sig) (args) ...)
+        PATTERN
+
+        def_node_search(:offending_node, <<~PATTERN)
+          (send _ :checked (true))
+        PATTERN
+
+        MESSAGE =
+          'Using `checked(true)` in a method signature definition is not allowed. ' \
+            '`checked(true)` is the default behavior for modules/classes with runtime checks enabled. ' \
+            'To enable typechecking at runtime for this module, regardless of global settings, ' \
+            '`include(WaffleCone::RuntimeChecks)` to this module and set other methods to `checked(false)`.'
+        private_constant(:MESSAGE)
+
+        def on_block(node)
+          return unless signature?(node)
+
+          error = offending_node(node).first
+          return unless error
+
+          add_offense(
+            error,
+            location: source_range(
+              processed_source.buffer,
+              error.location.line,
+              (error.location.selector.begin_pos)..(error.location.end.begin_pos),
+            ),
+            message: MESSAGE
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop disallows the calls that are used to get constants fom Strings
+      # such as +constantize+, +const_get+, and +constants+.
+      #
+      # The goal of this cop is to make the code easier to statically analyze,
+      # more IDE-friendly, and more predictable. It leads to code that clearly
+      # expresses which values the constant can have.
+      #
+      # @example
+      #
+      #   # bad
+      #   class_name.constantize
+      #
+      #   # bad
+      #   constants.detect { |c| c.name == "User" }
+      #
+      #   # bad
+      #   const_get(class_name)
+      #
+      #   # good
+      #   case class_name
+      #   when "User"
+      #     User
+      #   else
+      #     raise ArgumentError
+      #   end
+      #
+      #   # good
+      #   { "User" => User }.fetch(class_name)
+      class ConstantsFromStrings < ::RuboCop::Cop::Cop
+        def_node_matcher(:constant_from_string?, <<-PATTERN)
+          (send _ {:constantize :constants :const_get} ...)
+        PATTERN
+
+        def on_send(node)
+          return unless constant_from_string?(node)
+          add_offense(
+            node,
+            location: :selector,
+            message: "Don't use `#{node.method_name}`, it make the code harder to understand, less editor-friendly " \
+              "and impossible to analyze. Replace `#{node.method_name}` with a case/when or a hash."
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'rubocop'
+
+# Correct `send` expressions in include statements by constant literals.
+#
+# Sorbet, the static checker, is not (yet) able to support constructs on the
+# following form:
+#
+# ```ruby
+# class MyClass
+#   include send_expr
+# end
+# ```
+#
+# This cop replaces them by:
+#
+# ```ruby
+# class MyClass
+#   MyClassInclude = send_expr
+#   include MyClassInclude
+# end
+# ```
+#
+# Multiple occurences of this can be found in Shopify's code base like:
+#
+# ```ruby
+# include Rails.application.routes.url_helpers
+# ```
+# or
+# ```ruby
+# include Polaris::Engine.helpers
+# ```
+module RuboCop
+  module Cop
+    module Sorbet
+      class ForbidIncludeConstLiteral < RuboCop::Cop::Cop
+        MSG = 'Includes must only contain constant literals'
+
+        attr_accessor :used_names
+
+        def_node_matcher :not_lit_const_include?, <<-PATTERN
+          (send nil? {:include :extend :prepend}
+            $_
+          )
+        PATTERN
+
+        def initialize(*)
+          super
+          self.used_names = Set.new
+        end
+
+        def on_send(node)
+          return unless not_lit_const_include?(node) do |send_argument|
+            ![:const, :self].include?(send_argument.type)
+          end
+          parent = node.parent
+          return unless parent
+          parent = parent.parent if [:begin, :block].include?(parent.type)
+          return unless [:module, :class, :sclass].include?(parent.type)
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            # Find parent class node
+            parent = node.parent
+            parent = parent.parent if parent.type == :begin
+
+            # Build include variable name
+            class_name = (parent.child_nodes.first.const_name || 'Anon').split('::').last
+            include_name = find_free_name("#{class_name}Include")
+            used_names << include_name
+
+            # Apply fix
+            indent = ' ' * node.loc.column
+            fix = "#{include_name} = #{node.child_nodes.first.source}\n#{indent}"
+            corrector.insert_before(node.loc.expression, fix)
+            corrector.replace(node.child_nodes.first.loc.expression, include_name)
+          end
+        end
+
+        # Find a free local variable name
+        #
+        # Since each include uses its own local variable to store the send result,
+        # we need to ensure that we don't use the same name twice in the same
+        # module.
+        def find_free_name(base_name)
+          return base_name unless used_names.include?(base_name)
+          i = 2
+          i += 1 while used_names.include?("#{base_name}#{i}")
+          "#{base_name}#{i}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'rubocop'
+
+# Correct superclass `send` expressions by constant literals.
+#
+# Sorbet, the static checker, is not (yet) able to support constructs on the
+# following form:
+#
+# ```ruby
+# class Foo < send_expr; end
+# ```
+#
+# This cop replaces them by:
+#
+# ```ruby
+# FooParent = send_expr
+# class Foo < FooParent; end
+# ```
+#
+# Multiple occurences of this can be found in Shopify's code base like:
+#
+# ```ruby
+# class ShopScope < Component::TrustedIdScope[ShopIdentity::ShopId]
+# ```
+# or
+# ```ruby
+# class ApiClientEligibility < Struct.new(:api_client, :match_results, :shop)
+# ```
+module RuboCop
+  module Cop
+    module Sorbet
+      class ForbidSuperclassConstLiteral < RuboCop::Cop::Cop
+        MSG = 'Superclasses must only contain constant literals'
+
+        def_node_matcher :not_lit_const_superclass?, <<-PATTERN
+          (class
+            (const ...)
+            (send ...)
+            ...
+          )
+        PATTERN
+
+        def on_class(node)
+          return unless not_lit_const_superclass?(node)
+          add_offense(node.child_nodes[1])
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            class_name = node.parent.child_nodes.first.const_name
+            parent_name = "#{class_name}Parent"
+            indent = ' ' * node.parent.loc.column
+            corrector.insert_before(node.parent.loc.expression, "#{parent_name} = #{node.source}\n#{indent}")
+            corrector.replace(node.loc.expression, parent_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop checks for the ordering of keyword arguments required by
+      # sorbet-runtime. The ordering requires that all keyword arguments
+      # are at the end of the parameters list, and all keyword arguments
+      # with a default value must be after those without default values.
+      #
+      # @example
+      #
+      #   # bad
+      #   sig { params(a: Integer, b: String).void }
+      #   def foo(a: 1, b:); end
+      #
+      #   # good
+      #   sig { params(b: String, a: Integer).void }
+      #   def foo(b:, a: 1); end
+      class KeywordArgumentOrdering < RuboCop::Cop::Cop
+        def_node_matcher(:signature?, <<-PATTERN)
+          (block (send nil? :sig) (args) ...)
+        PATTERN
+
+        def on_block(node)
+          return unless signature?(node)
+
+          method_node = node.parent.children[node.sibling_index + 1]
+          return if method_node.nil?
+          method_parameters = method_node.arguments
+
+          check_order_for_kwoptargs(method_parameters)
+        end
+
+        private
+
+        def check_order_for_kwoptargs(parameters)
+          out_of_kwoptarg = false
+
+          parameters.reverse.each do |param|
+            out_of_kwoptarg = true unless param.type == :kwoptarg || param.type == :blockarg
+
+            next unless param.type == :kwoptarg && out_of_kwoptarg
+
+            add_offense(
+              param,
+              message: 'Optional keyword arguments must be at the end of the parameter list.'
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop checks for inconsistent ordering of parameters between the
+      # signature and the method definition. The sorbet-runtime gem raises
+      # when such inconsistency occurs.
+      #
+      # @example
+      #
+      #   # bad
+      #   sig { params(a: Integer, b: String).void }
+      #   def foo(b:, a:); end
+      #
+      #   # good
+      #   sig { params(a: Integer, b: String).void }
+      #   def foo(a:, b:); end
+      class ParametersOrderingInSignature < RuboCop::Cop::Cop
+        def_node_matcher(:signature?, <<-PATTERN)
+          (block (send nil? :sig) (args) ...)
+        PATTERN
+
+        def_node_search(:signature_params, <<-PATTERN)
+          (send _ :params ...)
+        PATTERN
+
+        def on_block(node)
+          return unless signature?(node)
+
+          sig_params = signature_params(node).first
+          sig_params_order =
+            if sig_params.nil?
+              []
+            else
+              sig_params.arguments.first.keys.map(&:value)
+            end
+
+          method_node = node.parent.children[node.sibling_index + 1]
+          return if method_node.nil? || method_node.type != :def
+          method_parameters = method_node.arguments
+
+          check_for_inconsistent_param_ordering(sig_params_order, method_parameters)
+        end
+
+        private
+
+        def check_for_inconsistent_param_ordering(sig_params_order, parameters)
+          parameters.each_with_index do |param, index|
+            param_name = param.children[0]
+            sig_param_name = sig_params_order[index]
+
+            next if param_name == sig_param_name
+
+            add_offense(
+              param,
+              message: "Inconsistent ordering of arguments at index #{index}. " \
+              "Expected `#{sig_param_name}` from sig above."
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+begin
+  require 'unparser'
+rescue LoadError
+  nil
+end
+
+module RuboCop
+  module Cop
+    module Sorbet
+      class SignatureBuildOrder < RuboCop::Cop::Cop
+        ORDER =
+          [
+            :type_parameters,
+            :params,
+            :returns,
+            :void,
+            :abstract,
+            :implementation,
+            :override,
+            :overridable,
+            :soft,
+            :checked,
+          ].each_with_index.to_h.freeze
+
+        def_node_matcher(:signature?, <<~PATTERN)
+          (block (send nil? :sig) (args) ...)
+        PATTERN
+
+        def_node_search(:root_call, <<~PATTERN)
+          (send nil? {#{ORDER.keys.map(&:inspect).join(' ')}} ...)
+        PATTERN
+
+        def on_block(node)
+          return unless signature?(node)
+
+          calls = call_chain(node.children[2]).map(&:method_name)
+          return unless calls.any?
+
+          expected_order = calls.sort_by { |call| ORDER[call] }
+          return if expected_order == calls
+
+          message = "Sig builders must be invoked in the following order: #{expected_order.join(', ')}."
+
+          unless can_autocorrect?
+            message += ' For autocorrection, add the `unparser` gem to your project.'
+          end
+
+          add_offense(
+            node.children[2],
+            message: message,
+          )
+          node
+        end
+
+        def autocorrect(node)
+          return nil unless can_autocorrect?
+
+          lambda do |corrector|
+            nodes = call_chain(node).sort_by { |call| ORDER[call.method_name] }
+            tree =
+              nodes.reduce(nil) do |receiver, caller|
+                caller.updated(nil, [receiver] + caller.children.drop(1))
+              end
+
+            corrector.replace(
+              node.source_range,
+              Unparser.unparse(tree),
+            )
+          end
+        end
+
+        private
+
+        def can_autocorrect?
+          defined?(::Unparser)
+        end
+
+        def call_chain(sig_child_node)
+          call_node = root_call(sig_child_node).first
+          return [] unless call_node
+
+          calls = []
+          while call_node != sig_child_node
+            calls << call_node
+            call_node = call_node.parent
+          end
+
+          calls << sig_child_node
+
+          calls
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-sorbet.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rubocop_sorbet'

data/lib/rubocop_sorbet.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'rubocop/cop/sorbet/allow_incompatible_override'
+require_relative 'rubocop/cop/sorbet/binding_constants_without_type_alias'
+require_relative 'rubocop/cop/sorbet/checked_true_in_signature'
+require_relative 'rubocop/cop/sorbet/constants_from_strings'
+require_relative 'rubocop/cop/sorbet/signature_build_order'
+require_relative 'rubocop/cop/sorbet/forbid_superclass_const_literal'
+require_relative 'rubocop/cop/sorbet/forbid_include_const_literal'
+require_relative 'rubocop/cop/sorbet/parameters_ordering_in_signature'
+require_relative 'rubocop/cop/sorbet/keyword_argument_ordering'

data/rubocop-sorbet.gemspec

@@ -1,31 +1,31 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rubocop/sorbet/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "rubocop-sorbet"
-  spec.version       = Rubocop::Sorbet::VERSION
-  spec.authors       = ["Ufuk Kayserilioglu"]
-  spec.email         = ["ufuk.kayserilioglu@shopify.com"]
+  spec.name          = 'rubocop-sorbet'
+  spec.version       = '0.2.0'
+  spec.authors       = ['Ufuk Kayserilioglu']
+  spec.email         = ['ufuk.kayserilioglu@shopify.com']
 
-  spec.summary       = %q{Automatic Sorbet code style checking tool.}
-  spec.homepage      = "https://github.com/shopify/rubocop-sorbet"
-  spec.license       = "MIT"
+  spec.summary       = 'Automatic Sorbet code style checking tool.'
+  spec.homepage      = 'https://github.com/shopify/rubocop-sorbet'
+  spec.license       = 'MIT'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/shopify/rubocop-sorbet"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/shopify/rubocop-sorbet'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency('rspec', '~> 3.7')
+  spec.add_development_dependency('unparser', '~> 0.4.2')
+  spec.add_development_dependency('rubocop', '~> 0.57')
 end

data/shipit.yml

@@ -0,0 +1 @@
+# Default config

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-04 00:00:00.000000000 Z
+date: 2019-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: unparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.57'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.57'
 description: 
 email:
 - ufuk.kayserilioglu@shopify.com
@@ -60,6 +60,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".shopify-build/VERSION"
+- ".shopify-build/rubocop-sorbet.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -68,10 +71,22 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/setup
-- lib/rubocop/sorbet.rb
-- lib/rubocop/sorbet/version.rb
+- dev.yml
+- lib/rubocop-sorbet.rb
+- lib/rubocop/cop/sorbet/allow_incompatible_override.rb
+- lib/rubocop/cop/sorbet/binding_constants_without_type_alias.rb
+- lib/rubocop/cop/sorbet/checked_true_in_signature.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/keyword_argument_ordering.rb
+- lib/rubocop/cop/sorbet/parameters_ordering_in_signature.rb
+- lib/rubocop/cop/sorbet/signature_build_order.rb
+- lib/rubocop_sorbet.rb
 - rubocop-sorbet.gemspec
+- shipit.yml
 homepage: https://github.com/shopify/rubocop-sorbet
 licenses:
 - MIT
@@ -93,7 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.

data/lib/rubocop/sorbet/version.rb

@@ -1,5 +0,0 @@
-module Rubocop
-  module Sorbet
-    VERSION = "0.1.0"
-  end
-end

data/lib/rubocop/sorbet.rb

@@ -1,8 +0,0 @@
-require "rubocop/sorbet/version"
-
-module Rubocop
-  module Sorbet
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end