rubocop-on-rbs 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442a7571452e14e42efbd73d0f0313f983f631a983fd5c861f5c54d333538fd6
-  data.tar.gz: 1803e6bdf3eb67a025a3d1286966bef98eb695cf16e7edf83a717d748f995eca
+  metadata.gz: 0f48492da2f7f96f52584db83f1ead670446908414b91ebf0a27a7d6ccb82c1e
+  data.tar.gz: c5374fcc49b860034ef0852e3a4d2a86c99867e96581033884116b707844c597
 SHA512:
-  metadata.gz: '037319b5e7725a91470530891915c93227eddf4899ad8ad1a332f23bf23c3abedfc47f34618fbaa5c9672ad37d3e0badd32c7dec13f6319622dd653726f0d76d'
-  data.tar.gz: f2009c6f0af208cb65f96d410461c435f5a5a919253f191af1ae58f96ab54137e95c1e56d433aaac474126cbe7740a8320fd475c5d5487277ec47c0f92b46c30
+  metadata.gz: fceeab927591e1507529a6b55d1b30f8b8bd7b5d700846777109a0e2b84c61380b5bee05d721d5eb5a08ffee4c184875d7956327c7feea6d469742c66f5affc7
+  data.tar.gz: 618f0de58a7bf00f68f0df67cca9d82da6723715af26eb1740211ab16bf53be66604782ec251fcbfdb313c933f30eb535e19f932b1d029fc462c8782189599a0

data/config/default.yml

@@ -31,6 +31,13 @@ RBS/Layout/CommentIndentation:
   Description: 'Use 2 spaces for comment indentation'
   Enabled: true
 
+RBS/Layout/EmptyLineBetweenDeclarations:
+  Description: 'Keep 1 blank line between declarations'
+  Enabled: true
+  Class: true
+  Module: true
+  Interface: true
+
 RBS/Layout/EmptyLinesAroundAccessModifier:
   Description: "Keeps track of empty lines around access modifiers."
   Enabled: true
@@ -113,10 +120,18 @@ RBS/Lint/AmbiguousOperatorPrecedence:
   Description: 'Check ambiguous operator precedence'
   Enabled: true
 
+RBS/Lint/DuplicateAnnotation:
+  Description: 'Checks that there are no repeated annotations'
+  Enabled: true
+
 RBS/Lint/DuplicateOverload:
   Description: 'Checks that there are no repeated overload bodies'
   Enabled: true
 
+RBS/Lint/ImplicitlyReturnsNil:
+  Description: 'Check implicitly returns nil'
+  Enabled: true
+
 RBS/Lint/LiteralIntersection:
   Description: 'Check literal intersection'
   Enabled: true
@@ -125,6 +140,10 @@ RBS/Lint/NewReturnsVoid:
   Description: 'sigleton `new` method should not returns `void` type'
   Enabled: true
 
+RBS/Lint/RestKeywordHash:
+  Description: 'Check rest keyword with `Hash` type'
+  Enabled: true
+
 RBS/Lint/Syntax:
   Severity: fatal
   Description: 'Check RBS syntax'

data/lib/rubocop/cop/rbs/layout/comment_indentation.rb

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks the indentation of comments in RBS.
+        #
+        # @example
         #   # bad
         #     # comment here
         #   def foo: () -> void
@@ -12,6 +14,7 @@ module RuboCop
         #   # good
         #   # comment here
         #   def foo: () -> void
+        #
         class CommentIndentation < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/empty_line_between_declarations.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # Checks for empty lines between declarations.
+        #
+        # @example Class: true (default)
+        #   # checks for empty lines between class declarations.
+        #
+        #   # bad
+        #   class A
+        #   end
+        #   class B
+        #   end
+        #
+        #   # good
+        #   class A
+        #   end
+        #
+        #   class B
+        #   end
+        #
+        # @example Module: true (default)
+        #   # checks for empty lines between module declarations.
+        #
+        #   # bad
+        #   module A
+        #   end
+        #   module B
+        #   end
+        #
+        #   # good
+        #   module A
+        #   end
+        #
+        #   module B
+        #   end
+        #
+        # @example Interface: true (default)
+        #   # checks for empty lines between interface declarations.
+        #
+        #   # bad
+        #   interface _A
+        #   end
+        #   interface _B
+        #   end
+        #
+        #   # good
+        #   interface _A
+        #   end
+        #
+        #   interface _B
+        #   end
+        #
+        class EmptyLineBetweenDeclarations < RuboCop::RBS::CopBase
+          extend AutoCorrector
+
+          MSG = 'Expected %<expected>s between %<type>s definitions; found %<actual>d.'
+
+          def on_rbs_new_investigation
+            [nil, *processed_rbs_source.decls, nil].each_cons(2) do |decls|
+              check_decls(decls)
+            end
+          end
+
+          private
+
+          def check_decls(decls)
+            walk_pair(decls) do |before, after|
+              next unless candidate?(before) && candidate?(after)
+
+              check(before, after)
+            end
+          end
+
+          def walk_pair(decls, &block)
+            before, after = decls
+
+            case before
+            when ::RBS::AST::Declarations::Class,
+                 ::RBS::AST::Declarations::Module,
+                 ::RBS::AST::Declarations::Interface
+              case after
+              when ::RBS::AST::Declarations::Class,
+                   ::RBS::AST::Declarations::Module,
+                   ::RBS::AST::Declarations::Interface
+                block.call(before, after)
+              end
+              [nil, *before.members, nil].each_cons(2) do |members|
+                walk_pair(members, &block)
+              end
+            end
+          end
+
+          def check(before, after)
+            count = blank_lines_count_between(before, after)
+            return if count == 1
+            return if multiple_blank_lines_groups?(before, after)
+
+            after_start_line = processed_source.lines[after.location.start_line - 1]
+            range = range_between(after.location.start_pos, after.location.start_pos + after_start_line.length)
+            type = decl_type(after)
+            add_offense(range, message: format(MSG, expected: "1 empty line", type:, actual: count)) do |corrector|
+              if count.zero?
+                range_of_first = location_to_range(location_of_first(after))
+                corrector.insert_before(range_by_whole_lines(range_of_first), "\n")
+              else
+                range_to_remove = range_between(before.location.end_pos + 1, location_of_first(after).start_pos)
+                corrector.remove(range_to_remove)
+              end
+            end
+          end
+
+          def decl_type(decl)
+            case decl
+            when ::RBS::AST::Declarations::Class
+              'class'
+            when ::RBS::AST::Declarations::Module
+              'module'
+            when ::RBS::AST::Declarations::Interface
+              'interface'
+            end
+          end
+
+          def multiple_blank_lines_groups?(first_def_decl, second_def_decl)
+            lines = lines_between_decl(first_def_decl, second_def_decl)
+            blank_start = lines.each_index.select { |i| lines[i].blank? }.max
+            non_blank_end = lines.each_index.reject { |i| lines[i].blank? }.min
+            return false if blank_start.nil? || non_blank_end.nil?
+
+            blank_start > non_blank_end
+          end
+
+          def lines_between_decl(first_def_decl, second_def_decl)
+            begin_line_num = first_def_decl.location.end_line
+            end_line_num = location_of_first(second_def_decl).start_line - 2
+            return [] if end_line_num.negative?
+
+            processed_source.lines[begin_line_num..end_line_num]
+          end
+
+          def blank_lines_count_between(before, after)
+            lines_between_decl(before, after).count(&:blank?)
+          end
+
+          def location_of_first(decl)
+            [
+              *decl.annotations.map(&:location),
+              decl.comment&.location,
+              decl.location
+            ].compact.min_by(&:start_pos)
+          end
+
+          def candidate?(decl)
+            class_candidate?(decl) || module_candidate?(decl) || interface_candidate?(decl)
+          end
+
+          def class_candidate?(decl)
+            cop_config['Class'] && decl.is_a?(::RBS::AST::Declarations::Class)
+          end
+
+          def module_candidate?(decl)
+            cop_config['Module'] && decl.is_a?(::RBS::AST::Declarations::Module)
+          end
+
+          def interface_candidate?(decl)
+            cop_config['Interface'] && decl.is_a?(::RBS::AST::Declarations::Interface)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rbs/layout/empty_lines.rb

@@ -7,7 +7,6 @@ module RuboCop
         # Checks for two or more consecutive blank lines.
         #
         # @example
-        #
         #   # bad - It has two empty lines.
         #   def foo: () -> void
         #   # one empty line

data/lib/rubocop/cop/rbs/layout/empty_lines_around_access_modifier.rb

@@ -6,6 +6,7 @@ module RuboCop
       module Layout
         # Access modifiers should be surrounded by blank lines.
         #
+        # @example
         #   # bad
         #   class Foo
         #     def bar: () -> void

data/lib/rubocop/cop/rbs/layout/empty_lines_around_class_body.rb

@@ -7,9 +7,8 @@ module RuboCop
         # Checks if empty lines around the bodies of classes match
         # the configuration.
         #
-        # @example default
+        # @example
         #   # good
-        #
         #   class Foo
         #     def bar: () -> void
         #   end

data/lib/rubocop/cop/rbs/layout/empty_lines_around_interface_body.rb

@@ -7,12 +7,12 @@ module RuboCop
         # Checks if empty lines around the bodies of interfaces match
         # the configuration.
         #
-        # @example default
+        # @example
         #   # good
-        #
         #   interface _Foo
         #     def bar: () -> void
         #   end
+        #
         class EmptyLinesAroundInterfaceBody < RuboCop::RBS::CopBase
           include EmptyLinesAroundBody
           extend AutoCorrector

data/lib/rubocop/cop/rbs/layout/empty_lines_around_module_body.rb

@@ -7,9 +7,8 @@ module RuboCop
         # Checks if empty lines around the bodies of modules match
         # the configuration.
         #
-        # @example default
+        # @example
         #   # good
-        #
         #   module Foo
         #     def bar: () -> void
         #   end

data/lib/rubocop/cop/rbs/layout/empty_lines_around_overloads.rb

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks empty lines around overloads.
+        #
+        # @example
         #   # bad
         #   def foo: () -> void
         #
@@ -13,6 +15,7 @@ module RuboCop
         #   # good
         #   def foo: () -> void
         #          | (Integer) -> Integer
+        #
         class EmptyLinesAroundOverloads < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/end_alignment.rb

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks if `end` is aligned with the start of the class, module or interface.
+        #
+        # @example
         #   # bad
         #   class Foo
         #     def foo: () -> void
@@ -14,6 +16,7 @@ module RuboCop
         #   class Foo
         #     def foo: () -> void
         #   end
+        #
         class EndAlignment < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/extra_spacing.rb

@@ -4,12 +4,15 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks for unnecessary spacing between tokens.
+        #
+        # @example
         #   # bad
         #   def   foo:   ()   ->   void
         #
         #   # good
         #   def foo: () -> void
+        #
         class ExtraSpacing < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/indentation_width.rb

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks if the indentation width.
+        #
+        # @example
         #   # bad
         #   class Foo
         #   def foo: () -> void
@@ -14,6 +16,7 @@ module RuboCop
         #   class Foo
         #     def foo: () -> void
         #   end
+        #
         class IndentationWidth < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/overload_indentation.rb

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks the indentation of overloads.
+        #
+        # @example
         #   # bad
         #   def foo: () -> String | () -> (Integer)
         #
@@ -19,6 +21,7 @@ module RuboCop
         #   # good
         #   def foo: () -> String
         #          | () -> Integer
+        #
         class OverloadIndentation < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/space_after_comma.rb

@@ -4,12 +4,15 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks for missing spaces after commas.
+        #
+        # @example
         #   # bad
         #   def foo: (Integer,String) -> void
         #
         #   # good
         #   def foo: (Integer, String) -> void
+        #
         class SpaceAfterComma < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/space_around_arrow.rb

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks for missing spaces around the `->` operator.
+        #
+        # @example
         #   # bad
         #   def foo: ()->void
         #
@@ -16,6 +18,7 @@ module RuboCop
         #
         #   # good
         #   def bar: () { () -> void } -> void
+        #
         class SpaceAroundArrow < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/space_around_braces.rb

@@ -4,12 +4,15 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # Checks for missing spaces around braces in method definitions.
+        #
+        # @example
         #   # bad
         #   def bar: (){() -> void}-> void
         #
         #   # good
         #   def bar: () { () -> void } -> void
+        #
         class SpaceAroundBraces < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/layout/space_around_operators.rb

@@ -4,12 +4,13 @@ module RuboCop
   module Cop
     module RBS
       module Layout
-        # @example default
+        # @example
         #   # bad
         #   Integer|String
         #
         #   # good
         #   Integer | String
+        #
         class SpaceAroundOperators < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs/lint/duplicate_annotation.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Lint
+        # Checks that there are no repeated annotations.
+        #
+        # @example
+        #   # bad
+        #   def %a{foo} %a{foo} def foo: () -> void
+        #
+        #   # bad
+        #   def %a{foo} foo: %a{foo} () -> void
+        #
+        #   # bad
+        #   def foo: %a{foo} %a{foo} () -> void
+        #
+        #   # not bad
+        #   def foo: %a{foo} () -> void
+        #          | %a{foo} (Integer) -> void
+        #
+        class DuplicateAnnotation < RuboCop::RBS::CopBase
+          MSG = 'Duplicate annotation detected.'
+
+          def on_rbs_def(decl)
+            decl.annotations.each_with_index do |annotation, idx|
+              next_annotations = decl.annotations[(idx + 1)..] or next
+              check_annotations(annotation, next_annotations)
+
+              decl.overloads.each do |overload|
+                check_annotations(annotation, overload.annotations)
+              end
+            end
+
+            decl.overloads.each do |overload|
+              overload.annotations.each_with_index do |overload_annotation, idx|
+                next_annotations = overload.annotations[(idx + 1)..] or next
+                check_annotations(overload_annotation, next_annotations)
+              end
+            end
+          end
+
+          def check_annotations(left_annotation, right_annotations)
+            right_annotations.each do |right_annotation|
+              next unless left_annotation == right_annotation
+              next unless right_annotation.location
+
+              range = location_to_range(right_annotation.location)
+              add_offense(range)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rbs/lint/duplicate_overload.rb

@@ -4,15 +4,16 @@ module RuboCop
   module Cop
     module RBS
       module Lint
-        # Checks that there are no repeated overload bodies
+        # Checks that there are no repeated overload bodies.
+        # This cop ignores the difference of return type.
         #
-        # @example default
+        # @example
         #   # bad
         #   def foo: () -> void
-        #          | () -> void
+        #          | () -> top
         #
         class DuplicateOverload < RuboCop::RBS::CopBase
-          MSG = 'Duplicate overload body detected.'
+          MSG = 'Duplicate overload arguments detected.'
 
           def on_rbs_def(decl)
             overloads = decl.overloads
@@ -21,13 +22,22 @@ module RuboCop
 
               next_overloads = overloads[(idx + 1)..-1]
               next_overloads.each do |next_overload|
-                next unless overload.method_type == next_overload.method_type
+                a = method_type_with_untyped_return_type(overload.method_type)
+                b = method_type_with_untyped_return_type(next_overload.method_type)
+                next unless a == b
 
                 range = location_to_range(next_overload.method_type.location)
                 add_offense(range)
               end
             end
           end
+
+          private
+
+          def method_type_with_untyped_return_type(method_type)
+            type = method_type.type.with_return_type(::RBS::Types::Bases::Any.new(location: nil))
+            method_type.update(type:)
+          end
         end
       end
     end

data/lib/rubocop/cop/rbs/lint/implicitly_returns_nil.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Lint
+        # This cop checks for conflicts between `implicitly-returns-nil` annotations and return types.
+        #
+        # @example
+        #   # bad
+        #   %a{implicitly-returns-nil}
+        #   def foo: () -> Integer?
+        #
+        #   # good
+        #   %a{implicitly-returns-nil}
+        #   def foo: () -> Integer
+        #
+        #   # good
+        #   def foo: () -> Integer?
+        #
+        class ImplicitlyReturnsNil < RuboCop::RBS::CopBase
+          extend AutoCorrector
+
+          MSG = "There is a conflict between `%<annotation>s` and return type `%<return_type>s`."
+
+          def on_rbs_def(decl)
+            decl.overloads.each do |overload|
+              annotation = find_implicitly_returns_nil(decl) || find_implicitly_returns_nil(overload)
+              next unless annotation
+              next unless overload_returns_nil?(overload)
+
+              return_type = overload.method_type.type.return_type.to_s
+              range = location_to_range(annotation.location)
+              message = format(MSG, annotation: annotation.location.source, return_type:)
+              add_offense(range, message:)
+            end
+          end
+
+          private
+
+          def find_implicitly_returns_nil(decl)
+            decl.annotations.find { |a| a.string == 'implicitly-returns-nil' }
+          end
+
+          def overload_returns_nil?(overload)
+            returns_nil?(overload.method_type.type.return_type)
+          end
+
+          def returns_nil?(type)
+            case type
+            when ::RBS::Types::Bases::Nil,
+                 ::RBS::Types::Optional
+              true
+            when ::RBS::Types::Union
+              type.types.any? { |t| returns_nil?(t) }
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rbs/lint/new_returns_void.rb

@@ -10,7 +10,7 @@ module RuboCop
         # `self.new` is a special and fundamental method, and extra care should be taken regarding its return value.
         # In most cases, assigning it `void` is an unintended mistake.
         #
-        # @example default
+        # @example
         #   # bad
         #   def self.new: () -> void
         #

data/lib/rubocop/cop/rbs/lint/rest_keyword_hash.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Lint
+        # Specifying the `Hash` type for `**` is a very special case and,
+        # in most situations, it is a mistake in type specification.
+        #
+        # @example
+        #   # bad
+        #   def foo: (**Hash[Symbol, String]) -> void
+        #   # e.g.) foo(a: {x: "x"}, b: {y: "y"}, c: {z: "z"})
+        #
+        #   # good
+        #   def foo: (**String) -> void
+        #   # e.g.) foo(a: "x", b: "y", c: "z")
+        #
+        class RestKeywordHash < RuboCop::RBS::CopBase
+          def on_rbs_def(decl)
+            decl.overloads.each do |overload|
+              func = overload.method_type.type
+              next unless func.is_a?(::RBS::Types::Function)
+
+              if !func.rest_keywords.nil?
+                check_type(func.rest_keywords.type)
+              end
+            end
+          end
+
+          def check_type(type)
+            case type
+            when ::RBS::Types::ClassInstance
+              if type.name.relative!.to_s == 'Hash'
+                did_you_mean = type.args[1] or return
+                range = location_to_range(type.location)
+                message = "The type of `**` specifies only the type of value. " \
+                          "Did you mean `**#{did_you_mean}`?"
+                add_offense(range, message:)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rbs/lint/syntax.rb

@@ -5,6 +5,7 @@ module RuboCop
     module RBS
       module Lint
         # Just only for syntax error
+        #
         class Syntax < RuboCop::RBS::CopBase
           def on_rbs_parsing_error
             e = processed_rbs_source.error or raise

data/lib/rubocop/cop/rbs/lint/unused_overload_type_params.rb

@@ -6,12 +6,13 @@ module RuboCop
       module Lint
         # Notice unused overload type parameters.
         #
-        # @example default
+        # @example
         #   # bad
         #   def foo: [T] () -> void
         #
         #   # good
         #   def foo: [T] (T) -> T
+        #
         class UnusedOverloadTypeParams < RuboCop::RBS::CopBase
           MSG = 'Unused overload type variable - `%<variable>s`.'
 

data/lib/rubocop/cop/rbs/lint/unused_type_alias_type_params.rb

@@ -6,12 +6,13 @@ module RuboCop
       module Lint
         # Notice unused type parameters.
         #
-        # @example default
+        # @example
         #   # bad
         #   type ary[T] = Array[Integer]
         #
         #   # good
         #   type ary[T] = Array[T]
+        #
         class UnusedTypeAliasTypeParams < RuboCop::RBS::CopBase
           MSG = 'Unused type variable - `%<variable>s`.'
 

data/lib/rubocop/cop/rbs/lint/useless_access_modifier.rb

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Lint
-        # @example default
+        # Checks for redundant access modifiers in class and module definitions.
+        #
+        # @example
         #   # bad
         #   class Foo
         #     public # this is redundant (default access is public)

data/lib/rubocop/cop/rbs/lint/will_syntax_error.rb

@@ -7,12 +7,13 @@ module RuboCop
         # This cop checks the WillSyntaxError in RBS.
         # RBS with this diagnostics will fail in `rbs validate` command.
         #
-        # @example default
+        # @example
         #   # bad
         #   def foo: (void) -> void
         #
         #   # bad
         #   CONST: self
+        #
         class WillSyntaxError < RuboCop::RBS::CopBase
           # @rbs!
           #    module Types = ::RBS::Types

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

@@ -4,12 +4,13 @@ module RuboCop
   module Cop
     module RBS
       module Style
-        # @example default
+        # @example
         #   # bad
         #   def foo: () { () -> bool } -> void
         #
         #   # good
         #   def foo: () { () -> boolish } -> void
+        #
         class BlockReturnBoolish < RuboCop::RBS::CopBase
           extend AutoCorrector
           MSG = 'Use `boolish` instead of `bool` in block return type.'

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module RBS
       module Style
-        # @example default
+        # @example
         #   # bad
         #   def foo: () -> TrueClass
         #
@@ -16,6 +16,7 @@ module RuboCop
         #
         #   # good
         #   def bar: () -> nil
+        #
         class ClassicType < RuboCop::RBS::CopBase
           extend AutoCorrector
 

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

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Style
-        # @example default
+        # Unions and intersections of the same type are meaningless.
+        #
+        # @example
         #   # bad
         #   def foo: (Integer | Integer) -> void
         #
@@ -13,6 +15,7 @@ module RuboCop
         #
         #   # good
         #   def foo: (Integer) -> void
+        #
         class DuplicatedType < RuboCop::RBS::CopBase
           extend AutoCorrector
 

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

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Style
-        # @example default
+        # Checks parentheses for empty arguments.
+        #
+        # @example
         #   # bad
         #   def foo: -> void
         #
@@ -16,6 +18,7 @@ module RuboCop
         #
         #   # good
         #   def foo: () { () -> void } -> ^() -> void
+        #
         class EmptyArgument < RuboCop::RBS::CopBase
           class MethodTypeChecker
             include RuboCop::RBS::OnTypeHelper

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

@@ -4,15 +4,22 @@ module RuboCop
   module Cop
     module RBS
       module Style
-        # @example default
+        # `#initialize` is a private method and is likely to be overridden.
+        # The return type of `#initialize` should not be specific.
+        #
+        # @example
         #   # bad
         #   def initialize: () -> nil
         #
+        #   # bad
+        #   def initialize: () -> false
+        #
         #   # good
         #   def initialize: () -> untyped
         #
         #   # good
         #   def initialize: () -> void
+        #
         class InitializeReturnType < RuboCop::RBS::CopBase
           extend AutoCorrector
           MSG = '`#initialize` method should return `void`'

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

@@ -7,7 +7,7 @@ module RuboCop
       module Style
         # Checks that `instance` in instance context.
         #
-        # @example (default)
+        # @example
         #   # bad
         #   def foo: (instance) -> instance
         #

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

@@ -4,12 +4,15 @@ module RuboCop
   module Cop
     module RBS
       module Style
-        # @example default
+        # `nil?` is the same as `nil`.
+        #
+        # @example
         #   # bad
         #   def foo: (nil?) -> void
         #
         #   # good
         #   def foo: (nil) -> void
+        #
         class OptionalNil < RuboCop::RBS::CopBase
           extend AutoCorrector
 

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

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Style
-        # @example default
+        # Check for redundant parentheses.
+        #
+        # @example
         #   # bad
         #   def foo: () -> (bool)
         #
@@ -16,6 +18,7 @@ module RuboCop
         #
         #   # good
         #   def foo: ((true | false)) -> bool
+        #
         class RedundantParentheses < RuboCop::RBS::CopBase
           module BeforeTokenIfLparen
             def before_token_if_lparen(tokens, base, fun)

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

@@ -4,7 +4,9 @@ module RuboCop
   module Cop
     module RBS
       module Style
-        # @example default
+        # `true | false` is simply the same as `bool`.
+        #
+        # @example
         #   # bad
         #   def foo: (true | false) -> (true | false)
         #
@@ -13,6 +15,7 @@ module RuboCop
         #
         #   # good
         #   def foo: (bool) -> bool
+        #
         class TrueFalse < RuboCop::RBS::CopBase
           extend AutoCorrector
 

data/lib/rubocop/cop/rbs_cops.rb

@@ -3,6 +3,7 @@
 require 'rbs'
 
 require_relative 'rbs/layout/comment_indentation'
+require_relative 'rbs/layout/empty_line_between_declarations'
 require_relative 'rbs/layout/empty_lines_around_access_modifier'
 require_relative 'rbs/layout/empty_lines_around_body'
 require_relative 'rbs/layout/empty_lines_around_class_body'
@@ -24,9 +25,12 @@ require_relative 'rbs/layout/trailing_whitespace'
 
 require_relative 'rbs/lint/ambiguous_keyword_argument_key'
 require_relative 'rbs/lint/ambiguous_operator_precedence'
+require_relative 'rbs/lint/duplicate_annotation'
 require_relative 'rbs/lint/duplicate_overload'
+require_relative 'rbs/lint/implicitly_returns_nil'
 require_relative 'rbs/lint/literal_intersection'
 require_relative 'rbs/lint/new_returns_void'
+require_relative 'rbs/lint/rest_keyword_hash'
 require_relative 'rbs/lint/syntax'
 require_relative 'rbs/lint/top_level_interface'
 require_relative 'rbs/lint/top_level_type_alias'

data/lib/rubocop/rbs/cop_base.rb

@@ -13,6 +13,12 @@ module RuboCop
 
       exclude_from_registry
 
+      def self.documentation_url(_config = nil)
+        base = "cops_#{department.to_s.downcase.tr('/', '_')}"
+        fragment = cop_name.downcase.gsub(/[^a-z]/, '')
+        "https://github.com/ksss/rubocop-on-rbs/blob/v#{VERSION}/docs/modules/ROOT/pages/#{base}.adoc##{fragment}"
+      end
+
       def on_new_investigation
         # Called here when valid as Ruby
         investigation_rbs()

data/lib/rubocop/rbs/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - ksss
 bindir: exe
 cert_chain: []
-date: 2025-04-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lint_roller
@@ -85,6 +85,7 @@ files:
 - config/default.yml
 - lib/rubocop-on-rbs.rb
 - lib/rubocop/cop/rbs/layout/comment_indentation.rb
+- lib/rubocop/cop/rbs/layout/empty_line_between_declarations.rb
 - lib/rubocop/cop/rbs/layout/empty_lines.rb
 - lib/rubocop/cop/rbs/layout/empty_lines_around_access_modifier.rb
 - lib/rubocop/cop/rbs/layout/empty_lines_around_body.rb
@@ -105,9 +106,12 @@ files:
 - lib/rubocop/cop/rbs/layout/trailing_whitespace.rb
 - lib/rubocop/cop/rbs/lint/ambiguous_keyword_argument_key.rb
 - lib/rubocop/cop/rbs/lint/ambiguous_operator_precedence.rb
+- lib/rubocop/cop/rbs/lint/duplicate_annotation.rb
 - lib/rubocop/cop/rbs/lint/duplicate_overload.rb
+- lib/rubocop/cop/rbs/lint/implicitly_returns_nil.rb
 - lib/rubocop/cop/rbs/lint/literal_intersection.rb
 - lib/rubocop/cop/rbs/lint/new_returns_void.rb
+- lib/rubocop/cop/rbs/lint/rest_keyword_hash.rb
 - lib/rubocop/cop/rbs/lint/syntax.rb
 - lib/rubocop/cop/rbs/lint/top_level_interface.rb
 - lib/rubocop/cop/rbs/lint/top_level_type_alias.rb
@@ -155,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: RuboCop extension for RBS file.
 test_files: []