Merge pull request #34 from sue445/migrate_plugin

Migrate to plugin

Author: ksss

.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
-require:
-  './lib/rubocop-yard'
+plugins:
+  - rubocop-yard
 
 Layout:
   Enabled: false

Gemfile

@@ -7,7 +7,7 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "rubocop", "~> 1.21"
+gem "rubocop", "~> 1.72"
 gem 'debug'
 gem 'steep'
 gem 'activesupport', '~> 7.0' # 8.0 needs Ruby 3.2

Gemfile.lock

@@ -2,7 +2,8 @@ PATH
   remote: .
   specs:
     rubocop-yard (0.10.0)
-      rubocop (~> 1.21)
+      lint_roller
+      rubocop (~> 1.72)
       yard
 
 GEM
@@ -41,6 +42,7 @@ GEM
       reline (>= 0.4.2)
     json (2.8.2)
     language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -62,20 +64,21 @@ GEM
       logger
     rdoc (6.8.1)
       psych (>= 4.0.0)
-    regexp_parser (2.9.2)
+    regexp_parser (2.10.0)
     reline (0.5.11)
       io-console (~> 0.5)
-    rubocop (1.68.0)
+    rubocop (1.74.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.36.1)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.40.0)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     securerandom (0.3.2)
@@ -110,7 +113,7 @@ DEPENDENCIES
   activesupport (~> 7.0)
   debug
   rake (~> 13.0)
-  rubocop (~> 1.21)
+  rubocop (~> 1.72)
   rubocop-yard!
   steep
 

README.md

@@ -131,7 +131,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-yard
+plugins:
+  - rubocop-yard
 ```
 
 ## Development

lib/rubocop-yard.rb

@@ -4,8 +4,6 @@
 
 require_relative 'rubocop/yard'
 require_relative 'rubocop/yard/version'
-require_relative 'rubocop/yard/inject'
-
-RuboCop::YARD::Inject.defaults!
+require_relative 'rubocop/yard/plugin'
 
 require_relative 'rubocop/cop/yard_cops'

lib/rubocop/yard/inject.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module YARD
+    # A plugin that integrates RuboCop Performance with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-yard',
+          version: VERSION,
+          homepage: 'https://github.com/ksss/rubocop-yard',
+          description: 'Check yardoc format like tag type.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

lib/rubocop/yard/plugin.rb

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = spec.homepage
   spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['default_lint_roller_plugin'] = 'RuboCop::YARD::Plugin'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     [
@@ -31,7 +32,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'rubocop', "~> 1.21"
+  spec.add_runtime_dependency 'lint_roller'
+  spec.add_runtime_dependency 'rubocop', "~> 1.72"
   spec.add_runtime_dependency 'yard'
 end