rubocop-on-rbs 1.7.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1758c7e798195a042bd2b9266255dda2699470450e839f6ba330da6ff6470919
-  data.tar.gz: 15fe04c864306c9c17ffa1e1eb7ed58d9974ca33905e2b6ed337647ee05b7d21
+  metadata.gz: af5e7c84d5044bb2a7d6e95b4de88a076e9624c96011d0eb41dae6f2de20fec6
+  data.tar.gz: 6270af5147ea7981766721a24b70e6cb5adcf82c82c82ba91c5dbe8f0409de43
 SHA512:
-  metadata.gz: fca111db62f0ea2f501a08251f3f11829564db8ba842f512b4b11fa8d95b153d2db260f611690b453d7f660d9be07ca59eb0467a69bc041d0c2b1446ca22ba7b
-  data.tar.gz: 2cbab8660a43d57094f10cac7c3c39c992cf96e404108b7429b10cbaca918159b0c077d3480a907c36dc9292bd145863882d575e692e3fa50f37edc698b5fee5
+  metadata.gz: 7b66215eae031a7c9f9cf95498b57998d0942da9a96920684d34227230ab250868e5a3d75cb5bbbf15a90ce8b43dcf0e8a9dd532b4fb41edf486eecdd2df411f
+  data.tar.gz: 477c78f1eacc84844b52bf1e2626597d3304a97ed47f4a7641a0be9fff7ddd6f00789aa0953c54cc9dc802419919997206531dffa0ef42f615ea49001a3fb40b

data/config/default.yml

@@ -26,8 +26,10 @@ RBS:
 
 RBS/Layout:
   Enabled: true
-  DocumentationBaseURL: 'https://github.com/ksss/rubocop-on-rbs/blob/main/docs/modules/ROOT/pages'
-  DocumentationExtension: '.adoc'
+
+RBS/Layout/AnnotationIndentation:
+  Description: 'Use 2 spaces for annotation indentation'
+  Enabled: true
 
 RBS/Layout/CommentIndentation:
   Description: 'Use 2 spaces for comment indentation'
@@ -113,8 +115,6 @@ RBS/Layout/TrailingWhitespace:
 RBS/Lint:
   Severity: warning
   Enabled: true
-  DocumentationBaseURL: 'https://github.com/ksss/rubocop-on-rbs/blob/main/docs/modules/ROOT/pages'
-  DocumentationExtension: '.adoc'
 
 RBS/Lint/AmbiguousKeywordArgumentKey:
   Description: 'Check ambiguous keyword argument key'
@@ -124,10 +124,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
@@ -176,8 +184,6 @@ RBS/Lint/WillSyntaxError:
 
 RBS/Style:
   Enabled: true
-  DocumentationBaseURL: 'https://github.com/ksss/rubocop-on-rbs/blob/main/docs/modules/ROOT/pages'
-  DocumentationExtension: '.adoc'
 
 RBS/Style/BlockReturnBoolish:
   Description: 'Use `bool` for block return type'

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # Checks the indentation of annotations in RBS.
+        #
+        # @example
+        #   # bad
+        #   # comment
+        #     %a{pure}
+        #   def foo: () -> void
+        #
+        #   # good
+        #   # comment
+        #   %a{pure}
+        #   def foo: () -> void
+        #
+        class AnnotationIndentation < RuboCop::RBS::CopBase
+          extend AutoCorrector
+
+          MSG = "Incorrect indentation detected (column %<expect>s instead of %<actual>s)."
+
+          def on_rbs_new_investigation
+            indent_start_lines = Set.new
+            indent_end_lines = Set.new
+            ignore_poses = Set.new
+            processed_rbs_source.decls.each do |decl|
+              walk_decl(decl) do |d|
+                indent_start_lines << d.location.start_line
+                indent_end_lines << d.location.end_line
+                d.members.each do |member|
+                  case member
+                  when ::RBS::AST::Members::MethodDefinition
+                    member.overloads.each do |overload|
+                      overload.annotations.each do |annotation|
+                        ignore_poses << annotation.location.start_pos
+                      end
+                    end
+                  end
+                end
+              end
+            end
+
+            expected_width = 0
+            last_annotation_line = -1
+            processed_rbs_source.tokens.each do |token|
+              case token.type
+              when :kMODULE, :kCLASS, :kINTERFACE
+                next unless indent_start_lines.include?(token.location.start_line)
+
+                expected_width += 2
+              when :kEND
+                next unless indent_end_lines.include?(token.location.start_line)
+
+                expected_width -= 2
+              when :tANNOTATION
+                next if ignore_poses.include?(token.location.start_pos)
+
+                if token.location.start_column == expected_width
+                  last_annotation_line = token.location.start_line
+                  next
+                end
+                next if last_annotation_line == token.location.start_line
+
+                token_range = location_to_range(token.location)
+                message = format(MSG, expect: expected_width, actual: token.location.start_column)
+                last_annotation_line = token.location.start_line
+                add_offense(token_range, message: message) do |corrector|
+                  line_start_pos = processed_source.buffer.line_range(token.location.start_line).begin_pos
+                  indent = range_between(line_start_pos, token.location.start_pos)
+                  corrector.replace(indent, ' ' * expected_width)
+                end
+              end
+            end
+          end
+
+          def walk_decl(decl, &block)
+            if decl.respond_to?(:members)
+              yield decl
+              decl.members.each { |member| walk_decl(member, &block) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,45 +21,47 @@ module RuboCop
           MSG = "Incorrect indentation detected (column %<expect>s instead of %<actual>s)."
 
           def on_rbs_new_investigation
-            indent_start_lines = Set.new
-            indent_end_lines = Set.new
-            processed_rbs_source.decls.each do |decl|
-              walk_decl(decl) do |d|
-                indent_start_lines << d.location.start_line
-                indent_end_lines << d.location.end_line
-              end
+            comments = processed_rbs_source.tokens.select { |token| token.type == :tLINECOMMENT }
+            comments.each_with_index do |token, comment_index|
+              check(token, comment_index)
             end
+          end
 
-            expected_width = 0
-            processed_rbs_source.tokens.each do |token|
-              case token.type
-              when :kMODULE, :kCLASS, :kINTERFACE
-                next unless indent_start_lines.include?(token.location.start_line)
+          def check(comment_token, _comment_index)
+            next_line = line_after_comment(comment_token)
+            correct_comment_indentation = correct_indentation(next_line)
+            column = comment_token.location.start_column
 
-                expected_width += 2
-              when :kEND
-                next unless indent_end_lines.include?(token.location.start_line)
+            column_delta = correct_comment_indentation - column
+            return if column_delta.zero?
 
-                expected_width -= 2
-              when :tLINECOMMENT
-                if token.location.start_column != expected_width
-                  token_range = location_to_range(token.location)
-                  message = format(MSG, expect: expected_width, actual: token.location.start_column)
-                  add_offense(token_range, message: message) do |corrector|
-                    line_start_pos = processed_source.buffer.line_range(token.location.start_line).begin_pos
-                    indent = range_between(line_start_pos, token.location.start_pos)
-                    corrector.replace(indent, ' ' * expected_width)
-                  end
-                end
-              end
+            token_range = location_to_range(comment_token.location)
+            message = format(MSG, expect: correct_comment_indentation, actual: column)
+            add_offense(token_range, message: message) do |corrector|
+              line_start_pos = processed_source.buffer.line_range(comment_token.location.start_line).begin_pos
+              indent = range_between(line_start_pos, comment_token.location.start_pos)
+              corrector.replace(indent, ' ' * correct_comment_indentation)
             end
           end
 
-          def walk_decl(decl, &block)
-            if decl.respond_to?(:members)
-              yield decl
-              decl.members.each { |member| walk_decl(member, &block) }
-            end
+          def line_after_comment(comment)
+            lines = processed_source.lines
+            lines[comment.location.start_line..].find { |line| !line.blank? }
+          end
+
+          def correct_indentation(next_line)
+            return 0 unless next_line
+
+            indentation_of_next_line = next_line =~ /\S/
+            indentation_of_next_line + if less_indented?(next_line)
+                                         2
+                                       else
+                                         0
+                                       end
+          end
+
+          def less_indented?(line)
+            /\A\s*end\b/.match?(line)
           end
         end
       end

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

@@ -68,7 +68,7 @@ module RuboCop
           end
 
           def previous_line_ignoring_comments(processed_source, send_line)
-            processed_source[0..send_line - 2].reverse.find { |line| !comment_line?(line) }
+            processed_source[0..(send_line - 2)].reverse.find { |line| !comment_line?(line) }
           end
 
           def previous_line_empty?(send_line)

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

@@ -14,8 +14,15 @@ module RuboCop
         class SpaceAroundOperators < RuboCop::RBS::CopBase
           extend AutoCorrector
 
+          def on_rbs_class(decl)
+            check_type_params(decl)
+          end
+          alias on_rbs_module on_rbs_class
+          alias on_rbs_interface on_rbs_class
+
           def on_rbs_def(decl)
             decl.overloads.each do |overload|
+              check_type_params(overload.method_type)
               overload.method_type.each_type do |type|
                 check_type(type)
               end
@@ -26,10 +33,14 @@ module RuboCop
             check_type(decl.type)
           end
           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 on_rbs_type_alias(decl)
+            check_type_params(decl)
+            check_type(decl.type)
+          end
+
           def check_type(type)
             case type
             when ::RBS::Types::Union
@@ -42,6 +53,13 @@ module RuboCop
             end
           end
 
+          def check_type_params(decl)
+            decl.type_params.each do |type_param|
+              check_type(type_param.default_type) if type_param.default_type
+              check_type(type_param.upper_bound_type) if type_param.upper_bound_type
+            end
+          end
+
           def check_operator(type, operator)
             type.types.each_cons(2) do |before, after|
               next unless before.location.end_line == after.location.start_line

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/style/block_return_boolish.rb

@@ -13,6 +13,7 @@ module RuboCop
         #
         class BlockReturnBoolish < RuboCop::RBS::CopBase
           extend AutoCorrector
+
           MSG = 'Use `boolish` instead of `bool` in block return type.'
 
           # @sig decl: ::RBS::AST::Members::MethodDefinition

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

@@ -16,6 +16,7 @@ module RuboCop
         #
         class ClassWithSingleton < RuboCop::RBS::CopBase
           extend AutoCorrector
+
           MSG = 'Use `self` instead of `class`.'
 
           # @rbs decl: RBS::AST::Members::MethodDefinition

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

@@ -22,6 +22,7 @@ module RuboCop
         #
         class InitializeReturnType < RuboCop::RBS::CopBase
           extend AutoCorrector
+
           MSG = '`#initialize` method should return `void`'
 
           def on_rbs_def(decl)

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

@@ -16,6 +16,7 @@ module RuboCop
         #
         class InstanceWithInstance < RuboCop::RBS::CopBase
           extend AutoCorrector
+
           MSG = 'Use `self` instead of `instance`.'
 
           # @rbs decl: RBS::AST::Declarations::Class

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

@@ -49,6 +49,7 @@ module RuboCop
           class ParenChecker
             include BeforeTokenIfLparen
             include RangeHelp
+
             attr_reader :processed_source
 
             def initialize(processed_source:, base:, tokens:, type:, skip:, cop:)

data/lib/rubocop/cop/rbs_cops.rb

@@ -2,6 +2,7 @@
 
 require 'rbs'
 
+require_relative 'rbs/layout/annotation_indentation'
 require_relative 'rbs/layout/comment_indentation'
 require_relative 'rbs/layout/empty_line_between_declarations'
 require_relative 'rbs/layout/empty_lines_around_access_modifier'
@@ -25,7 +26,9 @@ 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'

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.7.0'
+    VERSION = '1.9.0'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.0
 platform: ruby
 authors:
 - ksss
 bindir: exe
 cert_chain: []
-date: 2025-05-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lint_roller
@@ -84,6 +84,7 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-on-rbs.rb
+- lib/rubocop/cop/rbs/layout/annotation_indentation.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
@@ -106,7 +107,9 @@ 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
@@ -157,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 4.0.3
 specification_version: 4
 summary: RuboCop extension for RBS file.
 test_files: []