rubocop-on-rbs 0.2.0

data/lib/rubocop/cop/rbs_cops.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rbs'
+
+require_relative 'rbs/layout/comment_indentation'
+require_relative 'rbs/layout/empty_lines_around_overloads'
+require_relative 'rbs/layout/end_alignment'
+require_relative 'rbs/layout/extra_spacing'
+require_relative 'rbs/layout/indentation_width'
+require_relative 'rbs/layout/overload_indentation'
+require_relative 'rbs/layout/space_around_arrow'
+require_relative 'rbs/layout/space_around_braces'
+require_relative 'rbs/layout/space_before_colon'
+require_relative 'rbs/layout/space_before_overload'
+require_relative 'rbs/layout/trailing_whitespace'
+
+require_relative 'rbs/lint/syntax'
+require_relative 'rbs/lint/type_params_arity'
+require_relative 'rbs/lint/useless_overload_type_params'
+require_relative 'rbs/lint/will_syntax_error'
+
+require_relative 'rbs/style/block_return_boolish'
+require_relative 'rbs/style/true_false'
+require_relative 'rbs/style/classic_type'
+require_relative 'rbs/style/optional_nil'
+require_relative 'rbs/style/duplicated_type'
+require_relative 'rbs/style/initialize_return_type'
+require_relative 'rbs/style/merge_untyped'

data/lib/rubocop/rbs/cop_base.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RBS
+    # Base class for cops that operate on RBS signatures.
+    class CopBase < RuboCop::Cop::Base
+      include RuboCop::Cop::RangeHelp
+
+      attr_reader :processed_rbs_source
+
+      exclude_from_registry
+
+      def on_new_investigation
+        # Called here when valid as Ruby
+        investigation_rbs()
+      end
+
+      def on_other_file
+        investigation_rbs()
+      end
+
+      def investigation_rbs
+        return unless processed_source.buffer.name.then { |n| n.end_with?(".rbs") || n == "(string)" }
+
+        buffer = rbs_buffer()
+        @processed_rbs_source = RuboCop::RBS::ProcessedRBSSource.new(buffer)
+
+        if processed_rbs_source.error
+          on_rbs_parsing_error()
+        else
+          # HACK: Autocorrector needs to clear diagnostics
+          processed_source.diagnostics.clear
+
+          on_rbs_new_investigation()
+
+          processed_rbs_source.decls.each do |decl|
+            walk(decl)
+          end
+        end
+      end
+
+      def on_rbs_new_investigation; end
+      def on_rbs_parsing_error; end
+
+      # other on_* methods should sync with `#walk` method
+      def on_rbs_class(member); end
+      def on_rbs_module(member); end
+      def on_rbs_interface(member); end
+      def on_rbs_constant(const); end
+      def on_rbs_global(global); end
+      def on_rbs_type_alias(decl); end
+      def on_rbs_def(member); end
+      def on_rbs_attribute(member); end
+
+      def walk(decl)
+        case decl
+        when ::RBS::AST::Declarations::Module
+          on_rbs_module(decl)
+          decl.members.each { |member| walk(member) }
+        when ::RBS::AST::Declarations::Class
+          on_rbs_class(decl)
+          decl.members.each { |member| walk(member) }
+        when ::RBS::AST::Declarations::Interface
+          on_rbs_interface(decl)
+          decl.members.each { |member| walk(member) }
+        when ::RBS::AST::Declarations::Constant
+          on_rbs_constant(decl)
+        when ::RBS::AST::Declarations::Global
+          on_rbs_global(decl)
+        when ::RBS::AST::Declarations::TypeAlias
+          on_rbs_type_alias(decl)
+        when ::RBS::AST::Members::MethodDefinition
+          on_rbs_def(decl)
+        when ::RBS::AST::Members::Attribute
+          on_rbs_attribute(decl)
+        end
+      end
+
+      def rbs_buffer
+        ::RBS::Buffer.new(
+          name: processed_source.buffer.name,
+          content: processed_source.raw_source
+        )
+      end
+
+      def location_to_range(location)
+        range_between(location.start_pos, location.end_pos)
+      end
+    end
+  end
+end

data/lib/rubocop/rbs/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module RBS
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/rbs/processed_rbs_source.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RBS
+    class ProcessedRBSSource
+      attr_reader :raw_source
+      attr_reader :source
+      attr_reader :buffer
+      attr_reader :directives
+      attr_reader :decls
+      attr_reader :error
+
+      def initialize(source)
+        @raw_source = source.content
+        @buffer, @directives, @decls = ::RBS::Parser.parse_signature(source)
+        @error = nil
+        @tokens = nil
+      rescue ::RBS::ParsingError => e
+        @error = e
+      end
+
+      def tokens
+        @tokens ||= begin
+          ::RBS::Parser.lex(buffer).value
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rbs/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RBS
+    VERSION = '0.2.0'
+  end
+end

data/lib/rubocop/rbs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'rbs/version'
+
+module RuboCop
+  module RBS
+    class Error < StandardError; end
+
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-on-rbs.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/rbs'
+require_relative 'rubocop/rbs/version'
+require_relative 'rubocop/rbs/cop_base'
+require_relative 'rubocop/rbs/inject'
+require_relative 'rubocop/rbs/processed_rbs_source'
+
+RuboCop::RBS::Inject.defaults!
+
+require_relative 'rubocop/cop/rbs_cops'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-on-rbs
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- ksss
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+description: RuboCop extension for RBS file.
+email:
+- co000ri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- config/default.yml
+- lib/rubocop-on-rbs.rb
+- lib/rubocop/cop/rbs/layout/comment_indentation.rb
+- lib/rubocop/cop/rbs/layout/empty_lines_around_overloads.rb
+- lib/rubocop/cop/rbs/layout/end_alignment.rb
+- lib/rubocop/cop/rbs/layout/extra_spacing.rb
+- lib/rubocop/cop/rbs/layout/indentation_width.rb
+- lib/rubocop/cop/rbs/layout/overload_indentation.rb
+- lib/rubocop/cop/rbs/layout/space_around_arrow.rb
+- lib/rubocop/cop/rbs/layout/space_around_braces.rb
+- lib/rubocop/cop/rbs/layout/space_before_colon.rb
+- lib/rubocop/cop/rbs/layout/space_before_overload.rb
+- lib/rubocop/cop/rbs/layout/trailing_whitespace.rb
+- lib/rubocop/cop/rbs/lint/syntax.rb
+- lib/rubocop/cop/rbs/lint/type_params_arity.rb
+- lib/rubocop/cop/rbs/lint/useless_overload_type_params.rb
+- lib/rubocop/cop/rbs/lint/will_syntax_error.rb
+- lib/rubocop/cop/rbs/style/block_return_boolish.rb
+- lib/rubocop/cop/rbs/style/classic_type.rb
+- lib/rubocop/cop/rbs/style/duplicated_type.rb
+- lib/rubocop/cop/rbs/style/initialize_return_type.rb
+- lib/rubocop/cop/rbs/style/merge_untyped.rb
+- lib/rubocop/cop/rbs/style/optional_nil.rb
+- lib/rubocop/cop/rbs/style/true_false.rb
+- lib/rubocop/cop/rbs_cops.rb
+- lib/rubocop/rbs.rb
+- lib/rubocop/rbs/cop_base.rb
+- lib/rubocop/rbs/inject.rb
+- lib/rubocop/rbs/processed_rbs_source.rb
+- lib/rubocop/rbs/version.rb
+homepage: https://github.com/ksss/rubocop-on-rbs
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: RuboCop extension for RBS file.
+test_files: []