rubocop-on-rbs 2.0.0.dev → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb12bf04d27c5b1e90a4537e696d0f43e3440653244e71ab14bd189ef876ad1d
-  data.tar.gz: 265c57dc1917d19594e7175696147db9668a48b57c1b463472488e8bae4eade6
+  metadata.gz: 52b6d2d8d5f69d9af653de61ac795ed71d7ce63663c65450dd842e4c1816c69f
+  data.tar.gz: e81e32efe74897317c3eb4183cfb11e6e65b0bcaa04345261787dfc29eb92741
 SHA512:
-  metadata.gz: 808e37b431fcbad539a5fc99910816f15d00ccde4f35c9e3139e76c22b458680ab9a3e5130436d7fe4d83d9967cea0c777f07b542b72cc669b6011a9a20e29a6
-  data.tar.gz: 9951c42a0f33cdca49d1c580ceecbb0d774b3534794e55ed08e69e274a657f8262f218ed759de4ef93c99ffd1aba79da238225f32f96edc2a4e990e5caaa5a46
+  metadata.gz: 6f7a1fdceb0841f976a3cfe4147e9f17e43e13447702314e03747bbd0565f945615f23e952d7ffd08ba7dd00c46f34b2d5bfcd7d8692d94eaf901d528c776cd1
+  data.tar.gz: f0949c448ec168f168b4d4c2b723670bac8e2dade272e8b569533314c366e26b89b805860f455f49f5a3d1f06294a7ad0334baa8c878ab043459b2cbf22c115f

data/CHANGELOG.md

@@ -1,6 +1,54 @@
 ## [Unreleased]
 
+## [2.0.0] - 2026-03-27
+
+* Support rbs v4 by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/145
+* Drop `RBS/Lint/WillSyntaxError` by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/145
+
+## [1.9.1] - 2026-02-10
+
+* [RBS/Layout/OverloadIndentation] Fix false positive by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/141
+* [RBS/Layout/EmptyLinesAroundOverloads] Fix false positive by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/142
+* [RBS/Layout/SpaceBeforeOverload] Support `...` by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/143
+
+## [1.9.0] - 2026-01-14
+
+* Add cop `RBS/Layout/AnnotationIndentation` by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/124
+* Fix bug when multi annotation by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/125
+* [RBS/Layout/SpaceAroundOperators] Support type params by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/126
+* Support new Cops by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/129
+* [RBS/Layout/CommentIndentation] Fix false positive by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/136
+* Use ruby v4 by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/137
+
+## [1.8.0] - 2025-06-26
+
+* Add task for update dependencies by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/110
+* Should melt down Gemfile.lock by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/111
+* Dynamically generate document URLs by version by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/114
+* Add new cop `RBS/Lint/ImplicitlyReturnsNil` by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/115
+* [RBS/Lint/DuplicateOverload] Ignore the difference of return type. by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/116
+* Add `RBS/Lint/DuplicateAnnotation` by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/117
+* Fix message by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/118
+
+## [1.7.0] - 2025-05-18
+
+* Add `RBS/Lint/RestKeywordHash` by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/102
+* Support documentation URL for department by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/103
+* Refine documentation by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/104
+* Add RBS/Layout/EmptyLineBetweenDeclarations by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/105
+* [RBS/Layout/EmptyLineBetweenDeclarations] Short fix by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/106
+
+## [1.6.0] - 2025-04-25
+
+* [RBS::Style::TrueFalse] More support decls by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/97
+* [RBS/Style/OptionalNil] More support decls by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/98
+* [RBS/Style/DuplicatedType] More support decls by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/100
+
+## [1.5.0] - 2025-03-23
+
 * Pluginfy RuboCop on RBS by @ydah in https://github.com/ksss/rubocop-on-rbs/pull/88
+* Drop support for ruby v3.1 by @ksss in https://github.com/ksss/rubocop-on-rbs/pull/90
+* Fix RuboCop RakeTask plugin assignment in README by @ydah in https://github.com/ksss/rubocop-on-rbs/pull/92
 
 ## [1.4.2] - 2025-02-23
 

data/README.md

@@ -24,11 +24,8 @@ def foo: (   void) -> untyped
 sig/foo.rbs:2:11: C: [Correctable] RBS/Layout/ExtraSpacing: Unnecessary spacing detected.
 def foo: (   void) -> untyped
           ^^
-sig/foo.rbs:2:14: W: RBS/Lint/WillSyntaxError: void type is only allowed in return type or generics parameter
-def foo: (   void) -> untyped
-             ^^^^
 
-1 file inspected, 3 offenses detected, 2 offenses autocorrectable
+1 file inspected, 2 offenses detected, 2 offenses autocorrectable
 ```
 
 ## Support VSCode

data/config/default.yml

@@ -27,6 +27,10 @@ RBS:
 RBS/Layout:
   Enabled: true
 
+RBS/Layout/AnnotationIndentation:
+  Description: 'Use 2 spaces for annotation indentation'
+  Enabled: true
+
 RBS/Layout/CommentIndentation:
   Description: 'Use 2 spaces for comment indentation'
   Enabled: true
@@ -172,10 +176,6 @@ RBS/Lint/UnusedTypeAliasTypeParams:
   Description: 'Check redundant type alias type params'
   Enabled: true
 
-RBS/Lint/WillSyntaxError:
-  Description: 'Check RBS will syntax error'
-  Enabled: true
-
 ## RBS/Style
 
 RBS/Style:

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/empty_lines_around_overloads.rb

@@ -21,19 +21,35 @@ module RuboCop
 
           MSG = 'Empty line detected around overloads.'
 
+          # @rbs decl: ::RBS::AST::Members::MethodDefinition
+          # @rbs return: void
           def on_rbs_def(decl)
-            return unless 1 < decl.overloads.length
-
             decl.overloads.each_cons(2) do |overload, next_overload|
-              check_empty_lines(overload, next_overload)
+              end_line = overload&.method_type&.location&.end_line || 0
+              next_start_line = next_overload&.method_type&.location&.start_line || 0
+              check_empty_lines(end_line, next_start_line)
+            end
+
+            if decl.overloading? && decl.overloads.length.positive?
+              # : () -> void
+              #
+              #   | ...
+              end_location = decl.overloads.last.method_type.location or return
+              slice = processed_source.raw_source[end_location.end_pos..] or return
+              bar_index = slice.index('|') or return
+              bar_line = slice[0..bar_index]&.count("\n") or return
+              check_empty_lines(end_location.end_line, end_location.end_line + bar_line)
             end
           end
 
-          def check_empty_lines(overload, next_overload)
-            return if overload.method_type.location.end_line + 1 == next_overload.method_type.location.start_line
+          # @rbs end_line: Integer
+          # @rbs next_start_line: Integer
+          # @rbs return: void
+          def check_empty_lines(end_line, next_start_line)
+            return if end_line + 1 == next_start_line
 
             total = 0
-            range = overload.method_type.location.end_line...(next_overload.method_type.location.start_line - 1)
+            range = end_line...(next_start_line - 1)
             processed_source.raw_source.each_line.each_with_index do |line, lineno|
               if range.cover?(lineno) && line == "\n"
                 empty_line = range_between(total, total + 1)

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

@@ -39,8 +39,11 @@ module RuboCop
 
               loc = bar&.location
               next unless loc
-              next unless overload_starts.include?(base_pos + after.location.start_pos)
 
+              # pDOT3 is not included in decl.overloads
+              next unless overload_starts.include?(base_pos + after.location.start_pos) || after.type == :pDOT3
+
+              # () -> void | (Integer) -> void
               if before.location.end_line == bar.location.start_line
                 range = range_between(base_pos + bar.location.start_pos, base_pos + bar.location.end_pos)
                 add_offense(range, message: "Insert newline before `|`") do |corrector|
@@ -49,12 +52,17 @@ module RuboCop
                 end
               end
 
+              # () -> void
+              # |
+              # (Integer) -> void
               if bar.location.end_line != after.location.start_line
                 range = range_between(base_pos + bar.location.start_pos, base_pos + bar.location.end_pos)
                 add_offense(range, message: "Remove newline after `|`") do |corrector|
                   space = range_between(base_pos + bar.location.end_pos, base_pos + after.location.start_pos)
                   corrector.replace(space, ' ')
                 end
+              # : () -> void
+              #   | (Integer) -> void
               elsif bar.location.start_column != first_colon_column
                 range = range_between(base_pos + bar.location.start_pos, base_pos + bar.location.end_pos)
                 add_offense(range, message: 'Indent the `|` to the first `:`') do |corrector|

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/layout/space_before_overload.rb

@@ -17,25 +17,39 @@ module RuboCop
 
           MSG = 'Use one space before overload.'
 
-          # @sig decl: ::RBS::AST::Members::MethodDefinition
+          # @rbs decl: ::RBS::AST::Members::MethodDefinition
           def on_rbs_def(decl)
-            source = processed_source.raw_source
             decl.overloads.each_with_index do |overload, i|
-              loc = overload.method_type.location
+              loc = overload.method_type.location or next
               overload_char = i == 0 ? ':' : '|'
+              check(loc, overload_char)
+            end
+
+            if decl.overloading?
+              loc = decl.location or return
+              overloading_loc = loc[:overloading] or return
+              overload_char = decl.overloads.length == 0 ? ':' : '|'
+              check(overloading_loc, overload_char)
+            end
+          end
+
+          private
+
+          # @rbs loc: ::RBS::Location[bot, bot]
+          def check(loc, overload_char)
+            source = processed_source.raw_source
 
-              char_start_pos = source.rindex(overload_char, loc.start_pos)
-              next unless char_start_pos
+            char_start_pos = source.rindex(overload_char, loc.start_pos)
+            return unless char_start_pos
 
-              word_after_char_pos = source.index(/[^\s]/, char_start_pos + 1)
-              next unless word_after_char_pos
+            word_after_char_pos = source.index(/[^\s]/, char_start_pos + 1)
+            return unless word_after_char_pos
 
-              if char_start_pos + 2 != word_after_char_pos
-                char = range_between(char_start_pos, char_start_pos + 1)
-                add_offense(char) do |corrector|
-                  range = range_between(char_start_pos + 1, word_after_char_pos)
-                  corrector.replace(range, ' ')
-                end
+            if char_start_pos + 2 != word_after_char_pos
+              char = range_between(char_start_pos, char_start_pos + 1)
+              add_offense(char) do |corrector|
+                range = range_between(char_start_pos + 1, word_after_char_pos)
+                corrector.replace(range, ' ')
               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'
@@ -37,7 +38,6 @@ require_relative 'rbs/lint/top_level_type_alias'
 require_relative 'rbs/lint/unused_overload_type_params'
 require_relative 'rbs/lint/unused_type_alias_type_params'
 require_relative 'rbs/lint/useless_access_modifier'
-require_relative 'rbs/lint/will_syntax_error'
 
 require_relative 'rbs/style/block_return_boolish'
 require_relative 'rbs/style/class_with_singleton'

data/lib/rubocop/rbs/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module RBS
-    VERSION = '2.0.0.dev'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-on-rbs
 version: !ruby/object:Gem::Version
-  version: 2.0.0.dev
+  version: 2.0.0
 platform: ruby
 authors:
 - ksss
@@ -27,16 +27,16 @@ dependencies:
   name: rbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -118,7 +119,6 @@ files:
 - lib/rubocop/cop/rbs/lint/unused_overload_type_params.rb
 - lib/rubocop/cop/rbs/lint/unused_type_alias_type_params.rb
 - lib/rubocop/cop/rbs/lint/useless_access_modifier.rb
-- lib/rubocop/cop/rbs/lint/will_syntax_error.rb
 - lib/rubocop/cop/rbs/style/block_return_boolish.rb
 - lib/rubocop/cop/rbs/style/class_with_singleton.rb
 - lib/rubocop/cop/rbs/style/classic_type.rb
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: RuboCop extension for RBS file.
 test_files: []

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

@@ -1,228 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RBS
-      module Lint
-        # This cop checks the WillSyntaxError in RBS.
-        # RBS with this diagnostics will fail in `rbs validate` command.
-        #
-        # @example
-        #   # bad
-        #   def foo: (void) -> void
-        #
-        #   # bad
-        #   CONST: self
-        #
-        class WillSyntaxError < RuboCop::RBS::CopBase
-          # @rbs!
-          #    module Types = ::RBS::Types
-          #    module AST = ::RBS::AST
-
-          # @rbs skip
-          AST = ::RBS::AST
-          # @rbs skip
-          Types = ::RBS::Types
-
-          def on_rbs_class(decl)
-            if super_class = decl.super_class
-              super_class.args.each do |arg|
-                void_type_context_validator(arg, true)
-                no_self_type_validator(arg)
-                no_classish_type_validator(arg)
-              end
-            end
-            check_module_or_class(decl)
-          end
-
-          def on_rbs_module(decl)
-            decl.self_types.each do |self_type|
-              self_type.args.each do |arg|
-                void_type_context_validator(arg, true)
-                no_self_type_validator(arg)
-                no_classish_type_validator(arg)
-              end
-            end
-            check_module_or_class(decl)
-          end
-
-          def check_type_params(decl)
-            decl.type_params.each do |param|
-              if ub = param.upper_bound
-                void_type_context_validator(ub)
-                no_self_type_validator(ub)
-                no_classish_type_validator(ub)
-              end
-
-              if param.respond_to?(:default_type)
-                if dt = param.default_type
-                  void_type_context_validator(dt, true)
-                  no_self_type_validator(dt)
-                  no_classish_type_validator(dt)
-                end
-              end
-            end
-          end
-
-          def check_module_or_class(decl)
-            check_type_params(decl)
-
-            decl.each_member do |member|
-              case member
-              when AST::Members::MethodDefinition
-                member.overloads.each do |ov|
-                  void_type_context_validator(ov.method_type)
-                end
-              when AST::Members::Attribute
-                void_type_context_validator(member.type)
-              when AST::Members::Mixin
-                member.args.each do |arg|
-                  no_self_type_validator(arg)
-                  unless arg.is_a?(Types::Bases::Void)
-                    void_type_context_validator(arg, true)
-                  end
-                end
-              when AST::Members::Var
-                void_type_context_validator(member.type)
-                if member.is_a?(AST::Members::ClassVariable)
-                  no_self_type_validator(member.type)
-                end
-              end
-            end
-          end
-
-          def on_rbs_interface(decl)
-            check_type_params(decl)
-
-            decl.members.each do |member|
-              case member
-              when AST::Members::MethodDefinition
-                member.overloads.each do |ov|
-                  void_type_context_validator(ov.method_type)
-                  no_classish_type_validator(ov.method_type)
-                end
-              end
-            end
-          end
-
-          def on_rbs_constant(decl)
-            no_self_type_validator(decl.type)
-            no_classish_type_validator(decl.type)
-            void_type_context_validator(decl.type)
-          end
-          alias on_rbs_global on_rbs_constant
-
-          def on_rbs_type_alias(decl)
-            no_self_type_validator(decl.type)
-            no_classish_type_validator(decl.type)
-            void_type_context_validator(decl.type)
-
-            check_type_params(decl)
-          end
-
-          private
-
-          # @rbs type: ::RBS::Types::t
-          def no_self_type_validator(type)
-            case type
-            when ::RBS::MethodType,
-                 Types::Record,
-                 Types::Tuple,
-                 Types::Union,
-                 Types::Intersection,
-                 Types::Optional,
-                 Types::ClassInstance,
-                 Types::Proc
-              type.each_type do |t|
-                no_self_type_validator(t)
-              end
-            else
-              if type.has_self_type?
-                offence(type, "`self` type is not allowed in this context")
-              end
-            end
-          end
-
-          # @rbs type: ::RBS::MethodType | ::RBS::Types::t
-          def no_classish_type_validator(type)
-            case type
-            when ::RBS::MethodType,
-                 Types::Record,
-                 Types::Tuple,
-                 Types::Union,
-                 Types::Intersection,
-                 Types::Optional,
-                 Types::ClassInstance,
-                 Types::Proc
-              type.each_type do |t|
-                no_classish_type_validator(t)
-              end
-            when Types::Bases::Instance
-              offence(type, "`instance` type is not allowed in this context")
-            when Types::Bases::Class
-              offence(type, "`class` type is not allowed in this context")
-            else
-              if type.has_classish_type?
-                offence(type, "`instance` or `class` type is not allowed in this context")
-              end
-            end
-          end
-
-          # @rbs type: ::RBS::MethodType | ::RBS::Types::Function | ::RBS::Types::t
-          # @rbs allowed_here: bool
-          def void_type_context_validator(type, allowed_here = false)
-            return if type.is_a?(Types::UntypedFunction)
-
-            case type
-            when ::RBS::MethodType
-              void_type_context_validator(type.type)
-            when Types::Function
-              type.each_param do |param|
-                void_type_context_validator(param.type)
-              end
-              case type.return_type
-              when Types::Bases::Void
-                # `() -> void` is allowed
-              else
-                void_type_context_validator(type.return_type, true)
-              end
-            when Types::Proc
-              void_type_context_validator(type.type)
-              void_type_context_validator(type.self_type) if type.self_type
-              if type.block
-                void_type_context_validator(type.block.type)
-                void_type_context_validator(type.block.self_type) if type.block.self_type
-              end
-            when Types::ClassInstance
-              type.args.each do |arg|
-                next if arg.is_a?(Types::Bases::Void)
-
-                void_type_context_validator(arg)
-              end
-            when Types::Record,
-                 Types::Tuple,
-                 Types::Union,
-                 Types::Intersection,
-                 Types::Optional
-              type.each_type do |t|
-                void_type_context_validator(t)
-              end
-            else
-              if allowed_here
-                return if type.is_a?(Types::Bases::Void)
-              end
-              if type.with_nonreturn_void?
-                offence(type, "`void` type is only allowed in return type or generics parameter")
-              end
-            end
-          end
-
-          def offence(decl, message)
-            range = location_to_range(decl.location)
-            add_offense(range, message: message)
-          end
-        end
-      end
-    end
-  end
-end