rubocop-on-rbs 1.4.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34dde3fda59e719b26f5a39a31b43df6dff8ae433e45693b40c18ccee7844178
-  data.tar.gz: 4788f1f4adb88f6b62a3174a9079190f667a81d2c077cbcff7bee093f12319ea
+  metadata.gz: 442a7571452e14e42efbd73d0f0313f983f631a983fd5c861f5c54d333538fd6
+  data.tar.gz: 1803e6bdf3eb67a025a3d1286966bef98eb695cf16e7edf83a717d748f995eca
 SHA512:
-  metadata.gz: 02a91b40de9312f6b689f8b7b6f180852239a16dcc5753e74f2648b31816ae0473bf48c2872ccc235221014bf207f4a5cdaf418837f63ba32a03110782c5cdbf
-  data.tar.gz: d4f3c5f1a195e4ac1a03285d7932841004e951ad3fd3b957d197496c53a0939063c6fceabd6c6773e488ebed22cc7b065611d5e7fb35b1b372794deb21081aba
+  metadata.gz: '037319b5e7725a91470530891915c93227eddf4899ad8ad1a332f23bf23c3abedfc47f34618fbaa5c9672ad37d3e0badd32c7dec13f6319622dd653726f0d76d'
+  data.tar.gz: f2009c6f0af208cb65f96d410461c435f5a5a919253f191af1ae58f96ab54137e95c1e56d433aaac474126cbe7740a8320fd475c5d5487277ec47c0f92b46c30

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+* Pluginfy RuboCop on RBS by @ydah in https://github.com/ksss/rubocop-on-rbs/pull/88
+
 ## [1.4.2] - 2025-02-23
 
 * [RBS/Style/ClassWithSingleton] Digging into each types by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/84

data/README.md

@@ -33,20 +33,10 @@ def foo: (   void) -> untyped
 
 ## Support VSCode
 
-We are currently working on a response, but it is possible to modify part of [vscode-rubocop](https://github.com/rubocop/vscode-rubocop) as a temporary hack to use it in vscode as well.
+[vscode-rubocop](https://github.com/rubocop/vscode-rubocop) with [rubocop.additionalLanguages](https://github.com/rubocop/vscode-rubocop?tab=readme-ov-file#rubocopadditionallanguages) option is recommended.
 
-Open your installed vscode extension.
-
-```
-$ code ~/.vscode/extensions/rubocop.vscode-rubocop-X.Y.Z/
-```
-
-Search `documentSelector:[{`.
-
-Then, Edit to add following to `documentSelector[]`
-
-```js
-{scheme:"file",language:"rbs"}
+```json
+"rubocop.additionalLanguages": ["rbs"]
 ```
 
 Additionally, by configuring the `settings.json` below, you can enable auto-correction to run on file save.
@@ -137,13 +127,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-on-rbs
+plugins: rubocop-on-rbs
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-on-rbs
 ```
@@ -151,10 +141,13 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop on RBS
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```sh
-$ rubocop --require rubocop-on-rbs
+$ rubocop --plugin rubocop-on-rbs
 ```
 
 ### Rake task
@@ -163,7 +156,7 @@ $ rubocop --require rubocop-on-rbs
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-on-rbs'
+  task.plugins << 'rubocop-on-rbs'
 end
 ```
 

data/lib/rubocop/cop/rbs/style/duplicated_type.rb

@@ -25,6 +25,12 @@ module RuboCop
             end
           end
 
+          def on_rbs_constant(decl) = check_type(decl.type)
+          alias on_rbs_global on_rbs_constant
+          alias on_rbs_type_alias on_rbs_constant
+          alias on_rbs_attribute on_rbs_constant
+          alias on_rbs_var on_rbs_constant
+
           # @rbs type: ::RBS::Types::t
           def check_type(type)
             case type

data/lib/rubocop/cop/rbs/style/optional_nil.rb

@@ -17,16 +17,26 @@ module RuboCop
           def on_rbs_def(decl)
             decl.overloads.each do |overload|
               overload.method_type.each_type do |type|
-                find_replacement(type) do |t, replaced|
-                  range = location_to_range(t.location)
-                  add_offense(range, message: "Use `#{replaced}` instead of `#{t}`") do |corrector|
-                    corrector.replace(range, replaced.to_s)
-                  end
-                end
+                check_type(type)
               end
             end
           end
 
+          def check_type(type)
+            find_replacement(type) do |t, replaced|
+              range = location_to_range(t.location)
+              add_offense(range, message: "Use `#{replaced}` instead of `#{t}`") do |corrector|
+                corrector.replace(range, replaced.to_s)
+              end
+            end
+          end
+
+          def on_rbs_constant(const) = check_type(const.type)
+          alias on_rbs_global on_rbs_constant
+          alias on_rbs_type_alias on_rbs_constant
+          alias on_rbs_attribute on_rbs_constant
+          alias on_rbs_var on_rbs_constant
+
           # @rbs type: ::RBS::Types::t
           def find_replacement(type, &block)
             case type

data/lib/rubocop/cop/rbs/style/true_false.rb

@@ -20,12 +20,22 @@ module RuboCop
           def on_rbs_def(decl)
             decl.overloads.each do |overload|
               overload.method_type.each_type do |type|
-                find_replacement(type) do |t, replaced|
-                  range = location_to_range(t.location)
-                  add_offense(range, message: "Use `#{replaced}` instead of `#{t}`") do |corrector|
-                    corrector.replace(range, replaced.to_s)
-                  end
-                end
+                check_type(type)
+              end
+            end
+          end
+
+          def on_rbs_constant(const) = check_type(const.type)
+          alias on_rbs_global on_rbs_constant
+          alias on_rbs_type_alias on_rbs_constant
+          alias on_rbs_attribute on_rbs_constant
+          alias on_rbs_var on_rbs_constant
+
+          def check_type(type)
+            find_replacement(type) do |t, replaced|
+              range = location_to_range(t.location)
+              add_offense(range, message: "Use `#{replaced}` instead of `#{t}`") do |corrector|
+                corrector.replace(range, replaced.to_s)
               end
             end
           end

data/lib/rubocop/rbs/plugin.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module RBS
+    # A plugin that integrates RuboCop on RBS with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-on-rbs',
+          version: RuboCop::RBS::VERSION,
+          homepage: 'https://github.com/ksss/rubocop-on-rbs',
+          description: 'A RuboCop extension focused on enforcing RBS best practices and coding conventions.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join('config', 'default.yml'))
+      end
+    end
+  end
+end

data/lib/rubocop/rbs/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module RBS
-    VERSION = '1.4.2'
+    VERSION = '1.6.0'
   end
 end

data/lib/rubocop/rbs.rb

@@ -5,11 +5,5 @@ require_relative 'rbs/version'
 module RuboCop
   module RBS
     class Error < StandardError; end
-
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
   end
 end

data/lib/rubocop-on-rbs.rb

@@ -6,9 +6,6 @@ require_relative 'rubocop/rbs'
 require_relative 'rubocop/rbs/version'
 require_relative 'rubocop/rbs/on_type_helper'
 require_relative 'rubocop/rbs/cop_base'
-require_relative 'rubocop/rbs/inject'
 require_relative 'rubocop/rbs/processed_rbs_source'
-
-RuboCop::RBS::Inject.defaults!
-
+require_relative 'rubocop/rbs/plugin'
 require_relative 'rubocop/cop/rbs_cops'

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.6.0
 platform: ruby
 authors:
 - ksss
 bindir: exe
 cert_chain: []
-date: 2025-02-23 00:00:00.000000000 Z
+date: 2025-04-25 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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
@@ -27,16 +41,22 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.61'
+        version: 1.72.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.61'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: zlib
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +128,8 @@ files:
 - lib/rubocop/cop/rbs_cops.rb
 - lib/rubocop/rbs.rb
 - lib/rubocop/rbs/cop_base.rb
-- lib/rubocop/rbs/inject.rb
 - lib/rubocop/rbs/on_type_helper.rb
+- lib/rubocop/rbs/plugin.rb
 - lib/rubocop/rbs/processed_rbs_source.rb
 - lib/rubocop/rbs/version.rb
 homepage: https://github.com/ksss/rubocop-on-rbs
@@ -119,6 +139,7 @@ metadata:
   homepage_uri: https://github.com/ksss/rubocop-on-rbs
   source_code_uri: https://github.com/ksss/rubocop-on-rbs
   changelog_uri: https://github.com/ksss/rubocop-on-rbs
+  default_lint_roller_plugin: RuboCop::RBS::Plugin
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -127,14 +148,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.6
 specification_version: 4
 summary: RuboCop extension for RBS file.
 test_files: []

data/lib/rubocop/rbs/inject.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
-module RuboCop
-  module RBS
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path).tap(&:make_excludes_absolute)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end