standard-sorbet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ad98617b4e4b4d22f2d305b050f9890646f42ca9bfa03ac7ac5d1f5d2a4871d
+  data.tar.gz: 25a4118c83cb23ed9d34ef27c84b0e41b5885c009c40032945c69aa1eee1fe2e
+SHA512:
+  metadata.gz: 9cac41956b8601604981a8b27ebe1c2d3b838039e538d31e345e5d342248de189344836c37fde8ca90ff00c45fcb6864453685184963614634f2e4acbfa174d0
+  data.tar.gz: a8cf15a2301f2db6ebcf755e4a76a88cc01da64196a3cc2decf2224f3710faf44e6b6cd7bbe37aea2a8c9b6a56aaae2b57140b0bef0a7445962f9079b3c74132

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.7

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.0.1]
+
+- Initial release. All rules in `config/base.yml` are set to the defaults of
+rubocop-sorbet until we develop some contrary opinions!

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+gem "rake"
+gem "minitest"
+gem "standard"
+gem "m"

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    standard-sorbet (0.0.1)
+      lint_roller (~> 1.0)
+      rubocop-sorbet (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    m (1.6.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (1.0.0)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-sorbet (0.7.0)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.13.0)
+    standard (1.30.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  m
+  minitest
+  rake
+  standard
+  standard-sorbet!
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Test Double, Inc.
+
+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,32 @@
+# standard-sorbet
+
+This gem provides a [lint_roller](https://github.com/standardrb/lint_roller)
+plugin configuration for the
+[rubocop-sorbet](https://github.com/Shopify/rubocop-sorbet) ruleset to be run
+as part of `standardrb` and `rake standard` in your project.
+
+To install it, add it to your Gemfile:
+
+```ruby
+gem "standard-sorbet"
+```
+
+## Configuration
+
+In your `.standard.yml` file in your project root, add `standard-sorbet` as a
+plugin:
+
+```yaml
+plugins:
+  - standard-sorbet
+```
+
+## Code of Conduct
+
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+including (but not limited to) one-on-one communications, public posts/comments,
+code reviews, pull requests, and GitHub issues. If violations occur, Test Double
+will take any action they deem appropriate for the infraction, up to and
+including blocking a user from the organization's repositories.
+

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+desc "Verify linting works in example project"
+task :lint_test do
+  puts "-----> Running standardrb in example/"
+  output = `cd example; bundle exec standardrb`
+  if output.include?("type_check_me.rb:1:1: Sorbet/FalseSigil: Invalid Sorbet sigil `banana`.")
+    puts "Standard violation detected in example/ app as expected"
+  else
+    fail "Expected linting violation not detected. Ensure `cd example; bundle exec standardrb' fails with a violation."
+  end
+end
+
+task default: %i[test standard:fix lint_test]

data/config/base.yml

@@ -0,0 +1,86 @@
+Sorbet/AllowIncompatibleOverride:
+  Enabled: true
+
+Sorbet/BindingConstantWithoutTypeAlias:
+  Enabled: true
+
+Sorbet/CallbackConditionalsBinding:
+  Enabled: false
+
+Sorbet/CheckedTrueInSignature:
+  Enabled: true
+
+Sorbet/EmptyLineAfterSig:
+  Enabled: true
+
+Sorbet/ConstantsFromStrings:
+  Enabled: true
+
+Sorbet/EnforceSigilOrder:
+  Enabled: true
+
+Sorbet/EnforceSingleSigil:
+  Enabled: true
+
+Sorbet/EnforceSignatures:
+  Enabled: false
+
+Sorbet/FalseSigil:
+  Enabled: true
+
+Sorbet/ForbidExtendTSigHelpersInShims:
+  Enabled: true
+
+Sorbet/ForbidRBIOutsideOfAllowedPaths:
+  Enabled: true
+
+Sorbet/ForbidIncludeConstLiteral:
+  Enabled: false
+
+Sorbet/ForbidSuperclassConstLiteral:
+  Enabled: false
+
+Sorbet/ForbidTUnsafe:
+  Enabled: false
+
+Sorbet/ForbidTUntyped:
+  Enabled: false
+
+Sorbet/ForbidUntypedStructProps:
+  Enabled: true
+
+Sorbet/HasSigil:
+  Enabled: false
+
+Sorbet/IgnoreSigil:
+  Enabled: false
+
+Sorbet/KeywordArgumentOrdering:
+  Enabled: true
+
+Sorbet/OneAncestorPerLine:
+  Enabled: false
+
+Sorbet/RedundantExtendTSig:
+  Enabled: false
+
+Sorbet/SignatureBuildOrder:
+  Enabled: true
+
+Sorbet/SingleLineRbiClassModuleDefinitions:
+  Enabled: false
+
+Sorbet/StrictSigil:
+  Enabled: false
+
+Sorbet/StrongSigil:
+  Enabled: false
+
+Sorbet/TrueSigil:
+  Enabled: false
+
+Sorbet/TypeAliasName:
+  Enabled: true
+
+Sorbet/ValidSigil:
+  Enabled: true

data/lib/standard/sorbet/plugin.rb

@@ -0,0 +1,57 @@
+module Standard::Sorbet
+  class Plugin < LintRoller::Plugin
+    def initialize(config)
+      @config = config
+      @merges_upstream_metadata = Standard::PluginSupport::MergesUpstreamMetadata.new
+    end
+
+    def about
+      LintRoller::About.new(
+        name: "standard-sorbet",
+        version: VERSION,
+        homepage: "https://github.com/standardrb/standard-sorbet",
+        description: "Configuration for rubocop-sorbet's rules"
+      )
+    end
+
+    def supported?(context)
+      true
+    end
+
+    def rules(context)
+      trick_rubocop_into_thinking_we_required_rubocop_sorbet!
+
+      rules = @merges_upstream_metadata.merge(
+        YAML.load_file(Pathname.new(__dir__).join("../../../config/base.yml")),
+        YAML.load_file(Pathname.new(Gem.loaded_specs["rubocop-sorbet"].full_gem_path).join("config/default.yml"))
+      )
+
+      LintRoller::Rules.new(
+        type: :object,
+        config_format: :rubocop,
+        value: rules
+      )
+    end
+
+    private
+
+    # This is not fantastic.
+    #
+    # When you `require "rubocop-sorbet"`, it will not only load the cops,
+    # but it will also monkey-patch RuboCop's default_configuration, which is
+    # something that can't be undone for the lifetime of the process.
+    #
+    # See: https://github.com/Shopify/rubocop-sorbet/blob/main/lib/rubocop/sorbet/inject.rb
+    #
+    # As an alternative, standard-sorbet loads the cops directly, and then
+    # simply tells the RuboCop config loader that it's been loaded. This is
+    # taking advantage of a private API of an `attr_reader` that probably wasn't
+    # meant to be mutated externally, but it's better than the `Inject` monkey
+    # patching that rubocop-sorbet does (and many other RuboCop plugins do)
+    def trick_rubocop_into_thinking_we_required_rubocop_sorbet!
+      require "rubocop"
+      require "rubocop/cop/sorbet_cops"
+      RuboCop::ConfigLoader.default_configuration.loaded_features.add("rubocop-sorbet")
+    end
+  end
+end

data/lib/standard/sorbet/version.rb

@@ -0,0 +1,5 @@
+module Standard
+  module Sorbet
+    VERSION = "0.0.1"
+  end
+end

data/lib/standard/sorbet.rb

@@ -0,0 +1,10 @@
+require "lint_roller"
+
+require_relative "sorbet/version"
+require_relative "sorbet/plugin"
+require "standard/plugin_support"
+
+module Standard
+  module Sorbet
+  end
+end

data/lib/standard-sorbet.rb

@@ -0,0 +1 @@
+require_relative "standard/sorbet"

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: standard-sorbet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Searls
+- Max VelDink
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description:
+email:
+- searls@gmail.com
+- maxveldink@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/base.yml
+- lib/standard-sorbet.rb
+- lib/standard/sorbet.rb
+- lib/standard/sorbet/plugin.rb
+- lib/standard/sorbet/version.rb
+homepage: https://github.com/standardrb/standard-sorbet
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/standardrb/standard-sorbet
+  source_code_uri: https://github.com/standardrb/standard-sorbet
+  changelog_uri: https://github.com/standardrb/standard-sorbet/blob/main/CHANGELOG.md
+  default_lint_roller_plugin: Standard::Sorbet::Plugin
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: Standard Ruby Plugin providing configuration for rubocop-sorbet
+test_files: []