rubocop-on-rbs 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1758c7e798195a042bd2b9266255dda2699470450e839f6ba330da6ff6470919
-  data.tar.gz: 15fe04c864306c9c17ffa1e1eb7ed58d9974ca33905e2b6ed337647ee05b7d21
+  metadata.gz: 0f48492da2f7f96f52584db83f1ead670446908414b91ebf0a27a7d6ccb82c1e
+  data.tar.gz: c5374fcc49b860034ef0852e3a4d2a86c99867e96581033884116b707844c597
 SHA512:
-  metadata.gz: fca111db62f0ea2f501a08251f3f11829564db8ba842f512b4b11fa8d95b153d2db260f611690b453d7f660d9be07ca59eb0467a69bc041d0c2b1446ca22ba7b
-  data.tar.gz: 2cbab8660a43d57094f10cac7c3c39c992cf96e404108b7429b10cbaca918159b0c077d3480a907c36dc9292bd145863882d575e692e3fa50f37edc698b5fee5
+  metadata.gz: fceeab927591e1507529a6b55d1b30f8b8bd7b5d700846777109a0e2b84c61380b5bee05d721d5eb5a08ffee4c184875d7956327c7feea6d469742c66f5affc7
+  data.tar.gz: 618f0de58a7bf00f68f0df67cca9d82da6723715af26eb1740211ab16bf53be66604782ec251fcbfdb313c933f30eb535e19f932b1d029fc462c8782189599a0

data/config/default.yml

@@ -26,8 +26,6 @@ RBS:
 
 RBS/Layout:
   Enabled: true
-  DocumentationBaseURL: 'https://github.com/ksss/rubocop-on-rbs/blob/main/docs/modules/ROOT/pages'
-  DocumentationExtension: '.adoc'
 
 RBS/Layout/CommentIndentation:
   Description: 'Use 2 spaces for comment indentation'
@@ -113,8 +111,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 +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
@@ -176,8 +180,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/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_cops.rb

@@ -25,7 +25,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.8.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.8.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
@@ -106,7 +106,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 +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: []