rubocop-sorbet 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aceacd9544f68f9fa77c04eb851f4b9c950ae807bcd6acba40343930e1e09c60
+  data.tar.gz: 32568e235724593175627d5e27bf08fde7465bd0faaadf130f24928336ffa80c
+SHA512:
+  metadata.gz: 7c373c8ab61cb4801f0e15acc68d959d4b5dcc517a958083067b30461f3d6d1095b4c57ebf65e6e0c84ae5c50c2bfa3f8a5dc3c43809020315a5f02c1e82107f
+  data.tar.gz: fc0e8c2beaae55bd7d041c26c18d4bb33fe12531e024ac99ade345bd4854c7196a3717af0f605408f4f9b50ab6dd77db368862c946547063b853980f4de5831b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/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

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ufuk@paralaus.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    rubocop-sorbet (0.0.2)
+
+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)
+    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
+  package_cloud (~> 0.3.05)
+  rspec (~> 3.7)
+  rubocop (~> 0.57)
+  rubocop-sorbet!
+  unparser (~> 0.4.2)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ufuk Kayserilioglu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Rubocop-Sorbet
+
+A collection of Rubocop rules for Sorbet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-sorbet'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+And add this to your `.rubocop.yml` file:
+
+```yaml
+require:
+  - rubocop-sorbet
+```
+
+## Contributing
+
+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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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/Shopify/rubocop-sorbet/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require('bundler/gem_tasks')
+
+begin
+  require('rspec/core/rake_task')
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task(default: :spec)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+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/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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-sorbet.rb

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

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,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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-sorbet'
+  spec.version       = '0.0.2'
+  spec.authors       = ['Ufuk Kayserilioglu']
+  spec.email         = ['ufuk.kayserilioglu@shopify.com']
+
+  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'
+
+  # 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
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  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

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-sorbet
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ufuk Kayserilioglu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+description: 
+email:
+- ufuk.kayserilioglu@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".shopify-build/VERSION"
+- ".shopify-build/rubocop-sorbet.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- 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
+metadata:
+  homepage_uri: https://github.com/shopify/rubocop-sorbet
+  source_code_uri: https://github.com/shopify/rubocop-sorbet
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Automatic Sorbet code style checking tool.
+test_files: []