Merge pull request #1899 from ksss/rubocop-on-rbs

Introduce rubocop-on-rbs

Author: soutaro

.rubocop.yml

@@ -1,4 +1,7 @@
-require: rubocop-rubycw
+require:
+  - rubocop-rubycw
+  - rubocop-on-rbs
+
 AllCops:
   TargetRubyVersion: 3.0
   DisabledByDefault: true
@@ -9,6 +12,27 @@ Rubycw/Rubycw:
   Exclude:
     - 'test/**/*_test.rb'
 
+RBS:
+  Enabled: true
+RBS/Layout:
+  Enabled: true
+  Exclude:
+    - 'sig/**/*'
+    - 'test/**/*'
+RBS/Layout/CommentIndentation:
+  Exclude:
+    - core/string.rbs
+RBS/Lint:
+  Enabled: true
+  Exclude:
+    - 'sig/**/*'
+    - 'test/**/*'
+RBS/Style:
+  Enabled: false
+  Exclude:
+    - 'sig/**/*'
+    - 'test/**/*'
+
 Lint/DuplicateMethods:
   Enabled: true
   Include:

Gemfile

@@ -10,6 +10,7 @@ gem "test-unit"
 gem "rspec"
 gem "rubocop"
 gem "rubocop-rubycw"
+gem "rubocop-on-rbs" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.1')
 gem "json"
 gem "json-schema"
 gem "goodcheck"

Gemfile.lock

@@ -110,6 +110,10 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
+    rubocop-on-rbs (0.6.0)
+      rbs (~> 3.5)
+      rubocop (~> 1.41)
+      zlib
     rubocop-rubycw (0.1.6)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
@@ -142,6 +146,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    zlib (3.1.1)
 
 PLATFORMS
   ruby
@@ -172,6 +177,7 @@ DEPENDENCIES
   rdoc
   rspec
   rubocop
+  rubocop-on-rbs
   rubocop-rubycw
   stackprof
   steep (~> 1.7.1)

Rakefile

@@ -110,7 +110,13 @@ task :raap => :compile do
 end
 
 task :rubocop do
-  sh "rubocop --parallel"
+  format = if ENV["CI"]
+    "github"
+  else
+    "progress"
+  end
+
+  sh "rubocop --parallel --format #{format}"
 end
 
 namespace :generate do

core/enumerable.rbs

@@ -529,7 +529,7 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   def entries: () -> ::Array[Elem]
 
   def enum_for: (Symbol method, *untyped, **untyped) ?{ (?) -> Integer } -> Enumerator[untyped, untyped]
-    | () ?{ () -> Integer } -> Enumerator[Elem, self]
+              | () ?{ () -> Integer } -> Enumerator[Elem, self]
 
   %a{annotate:rdoc:skip}
   alias to_enum enum_for

core/kernel.rbs

@@ -675,7 +675,7 @@ module Kernel : BasicObject
                     | (int | _ToR rational_like, exception: bool) -> Rational?
                     | (int | _ToR numer, ?int | _ToR denom, ?exception: true) -> Rational
                     | (int | _ToR numer, ?int | _ToR denom, exception: bool) -> Rational?
-                    | [T] (Numeric&_RationalDiv[T] numer, Numeric denom, ?exception: bool) -> T
+                    | [T] (Numeric & _RationalDiv[T] numer, Numeric denom, ?exception: bool) -> T
                     | [T < Numeric] (T value, 1, ?exception: bool) -> T
                     | (untyped, ?untyped, ?exception: bool) -> Rational?
 

core/rbs/unnamed/env_class.rbs

@@ -231,8 +231,8 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.fetch}
       def fetch: (String name) -> String
-              | [X] (String name, X default) -> (String | X)
-              | [X] (String name) { (String) -> X } -> (String | X)
+               | [X] (String name, X default) -> (String | X)
+               | [X] (String name) { (String) -> X } -> (String | X)
 
       # <!--
       #   rdoc-file=hash.c
@@ -382,7 +382,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.each_pair}
       def each_pair: () -> ::Enumerator[[ String, String ], self]
-                  | () { ([ String, String ]) -> void } -> self
+                   | () { ([ String, String ]) -> void } -> self
 
       # <!--
       #   rdoc-file=hash.c
@@ -479,7 +479,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.delete_if}
       def delete_if: () -> ::Enumerator[[ String, String ], self]
-                  | () { (String name, String value) -> boolish } -> self
+                   | () { (String name, String value) -> boolish } -> self
 
       # <!--
       #   rdoc-file=hash.c
@@ -501,7 +501,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.keep_if}
       def keep_if: () -> ::Enumerator[[ String, String ], self]
-                | () { (String name, String value) -> boolish } -> self
+                 | () { (String name, String value) -> boolish } -> self
 
       # <!--
       #   rdoc-file=hash.c
@@ -588,7 +588,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.reject!}
       def reject!: () -> ::Enumerator[[ String, String ], self?]
-                | () { (String name, String value) -> boolish } -> self?
+                 | () { (String name, String value) -> boolish } -> self?
 
       # <!--
       #   rdoc-file=hash.c
@@ -674,7 +674,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.select!}
       def select!: () -> ::Enumerator[[ String, String ], self?]
-                | () { (String name, String value) -> boolish } -> self?
+                 | () { (String name, String value) -> boolish } -> self?
 
       # <!--
       #   rdoc-file=hash.c

core/rbs/unnamed/random.rbs

@@ -224,12 +224,12 @@ module RBS
       #
       %a{annotate:rdoc:copy:Random::Formatter#random_number}
       def random_number: () -> Float
-                      | (?Float? n) -> Float
-                      | (?Integer? n) -> Integer
-                      | (?Numeric? n) -> Numeric
-                      | (?::Range[Float]? n) -> Float
-                      | (?::Range[Integer]? n) -> Integer
-                      | (?::Range[Numeric]? n) -> Numeric
+                       | (?Float? n) -> Float
+                       | (?Integer? n) -> Integer
+                       | (?Numeric? n) -> Numeric
+                       | (?::Range[Float]? n) -> Float
+                       | (?::Range[Integer]? n) -> Integer
+                       | (?::Range[Numeric]? n) -> Numeric
 
       # <!--
       #   rdoc-file=lib/random/formatter.rb

stdlib/zlib/0/deflate.rbs

@@ -154,7 +154,7 @@ module Zlib
     # SYNC_FLUSH, FULL_FLUSH and FINISH.
     #
     def flush: (?Integer flush) -> String
-             | (?Integer flush) {(String chunk) -> nil } -> nil
+             | (?Integer flush) { (String chunk) -> nil } -> nil
 
     # <!--
     #   rdoc-file=ext/zlib/zlib.c